omt / omt-dev-debugbar
Laravel的PHP Debugbar集成
Requires
- php: >=7.0
- illuminate/routing: ^5.5|^6
- illuminate/session: ^5.5|^6
- illuminate/support: ^5.5|^6
- maximebf/debugbar: ~1.15.0
- symfony/debug: ^3|^4
- symfony/finder: ^3|^4
Requires (Dev)
- laravel/framework: 5.5.x
- dev-master / 3.2.x-dev
- v3.2.9
- v3.2.8
- v3.2.7
- v3.2.6
- v3.2.5
- v3.2.4
- v3.2.3
- v3.2.2
- v3.2.1
- v3.2.0
- v3.1.5
- v3.1.4
- v3.1.3
- v3.1.2
- v3.1.1
- v3.1.0
- v3.0.1
- v3.0.0
- 2.4.x-dev
- v2.4.3
- v2.4.2
- v2.4.1
- v2.4.0
- v2.3.2
- v2.3.1
- v2.3.0
- V2.2.3
- v2.2.2
- v2.2.1
- v2.2.0
- v2.1.4
- v2.1.3
- v2.1.2
- v2.1.1
- v2.1.0
- v2.0.6
- v2.0.5
- v2.0.4
- v2.0.3
- v2.0.2
- v2.0.1
- v2.0.0
- 1.8.x-dev
- v1.8.9
- v1.8.8
- v1.8.7
- v1.8.6
- v1.8.5
- v1.8.4
- v1.8.3
- v1.8.2
- v1.8.1
- v1.8.0
- v1.7.7
- v1.7.6
- v1.7.5
- v1.7.4
- v1.7.3
- v1.7.2
- v1.7.1
- v1.7.0
- v1.6.8
- v1.6.7
- v1.6.6
- v1.6.5
- v1.6.4
- v1.6.3
- v1.6.2
- v1.6.1
- v1.6.0
- v1.5.5
- v1.5.4
- v1.5.3
- v1.5.2
- v1.5.1
- v1.5.0
- v1.4.3
- v1.4.2
- v1.4.1
- v1.4
- v1.3.1
- v1.3
- v1.2.3
- v1.2.2
- v1.2.1
- v1.2
- v1.1.5
- v1.1.4
- v1.1.3
- v1.1.2
- v1.1.1
- v1.1
- v1.0.4
- v1.0.3
- v1.0.2
- v1.0.1
- v1.0
- v0.3.2
- v0.3.1
- v0.3
- v0.2
- v0.1.0
- dev-feat-multiauth
- dev-telescope-link
- dev-feat-csp
- dev-revert-339-dha0stw-patch-disableVendors
- dev-reset
- dev-revert-353-1.8
- dev-revert-463-master
- dev-revert-350-fix_query_logging_is_off
This package is auto-updated.
Last update: 2024-09-07 19:25:07 UTC
README
关于v3版本:现在通过引入包启用Debugbar,但默认仍需要APP_DEBUG=true!
对于Laravel < 5.5,请使用2.4分支!
这是一个用于集成PHP Debug Bar与Laravel 5的包。它包含一个 ServiceProvider 用于注册 debugbar 并将其附加到输出。您可以通过 Laravel 发布资源和进行配置。它启动了一些 Collectors 以与 Laravel 一起工作,并实现了一些自定义 DataCollectors,专门针对 Laravel。它已配置为显示重定向和(jQuery)Ajax 请求。(显示在下拉菜单中)阅读文档以获取更多配置选项。
注意:仅在开发中使用 DebugBar。它可能会减慢应用程序的速度(因为它需要收集数据)。因此,当遇到速度慢的情况时,请尝试禁用一些 collectors。
此包包含一些自定义 collectors
- QueryCollector:显示所有查询,包括绑定 + 时间
- RouteCollector:显示当前路由的信息。
- ViewCollector:显示当前加载的视图。(可选:显示共享数据)
- EventsCollector:显示所有事件
- LaravelCollector:显示Laravel版本和环境。(默认禁用)
- SymfonyRequestCollector:用更多关于请求/响应的信息替换 RequestCollector
- LogsCollector:显示存储日志的最新日志条目。(默认禁用)
- FilesCollector:显示 PHP 包含/引入的文件。(默认禁用)
- ConfigCollector:显示配置文件中的值。(默认禁用)
- CacheCollector:显示所有缓存事件。(默认禁用)
为 Laravel 启动以下 collectors
- LogCollector:显示所有日志消息
- SwiftMailCollector 和 SwiftLogCollector 用于邮件
和默认 collectors
- PhpInfoCollector
- MessagesCollector
- TimeDataCollector(带启动和应用计时)
- MemoryCollector
- ExceptionsCollector
它还提供了一个 Facade 接口,用于轻松记录消息、异常和时间
安装
使用 composer 需求此包。建议仅在开发中需求此包。
composer require omt/omt-dev-debugbar --dev
Laravel 5.5 使用包自动发现,因此不需要手动添加 ServiceProvider。
当 APP_DEBUG 为 true 时,将启用 Debugbar。
如果您使用通配符/回退路由,请确保在您自己的 App ServiceProvider 之前加载 Debugbar ServiceProvider。
Laravel 5.5+
如果您不使用自动发现,请将 ServiceProvider 添加到 config/app.php 中的 providers 数组中
omt\Debugbar\ServiceProvider::class,
如果您想使用 facade 来记录消息,请将此添加到 app.php 中的 facades 中
'Debugbar' => omt\Debugbar\Facade::class,
默认情况下,如果APP_DEBUG=true,则启用分析器。您可以在配置中覆盖它(debugbar.enabled)或在您的.env中设置DEBUGBAR_ENABLED。更多选项请查看config/debugbar.php。您还可以在配置中设置是否包含/排除供应商文件(FontAwesome、Highlight.js 和 jQuery)。如果已经在您的网站上使用它们,请将其设置为false。您还可以仅显示js或css供应商,通过将其设置为'js'或'css'。由于Highlight.js需要css + js,因此将其设置为true以进行语法高亮。
使用发布命令将包配置复制到本地配置中
php artisan vendor:publish --provider="omt\Debugbar\ServiceProvider"
Lumen
对于Lumen,在bootstrap/app.php中注册不同的Provider
if (env('APP_DEBUG')) { $app->register(omt\Debugbar\LumenServiceProvider::class); }
要更改配置,请将文件复制到您的配置文件夹中并启用它
$app->configure('debugbar');
使用方法
您现在可以使用外观(当添加时)使用PSR-3级别(debug、info、notice、warning、error、critical、alert、emergency)添加消息
Debugbar::info($object); Debugbar::error('Error!'); Debugbar::warning('Watch out…'); Debugbar::addMessage('Another message', 'mylabel');
开始/停止计时
Debugbar::startMeasure('render','Time for rendering'); Debugbar::stopMeasure('render'); Debugbar::addMeasure('now', LARAVEL_START, microtime(true)); Debugbar::measure('My long operation', function() { // Do something… });
或记录异常
try { throw new Exception('foobar'); } catch (Exception $e) { Debugbar::addThrowable($e); }
还有可用于最常见调用的辅助函数
// All arguments will be dumped as a debug message debug($var1, $someString, $intValue, $object); start_measure('render','Time for rendering'); stop_measure('render'); add_measure('now', LARAVEL_START, microtime(true)); measure('My long operation', function() { // Do something… });
如果您想的话,可以通过容器或外观添加自己的DataCollectors
Debugbar::addCollector(new DebugBar\DataCollector\MessagesCollector('my_messages')); //Or via the App container: $debugbar = App::make('debugbar'); $debugbar->addCollector(new DebugBar\DataCollector\MessagesCollector('my_messages'));
默认情况下,Debugbar注入在</body>之前。如果您想自己注入Debugbar,请将配置选项'inject'设置为false并使用自己渲染,并遵循http://phpdebugbar.com/docs/rendering.html
$renderer = Debugbar::getJavascriptRenderer();
注意:不使用自动注入将禁用请求信息,因为那是添加在响应之后的。您可以在配置中将默认_request数据收集器作为替代添加。
运行时启用/禁用
您可以在运行时启用或禁用debugbar。
\Debugbar::enable(); \Debugbar::disable();
注意。一旦启用,收集器将被添加(并可能产生额外开销),因此如果您想在生产中使用debugbar,请禁用配置,并在需要时才启用。
Twig集成
Laravel Debugbar附带两个Twig扩展。这些扩展与rcrowe/TwigBridge 0.6.x进行了测试
将以下扩展添加到您的TwigBridge配置config/extensions.php(或手动注册扩展)
'omt\Debugbar\Twig\Extension\Debug', 'omt\Debugbar\Twig\Extension\Dump', 'omt\Debugbar\Twig\Extension\Stopwatch',
Dump扩展将替换dump函数,使用DataFormatter输出变量。Debug扩展添加一个debug()函数,将变量传递给消息收集器,而不是直接在模板中显示它。它将参数转储,或者当为空时;所有上下文变量。
{{ debug() }}
{{ debug(user, categories) }}
Stopwatch扩展添加一个类似于Symfony/Silex Twigbridge中的stopwatch标签。
{% stopwatch "foo" %}
…some things that gets timed
{% endstopwatch %}
