Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/barryvdh/laravel-debugbar

Debugbar for Laravel (Integrates PHP Debug Bar)
https://github.com/barryvdh/laravel-debugbar

debugbar hacktoberfest laravel

Last synced: 3 months ago
JSON representation

Debugbar for Laravel (Integrates PHP Debug Bar)

Lists

README 

        
## Debugbar for Laravel

![Unit Tests](https://github.com/barryvdh/laravel-debugbar/workflows/Unit%20Tests/badge.svg)

[![Packagist License](https://poser.pugx.org/barryvdh/laravel-debugbar/license.png)](http://choosealicense.com/licenses/mit/)

[![Latest Stable Version](https://poser.pugx.org/barryvdh/laravel-debugbar/version.png)](https://packagist.org/packages/barryvdh/laravel-debugbar)

[![Total Downloads](https://poser.pugx.org/barryvdh/laravel-debugbar/d/total.png)](https://packagist.org/packages/barryvdh/laravel-debugbar)

[![Fruitcake](https://img.shields.io/badge/Powered%20By-Fruitcake-b2bc35.svg)](https://fruitcake.nl/)



This is a package to integrate [PHP Debug Bar](http://phpdebugbar.com/) with Laravel.

It includes a ServiceProvider to register the debugbar and attach it to the output. You can publish assets and configure it through Laravel.

It bootstraps some Collectors to work with Laravel and implements a couple custom DataCollectors, specific for Laravel.

It is configured to display Redirects and (jQuery) Ajax Requests. (Shown in a dropdown)

Read [the documentation](http://phpdebugbar.com/docs/) for more configuration options.



![Debugbar 3.3 Screenshot](https://user-images.githubusercontent.com/973269/79428890-196cc680-7fc7-11ea-8229-189f5eac9009.png)



### Note: Use the DebugBar only in development. Do not use Debugbar on publicly accessible websites, as it will leak information from stored requests (by design). It can also slow the application down (because it has to gather data). So when experiencing slowness, try disabling some of the collectors.



This package includes some custom collectors:

 - QueryCollector: Show all queries, including binding + timing

 - RouteCollector: Show information about the current Route.

 - ViewCollector: Show the currently loaded views. (Optionally: display the shared data)

 - EventsCollector: Show all events

 - LaravelCollector: Show the Laravel version and Environment. (disabled by default)

 - SymfonyRequestCollector: replaces the RequestCollector with more information about the request/response

 - LogsCollector: Show the latest log entries from the storage logs. (disabled by default)

 - FilesCollector: Show the files that are included/required by PHP. (disabled by default)

 - ConfigCollector: Display the values from the config files. (disabled by default)

 - CacheCollector: Display all cache events. (disabled by default)



Bootstraps the following collectors for Laravel:

 - LogCollector: Show all Log messages

 - SymfonyMailCollector for Mail



And the default collectors:

 - PhpInfoCollector

 - MessagesCollector

 - TimeDataCollector (With Booting and Application timing)

 - MemoryCollector

 - ExceptionsCollector



It also provides a facade interface (`Debugbar`) for easy logging Messages, Exceptions and Time



## Installation



Require this package with composer. It is recommended to only require the package for development.



```shell

composer require barryvdh/laravel-debugbar --dev

```



Laravel uses Package Auto-Discovery, so doesn't require you to manually add the ServiceProvider.



The Debugbar will be enabled when `APP_DEBUG` is `true`.



> If you use a catch-all/fallback route, make sure you load the Debugbar ServiceProvider before your own App ServiceProviders.



### Laravel without auto-discovery:



If you don't use auto-discovery, add the ServiceProvider to the providers array in config/app.php



```php

Barryvdh\Debugbar\ServiceProvider::class,

```



If you want to use the facade to log messages, add this to your facades in app.php:



```php

'Debugbar' => Barryvdh\Debugbar\Facades\Debugbar::class,

```



The profiler is enabled by default, if you have APP_DEBUG=true. You can override that in the config (`debugbar.enabled`) or by setting `DEBUGBAR_ENABLED` in your `.env`. See more options in `config/debugbar.php`

You can also set in your config if you want to include/exclude the vendor files also (FontAwesome, Highlight.js and jQuery). If you already use them in your site, set it to false.

You can also only display the js or css vendors, by setting it to 'js' or 'css'. (Highlight.js requires both css + js, so set to `true` for syntax highlighting)



#### Copy the package config to your local config with the publish command:



```shell

php artisan vendor:publish --provider="Barryvdh\Debugbar\ServiceProvider"

```



### Laravel with Octane:



Make sure to add LaravelDebugbar to your flush list in `config/octane.php`.



```php

    'flush' => [

        \Barryvdh\Debugbar\LaravelDebugbar::class,

    ],

```



### Lumen:



For Lumen, register a different Provider in `bootstrap/app.php`:



```php

if (env('APP_DEBUG')) {

 $app->register(Barryvdh\Debugbar\LumenServiceProvider::class);

}

```



To change the configuration, copy the file to your config folder and enable it:



```php

$app->configure('debugbar');

```



## Usage



You can now add messages using the Facade (when added), using the PSR-3 levels (debug, info, notice, warning, error, critical, alert, emergency):



```php

Debugbar::info($object);

Debugbar::error('Error!');

Debugbar::warning('Watch out…');

Debugbar::addMessage('Another message', 'mylabel');

```



And start/stop timing:



```php

Debugbar::startMeasure('render','Time for rendering');

Debugbar::stopMeasure('render');

Debugbar::addMeasure('now', LARAVEL_START, microtime(true));

Debugbar::measure('My long operation', function() {

    // Do something…

});

```



Or log exceptions:



```php

try {

    throw new Exception('foobar');

} catch (Exception $e) {

    Debugbar::addThrowable($e);

}

```



There are also helper functions available for the most common calls:



```php

// All arguments will be dumped as a debug message

debug($var1, $someString, $intValue, $object);



// `$collection->debug()` will return the collection and dump it as a debug message. Like `$collection->dump()`

collect([$var1, $someString])->debug();



start_measure('render','Time for rendering');

stop_measure('render');

add_measure('now', LARAVEL_START, microtime(true));

measure('My long operation', function() {

    // Do something…

});

```



If you want you can add your own DataCollectors, through the Container or the Facade:



```php

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'));

```



By default, the Debugbar is injected just before `