https://github.com/middlewares/debugbar

PSR-15 middleware to insert PHP DebugBar automatically in html responses
https://github.com/middlewares/debugbar

debugbar debugger http middleware psr-15

Last synced: about 2 months ago
JSON representation

PSR-15 middleware to insert PHP DebugBar automatically in html responses

• Host: GitHub
• URL: https://github.com/middlewares/debugbar
• Owner: middlewares
• License: mit
• Created: 2016-10-08T08:16:08.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2024-03-21T14:51:27.000Z (4 months ago)
• Last Synced: 2024-04-22T10:20:50.591Z (3 months ago)
• Topics: debugbar, debugger, http, middleware, psr-15
• Language: PHP
• Size: 43 KB
• Stars: 16
• Watchers: 2
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Lists

• awesome-psr15-middlewares - middlewares/debugbar - Inject [PHP Debug Bar](http://phpdebugbar.com/). (Packages / Development)

README

        
# middlewares/debugbar

[![Latest Version on Packagist][ico-version]][link-packagist]

[![Software License][ico-license]](LICENSE)

![Testing][ico-ga]

[![Total Downloads][ico-downloads]][link-downloads]

Middleware to insert [PHP DebugBar](http://phpdebugbar.com) automatically in html responses.

## Requirements

* PHP >= 7.2

* A [PSR-7 http library](https://github.com/middlewares/awesome-psr15-middlewares#psr-7-implementations)

* A [PSR-15 middleware dispatcher](https://github.com/middlewares/awesome-psr15-middlewares#dispatcher)

## Installation

This package is installable and autoloadable via Composer as [middlewares/debugbar](https://packagist.org/packages/middlewares/debugbar).

```sh

composer require middlewares/debugbar

```

## Example

```php

$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](https://github.com/middlewares/utils#factory) will be used to detect it automatically.

```php

//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](http://phpdebugbar.com/docs/ajax-and-stack.html#ajax-and-stacked-data). By default it's disabled.

```php

$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.

```php

$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/maximebf/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.

```php

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

```

---

Please see [CHANGELOG](CHANGELOG.md) for more information about recent changes and [CONTRIBUTING](CONTRIBUTING.md) for contributing details.

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

[ico-version]: https://img.shields.io/packagist/v/middlewares/debugbar.svg?style=flat-square

[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square

[ico-ga]: https://github.com/middlewares/debugbar/workflows/testing/badge.svg

[ico-downloads]: https://img.shields.io/packagist/dt/middlewares/debugbar.svg?style=flat-square

[link-packagist]: https://packagist.org/packages/middlewares/debugbar

[link-downloads]: https://packagist.org/packages/middlewares/debugbar