serendipity_hq / vardumper-cli-to-html
向 Symfony 的 VarDumper 组件添加函数 dumpf() 和 ddf(),用于 CLI 脚本中向文件中转储。
Requires
- php: ^7.4|^8.0
- symfony/var-dumper: ^4.4|^5.4|^6.4|^7.0
- thecodingmachine/safe: ^1.3|^2.0
Requires (Dev)
- ext-ast: *
- bamarni/composer-bin-plugin: ^1.4
- phpstan/phpstan: 1.10.59
- phpstan/phpstan-phpunit: 1.3.16
- rector/rector: 1.0.1
- roave/security-advisories: dev-master
- serendipity_hq/rector-config: ^1.0
- thecodingmachine/phpstan-safe-rule: 1.2.0
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 to HTML
$ composer require serendipity_hq/component-var-dumper-f --dev
此库遵循 http://semver.org/ 版本控制约定。
用法
该库提供两个函数:dumpf()
和 ddf()
。
它们的工作方式与 Symfony 的 VarDumper 内置的 dump()
和 dd()
完全相同,具体如下
dumpf()
和ddf()
只能在命令行运行的脚本中使用;- 它们都需要第一个参数是
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);
结果将是一个包含 $var
转储的随机命名的 HTML 文件。
打开该文件,您将看到
有关输出示例的更多信息,请参阅 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
以感谢你在当前项目中使用的所有库,包括这个!