annotatecms/debugger

Tracy 调试器集成到 Laravel 框架

2.1.2 2015-05-11 10:56 UTC

This package is not auto-updated.

Last update: 2024-09-28 14:06:59 UTC


README

Total Downloads Total Downloads

AnnotateCms 调试器是将 Tracy 集成到 Laravel 框架中。它取代了 Whoops

安装

通过 rtablada/package-installer

自 2.0.6 版本起,您可以使用 rtablada/package-installer

artisan package:install annotatecms/debugger

通过 composer

通过 composer 在 Laravel 框架项目中安装。将以下内容添加到您的 composer.json 文件中

"annotatecms/debugger" : "2.*"

更新 composer 后,将 ServiceProvider 添加到 app/config/app.php 中的 providers 数组

'Annotatecms\Debugger\DebuggerServiceProvider',

您可以在 app/config/app.php 中添加 Debugger 服务的别名: 'Debugger' => 'Annotatecms\Debugger\Facades\Debugger'

通过 Artisan 命令发布配置

php artisan config:publish annotatecms/debugger

配置

配置文件现在位于 app/config/packages/annotatecms/debugger/debugger.php 文件中。

  • enabled - true/false - 快速启用/禁用调试器
  • 模式
    • NULL - 根据主机 IP 自动检测环境
    • development - 强制显示调试器
    • production - 强制隐藏调试器
  • logDirectory - 保存调试器输出的目录。调试器将异常报告作为 HTML 文件保存到此处。
  • email - 当生产环境中发生错误时,调试器可以向此地址发送电子邮件
  • panels - 要嵌入到面板中的面板列表

提供面板

使用这些面板时,您只能在面板列表中使用面板名称。例如

"panels" => array(
	"routing"
)

面板列表

  • routing - 显示路由及其方法、路径和参数。当前路由以粗体显示
  • database - 显示查询及其时间和绑定

创建面板

自 2.1 版本起,调试器作为服务注册。您可以通过 addPanel 方法轻松添加新面板

\Debugger::addPanel(function(){
	return new MyAwesomePanel();
})

addPanel 方法接受工厂函数作为参数。多亏了这个方法,您无需将面板添加到配置文件中。您可以从您的包(通常在服务提供者类中)添加面板。

面板类必须扩展 AbstractPanel 类。您只需实现一个方法,该方法返回面板模板的路径

function getTemplatesPath() {
    return __DIR__ . "/templates";
}

面板模板

面板模板是纯 PHP 文件。文件 tab.php 渲染面板的标签页。通常是一些图标和面板名称。文件 panel.php 渲染面板的内容。您可以使用 tracy 包提供的 CSS 类。例如,请参阅 routing/panel.phprouting/tab.php

Screenhosts

Bar panel Caught exception Routing panel Database panel