fabacino/debug-functions

v0.2.0 2020-05-20 11:49 UTC

This package is auto-updated.

Last update: 2024-09-25 23:54:23 UTC


README

CI codecov

这是一个简单调试函数集合,在完整的调试器不可用时可能非常有用。

要求

以下版本的PHP得到支持

  • PHP 7.2
  • PHP 7.3
  • PHP 7.4

安装

composer install --dev fabacino/debug-functions

使用方法

  • dbg:输出调试值。
  • dbgr:返回调试值。
  • dbglog:将调试值记录到文件。
  • dbginit:初始化调试设置。

这些函数接受任何调试值,只要它可以作为变量传递。

示例

将值打印到标准输出

dbg(123);
dbg('a string');
dbg([
    'token' => 'dp83kspo',
    'is_default' => true
]);
// Output
123
a string
Array
(
    [token] => dp83kspo
    [is_default] => true
)

在非CLI环境中运行时,输出会被包裹在pre标签中,以获得更好的格式。

如果您更喜欢var_dump,请使用dbginit或标志USE_VARDUMP

dbginit(['use_vardump' => true]);
dbg(123);
// or
dbg(123, Debug::USE_VARDUMP);
// which is the same as
dbg(123, 1);
// Output
int(123)
string(8) "a string"
array(2) {
  'token' => string(8) "dp83kspo"
  'is_default' => bool(true)
}

如果您想要编码HTML实体,请使用dbginit或标志USE_HTMLENTITIES

dbginit(['use_htmlentities' => true]);
dbg('<b>important</b>');
// or
dbg('<b>important</b>', Debug::USE_HTMLENTITIES);
// which is the same as
dbg('<b>important</b>', 2);
// Output
&lt;b&gt;important&lt;/b&gt;

将调试输出保存到变量

// dbgr is the same as dbg, except that the output is returned instead of printed.
$dbg = dbgr(123);

将调试输出记录到文件

// dbglog is the same as dbg, except that the output is logged instead of printed.
dbginit(['log_file' => '/path/to/logfile']);
dbglog($this->doSomething());

或者,您可以传递自己的PSR-3兼容的日志记录器

$logger = new YourLogger();
...
dbginit(['logger' => $logger]);
dbglog($this->doSomething());

许可证

MIT许可证(MIT)。请参阅许可证文件以获取更多信息。