如何将 var_dump 的结果捕获到字符串？

Question

我想将var_dump 的输出捕获到一个字符串中。

PHP 文档说；

与将结果直接输出到浏览器的任何东西一样，output-control functions 可用于捕获此函数的输出，并将其保存在字符串中（例如）。

有什么例子可以说明它是如何工作的？

print_r() 不是一个有效的可能性，因为它不会给我所需的信息。

Answer 1

使用输出缓冲：

<?php
ob_start();
var_dump($someVar);
$result = ob_get_clean();
?>

Answer 2

你也可以这样做：

$dump = print_r($variable, true);

Answer 3

试试var_export

您可能想查看 var_export — 虽然它没有提供与 var_dump 相同的输出，但它提供了第二个 $return 参数，这将导致它返回其输出而不是打印它：

$debug = var_export($my_var, true);

为什么？

比起使用ob_start 和ob_get_clean()，我更喜欢这种单行方式。我还发现输出更容易阅读，因为它只是 PHP 代码。

var_dump 和var_export 之间的区别在于var_export 返回一个“变量的可解析字符串表示”，而var_dump 只是转储有关变量的信息。这在实践中意味着var_export 为您提供了有效的PHP 代码（但可能不会为您提供关于变量的那么多信息，尤其是在您使用resources 时）。

演示：

$demo = array(
    "bool" => false,
    "int" => 1,
    "float" => 3.14,
    "string" => "hello world",
    "array" => array(),
    "object" => new stdClass(),
    "resource" => tmpfile(),
    "null" => null,
);

// var_export -- nice, one-liner
$debug_export = var_export($demo, true);

// var_dump
ob_start();
var_dump($demo);
$debug_dump = ob_get_clean();

// print_r -- included for completeness, though not recommended
$debug_printr = print_r($demo, true);

输出的区别：

var_export（上例中为$debug_export）：

 array (
  'bool' => false,
  'int' => 1,
  'float' => 3.1400000000000001,
  'string' => 'hello world',
  'array' => 
  array (
  ),
  'object' => 
  stdClass::__set_state(array(
  )),
  'resource' => NULL, // Note that this resource pointer is now NULL
  'null' => NULL,
)

var_dump（上例中为$debug_dump）：

 array(8) {
  ["bool"]=>
  bool(false)
  ["int"]=>
  int(1)
  ["float"]=>
  float(3.14)
  ["string"]=>
  string(11) "hello world"
  ["array"]=>
  array(0) {
  }
  ["object"]=>
  object(stdClass)#1 (0) {
  }
  ["resource"]=>
  resource(4) of type (stream)
  ["null"]=>
  NULL
}

print_r（上例中的$debug_printr）：

Array
(
    [bool] => 
    [int] => 1
    [float] => 3.14
    [string] => hello world
    [array] => Array
        (
        )

    [object] => stdClass Object
        (
        )

    [resource] => Resource id #4
    [null] => 
)

警告：var_export 不处理循环引用

如果您尝试使用循环引用转储变量，调用 var_export 将导致 PHP 警告：

 $circular = array();
 $circular['self'] =& $circular;
 var_export($circular);

结果：

 Warning: var_export does not handle circular references in example.php on line 3
 array (
   'self' => 
   array (
     'self' => NULL,
   ),
 )

另一方面，var_dump 和print_r 在遇到循环引用时都会输出字符串*RECURSION*。

Answer 4

您也可以尝试使用serialize() 函数。有时它对于调试目的非常有用。

Answer 5

如果您想在运行时查看变量的内容，请考虑使用真正的调试器，例如 XDebug。这样您就不需要弄乱源代码，即使普通用户访问您的应用程序，您也可以使用调试器。他们不会注意到的。

Answer 6

另外echo json_encode($dataobject); 可能会有所帮助

Answer 7

下面是作为函数的完整解决方案：

function varDumpToString ($var)
{
    ob_start();
    var_dump($var);
    return ob_get_clean();
}

Answer 8

如果您使用的是 PHP>=7.0.0

