middlewares/debugbar

Middleware to insert PHP DebugBar automatically in html responses

v2.2.0 2025-03-23 20:01 UTC

Requires

• php: ^7.2 || ^8.0
• middlewares/utils: ^2 || ^3 || ^4
• php-debugbar/php-debugbar: ^1 || ^2
• psr/http-server-middleware: ^1

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3
• laminas/laminas-diactoros: ^2 || ^3
• oscarotero/php-cs-fixer-config: ^2
• phpstan/phpstan: ^1 || ^2
• phpunit/phpunit: ^8 || ^9
• squizlabs/php_codesniffer: ^3

MIT

• http
• server
• middleware
• debugbar
• psr-7
• psr-15

README

Middleware to insert PHP DebugBar automatically in html responses.

Requirements

• PHP >= 7.2
• A PSR-7 http library
• A PSR-15 middleware dispatcher

Installation

This package is installable and autoloadable via Composer as middlewares/debugbar.

composer require middlewares/debugbar

Example

$dispatcher = new Dispatcher([
	new Middlewares\Debugbar()
]);

$response = $dispatcher->dispatch(new ServerRequest());

Usage

You can provide a DebugBar\DebugBar instance to the constructor or an instance of DebugBar\StandardDebugBar will be created automatically. Optionally, you can provide a Psr\Http\Message\ResponseFactoryInterface and Psr\Http\Message\StreamFactoryInterface to create the new responses. If it's not defined, Middleware\Utils\Factory will be used to detect it automatically.

//Create a StandardDebugBar automatically
$debugbar = new Middlewares\Debugbar();

//Use other Debugbar instance
$debugbar = new Middlewares\Debugbar($myDebugbar);

//Use other Debugbar instance and PSR-17 factories
$debugbar = new Middlewares\Debugbar($myDebugbar, $myResponseFactory, $myStreamFactory);

captureAjax

Use this option to capture ajax requests and send the data in the headers. More info about AJAX and Stacked data. By default it's disabled.

$debugbar = (new Middlewares\Debugbar())->captureAjax();

inline

Set true to dump the js/css code inline in the html. This fixes (or mitigate) some issues related with loading the debugbar assets.

$debugbar = (new Middlewares\Debugbar())->inline();

renderOptions

Use this option to pass render options to the debugbar as an array. A list of available options can be found at https://github.com/php-debugbar/php-debugbar/blob/master/src/DebugBar/JavascriptRenderer.php#L132

An example usage would be to pass a new location for the base_url so that you can rewrite the location of the files needed to render the debug bar. This can be used with symlinks, .htaccess or routes to the files to ensure the debugbar files are accessible.

$debugbar = (new Middlewares\Debugbar())->renderOptions(array('base_url' => "/MyProjectsSubDirectory/php-debugbar/php-debugbar"));

Please see CHANGELOG for more information about recent changes and CONTRIBUTING for contributing details.

The MIT License (MIT). Please see LICENSE for more information.