miniframe/developer-toolbar

Miniframe PHP 框架的开发者工具栏

v1.1.0 2022-07-20 19:34 UTC

This package is auto-updated.

Last update: 2024-08-26 10:38:56 UTC


README

此库为 Miniframe PHP 框架 添加了一个基本的开发者工具栏。

build code coverage

如何安装

  1. 在您的现有项目中,输入: composer require --dev miniframe/developer-toolbar
  2. 将以下指令添加到 /config/development.ini
  3. 将 development.ini 添加到您的 .gitignore(您不希望在生产环境中运行此工具!)

示例 development.ini 指令

[framework]
middleware[] = Miniframe\Toolbar\Middleware\DeveloperToolbar

[developer-toolbar]
log_path = cache/debug

将 Middleware 添加到 Middleware 列表中的尽可能高的位置,以便它能够在其他 Middleware 之前加载,从而有机会抛出错误。

如何使用

在每个 HTML 页面上,添加了一个错误图标。如果您点击它,将打开一个新标签页,显示调试信息。
在调试非 HTML 页面时,请查看头部(大多数浏览器:F12 -> 网络标签页)并找到 X-Debug-URL 头部。如果您打开该 URL,您也将获得调试页面。

在代码中,您可以使用以下方式将变量转储添加到调试页面

dump(['foo', 'bar']);

还可以使用以下方式将自定义错误添加到调试页面

// notice:
trigger_error('foo bar');

// warning:
trigger_error('foo bar', E_USER_WARNING);

// or a deprecation notice:
trigger_error("Since Core v1.0.0: Test deprecation", E_USER_DEPRECATED);

为 Windows 开发者

bin 文件夹中,存在一些批处理文件,可简化开发过程。

如果您安装了 Docker Desktop for Windows,您可以使用 bin\composer.batbin\phpcs.batbin\phpunit.batbin\phpstan.batbin\security-checker.bat 作为 Composer、CodeSniffer、PHPUnit、PHPStan 和安全检查器的快捷方式,而无需在您的机器上安装 PHP 和其他依赖项。

Bitbucket Pipelines 中使用相同的 Docker 容器和工具来自动测试此项目。