function return_var_dump(...$args): string
{
    ob_start();
    try {
        var_dump(...$args);
        return ob_get_clean();
    } catch (\Throwable $ex) {
        // PHP8 ArgumentCountError for 0 arguments, probably..
        // in php<8 this was just a warning
        ob_end_clean();
        throw $ex;
    }
}

或者如果您使用的是 PHP >=5.3.0：

function return_var_dump(){
    ob_start();
    call_user_func_array('var_dump', func_get_args());
    return ob_get_clean();
}

或者如果你使用的是 PHP

function return_var_dump(){
    $args = func_get_args(); // For <5.3.0 support ...
    ob_start();
    call_user_func_array('var_dump', $args);
    return ob_get_clean();
}

（在 5.3.0 之前，如果直接将 func_get_args 用作另一个函数调用的参数，则存在一个错误，因此您必须将其放入变量中并使用该变量，而不是直接将其用作参数.. )

Answer 9

From the PHP manual:

此函数显示有关一个或多个表达式的结构化信息，包括其类型和值。

所以，这里是 PHP 的 var_dump() 的 real 返回版本，它实际上接受一个可变长度的参数列表：

function var_dump_str()
{
    $argc = func_num_args();
    $argv = func_get_args();

    if ($argc > 0) {
        ob_start();
        call_user_func_array('var_dump', $argv);
        $result = ob_get_contents();
        ob_end_clean();
        return $result;
    }

    return '';
}

Answer 10

来自http://htmlexplorer.com/2015/01/assign-output-var_dump-print_r-php-variable.html：

var_dump 和 print_r 函数只能直接输出到浏览器。所以这些函数的输出只能通过php的输出控制函数来获取。下面的方法可能有助于保存输出。

function assignVarDumpValueToString($object) {
    ob_start();
    var_dump($object);
    $result = ob_get_clean();
    return $result;
}

ob_get_clean() 只能清除最后输入到内部缓冲区的数据。所以 如果您有多个条目，ob_get_contents 方法将很有用。

来自与上述相同的来源：

function varDumpToErrorLog( $var=null ){
    ob_start();                    // start reading the internal buffer
    var_dump( $var);          
    $grabbed_information = ob_get_contents(); // assigning the internal buffer contents to variable
    ob_end_clean();                // clearing the internal buffer.
    error_log( $grabbed_information);        // saving the information to error_log
}

Answer 11

这可能有点跑题了。

我正在寻找一种将此类信息写入我的 PHP-FPM 容器的 Docker 日志的方法，并想出了下面的 sn-p。我确信这可以被 Docker PHP-FPM 用户使用。

fwrite(fopen('php://stdout', 'w'), var_export($object, true));

Answer 12

我真的很喜欢var_dump() 的详细输出，但对var_export() 或print_r() 的输出不满意，因为它没有提供太多信息（例如缺少数据类型、缺少长度）。

为了编写安全且可预测的代码，有时区分空字符串和空字符串很有用。或介于 1 和真之间。或者介于 null 和 false 之间。所以我想要我的数据类型在输出中。

虽然有帮助，但我没有在现有响应中找到一个干净简单的解决方案，将var_dump() 的彩色输出转换为人类可读的输出，不带 html 标签并包含来自@987654325 的所有详细信息@。

注意，如果你有一个彩色的var_dump()，这意味着你安装了Xdebug，它会覆盖php的默认var_dump()来添加html颜色。

出于这个原因，我创建了这个细微的变化，给出了我所需要的：

function dbg_var_dump($var)
    {
        ob_start();
        var_dump($var);
        $result = ob_get_clean();
        return strip_tags(strtr($result, ['=>' => '=>']));
    }

返回以下漂亮的字符串：

array (size=6)
  'functioncall' => string 'add-time-property' (length=17)
  'listingid' => string '57' (length=2)
  'weekday' => string '0' (length=1)
  'starttime' => string '00:00' (length=5)
  'endtime' => string '00:00' (length=5)
  'price' => string '' (length=0)

希望它可以帮助某人。

Answer 13

长字符串：只需使用echo($var); 而不是dump($var);。

对象或数组：var_dump('<pre>'.json_encode($var).'</pre>);'