README

Serendipity HQ VarDumper F

为 [Symfony 的 VarDumper 组件](https://symfony.com.cn/doc/current/components/var_dumper.html) 添加了 `dumpf()` 和 `ddf()` 函数，可以将数据输出到文件。

支持：

测试环境：

当前状态

你喜欢这个库吗？
留下 ★ 吧

或者运行
composer global require symfony/thanks && composer thanks
来感谢你当前项目中使用的所有库，包括这个！

通过 Composer 安装 VarDumper CLI 到 HTML

$ composer require serendipity_hq/component-var-dumper-f --dev

此库遵循 http://semver.org/ 版本规范。

用法

库提供了两个函数： dumpf() 和 ddf()。

它们的工作方式与 Symfony 的 VarDumper 内置的 dump() 和 dd() 完全相同，但有以下特点

1. Both dumpf() 和 ddf() 只能在命令行运行的脚本中使用；
2. Both 函数的第一个参数必须是 null 或包含一些选项的数组。

最简单的用法如下

$var = [
    'a simple string' => "in an array of 5 elements",
    'a float' => 1.0,
    'an integer' => 1,
    'a boolean' => true,
    'an empty array' => [],
];
dumpf(null, $var);
ddf(null, $var);

结果将是一个随机命名的 HTML 文件，包含 $var 的输出。

打开该文件，您将看到

有关输出示例的更多信息，请参阅 Symfony 的 VarDumper 文档中的 输出示例和输出。

指定输出文件

您可以通过传递完整的路径名作为第一个参数来指定输出文件。

dumpf('~/path/to/your/folder/filename', $var);
ddf('~/path/to/your/folder/filename', $var);

您可以使用像 filename 或像 filename.html 这样的名称：结果文件将始终有一个 .html 扩展名（filename.html）。

传递选项

这两个函数都接受一个数组作为第一个参数。

传入的数组可以包含您可以向 Symfony 的 VarDumper Cloner 传递的任何选项（参考）。

您还可以传递一个额外的选项 file，通过它可以指定输出文件的名称

dumpf(['file' => 'dump_var', 'maxDepth' => 2], $var);
ddf(['file' => 'dump_var.html', 'maxDepth' => 5], $var);

在这两种情况下，都会生成文件 dump_var.html。

如果文件已经存在会怎样呢

新的输出将添加到已存在的文件中。

所以，如果您在 CLI 脚本中三次调用 dumpf()，那么最终的文件输出将包含三个输出。

如果再次运行脚本，最终的文件输出现在将包含六个输出：第一次运行的三项和第二次运行的三项。

要获得一个新的输出，只需删除输出文件。

你喜欢这个库吗？
留下 ★ 吧

或者运行
composer global require symfony/thanks && composer thanks
来感谢你当前项目中使用的所有库，包括这个！