README

Yii 2 的调试扩展

本扩展为 Yii 框架 2.0 应用程序提供调试器。使用此扩展后，每个页面的底部将出现一个调试工具栏。扩展还提供一组独立页面，以显示更详细的调试信息。

有关许可证信息，请查看 LICENSE 文件。

文档在 docs/guide/README.md。

安装

安装此扩展的首选方式是通过 composer。

运行以下命令之一

php composer.phar require --prefer-dist yiisoft/yii2-debug

或

"yiisoft/yii2-debug": "~2.1.0"

将以下内容添加到您的 composer.json 文件的 require 部分。

用法

扩展安装后，只需按如下修改您的应用程序配置

return [
    'bootstrap' => ['debug'],
    'modules' => [
        'debug' => [
            'class' => 'yii\debug\Module',
            // uncomment and adjust the following to add your IP if you are not connecting from localhost.
            //'allowedIPs' => ['127.0.0.1', '::1'],
        ],
        // ...
    ],
    ...
];

您将在应用程序每个页面的底部看到一个调试工具栏。您可以通过点击工具栏来查看更详细的调试信息。

在 IDE 中打开文件

您可以通过此配置创建一个链接，以在您喜欢的 IDE 中打开文件

return [
    'bootstrap' => ['debug'],
    'modules' => [
        'debug' => [
            'class' => 'yii\debug\Module',
            'traceLine' => '<a href="phpstorm://open?url={file}&line={line}">{file}:{line}</a>',
            // uncomment and adjust the following to add your IP if you are not connecting from localhost.
            //'allowedIPs' => ['127.0.0.1', '::1'],
        ],
        // ...
    ],
    ...
];

您必须对您的操作系统进行一些修改。请参阅以下示例

• PHPStorm: https://github.com/aik099/PhpStormProtocol
• Windows 或 Linux 上的 Sublime Text 3: https://packagecontrol.sublime.net.cn/packages/subl%20protocol
• Mac 上的 Sublime Text 3: https://github.com/inopinatus/sublime_url

虚拟化或 docker 化

如果您的应用程序在虚拟化或 docker 化的环境中运行，那么应用程序的基本路径通常与宿主机不同。为了在这些情况下使链接生效，您可以配置 tracePathMappings 如下（将路径更改为您的应用程序）

'tracePathMappings' => [
    '/app' => '/path/to/your/app',
],

或者，您可以创建一个用于 traceLine 的回调以获得更多控制

'traceLine' => function($options, $panel) {
    $filePath = $options['file'];
    if (StringHelper::startsWith($filePath, Yii::$app->basePath)) {
        $filePath = '/path/to/your/app' . substr($filePath, strlen(Yii::$app->basePath));
    }
    return strtr('<a href="ide://open?url=file://{file}&line={line}">{text}</a>', ['{file}' => $filePath]);
},