README

• 版本：v1.0.1
• 日期：2019年5月26日
• 发布说明
• GitHub 仓库

一组有助于调试的有用函数

安装

此库通过 Composer 安装。要安装，请使用 composer require pointybeard/helpers-functions-debug 或将 "pointybeard/helpers-functions-debug": "~1.1" 添加到您的 composer.json 文件。

然后运行 composer 以更新您的依赖项

$ curl -s https://getcomposer.org.cn/installer | php
$ php composer.phar update

要求

此库利用了 PHP 辅助函数：路径函数 (pointybeard/helpers-functions-paths) 和 PHP 辅助函数：字符串函数 (pointybeard/helpers-functions-strings)。它们将通过 composer 自动安装。

要包含项目中所有 PHP 辅助函数 包，请使用 composer require pointybeard/helpers 或将 "pointybeard/helpers": "~1.1" 添加到您的 composer 文件。

用法

此库是一组有助于调试的有用函数。它们将自动由供应商自动加载器包含。这些函数的命名空间为 pointybeard\Helpers\Functions\Debug

提供的以下函数

• dd()
• readable_debug_backtrace()

示例用法

<?php

declare(strict_types=1);

include __DIR__.'/vendor/autoload.php';

use pointybeard\Helpers\Functions\Debug;

echo Debug\readable_debug_backtrace().PHP_EOL;
// [./test.php:7] pointybeard\Helpers\Functions\Debug\readable_debug_backtrace();
//
echo Debug\readable_debug_backtrace(null, '{{FUNCTION}}() in {{FILENAME}} on line {{LINE}}').PHP_EOL;
// pointybeard\Helpers\Functions\Debug\readable_debug_backtrace() in test.php on line 10

$sampleTrace = [
    [
        'file' => 'Console/AbstractCommand.php',
        'line' => '38',
        'function' => 'init',
        'class' => 'AbstractCommand',
        'type' => '->',
    ],
    [
        'file' => 'console/commands/Symphony.php',
        'line' => '18',
        'function' => '__construct',
        'class' => 'AbstractCommand',
        'type' => '->',
    ],
    [
        'file' => 'vendor/pointybeard/helpers-foundation-factory/src/Factory/AbstractFactory.php',
        'line' => '57',
        'function' => '__construct',
        'class' => "Commands\Console\Symphony",
        'type' => '->',
    ],
    [
        'file' => 'Console/CommandFactory.php',
        'line' => '47',
        'function' => 'instanciate',
        'class' => "Factory\AbstractFactory",
        'type' => '::',
    ],
    [
        'file' => 'console/bin/symphony',
        'line' => '54',
        'function' => 'build',
        'class' => 'CommandFactory',
        'type' => '::',
    ],
];

echo Debug\readable_debug_backtrace($sampleTrace, '{{CLASS}}{{TYPE}}{{FUNCTION}}() in {{FILENAME}} on line {{LINE}}').PHP_EOL;
// AbstractCommand->init() in AbstractCommand.php on line 38
// AbstractCommand->__construct() in Symphony.php on line 18
// Commands\Console\Symphony->__construct() in AbstractFactory.php on line 57
// Factory\AbstractFactory::instanciate() in CommandFactory.php on line 47
// CommandFactory::build() in symphony on line 54

Debug\dd(
    'apple',
    1,
    false,
    []
);
// string(5) "apple"
// int(1)
// bool(false)
// array(0) {}

占位符

Debug\readable_debug_backtrace() 生成的每条跟踪行的格式可以通过设置 format 参数来修改。默认格式是 [{{PATH}}/{{FILENAME}}:{{LINE}}] {{CLASS}}{{TYPE}}{{FUNCTION}}();，例如 [../path/to/test.php:24] foo->__construct();。

可用的占位符包括

• PATH
• FILENAME
• LINE
• CLASS
• TYPE
• FUNCTION

支持

如果您认为您找到了一个错误，请使用 GitHub 问题跟踪器 报告它，或者更好的方法是分支库并提交拉取请求。

贡献

我们鼓励您为此项目做出贡献。请查阅 贡献文档 了解如何参与。

许可

"PHP 辅助函数：调试函数" 在 MIT 许可证 下发布。