leevel / debugbar
Debug bar in the browser for php application
Requires
- php: ^7.2|^8
- psr/log: ^1|^2|^3
- symfony/var-dumper: ^4|^5|^6|^7
Requires (Dev)
- dbrekelmans/bdi: ^1
- phpunit/phpunit: ^8|^9
- symfony/panther: ^1|^2.1
- twig/twig: ^1.38|^2.7|^3.0
Suggests
- kriswallsmith/assetic: The best way to manage assets
- monolog/monolog: Log using Monolog
- predis/predis: Redis storage
This package is auto-updated.
Last update: 2024-12-02 01:47:16 UTC
README
Displays a debug bar in the browser with information from php.
No more var_dump() in your code!
Note: Debug Bar is for development use only. Never install this on websites that are publicly accessible.
Features:
- Generic debug bar
- Easy to integrate with any project
- Clean, fast and easy to use interface
- Handles AJAX request
- Includes generic data collectors and collectors for well known libraries
- The client side bar is 100% coded in javascript
- Easily create your own collectors and their associated view in the bar
- Save and re-open previous requests
- Very well documented
Includes collectors for:
Checkout the demo for examples and phpdebugbar.com for a live example.
Integrations with other frameworks:
- Laravel
- Atomik
- XOOPS
- Zend Framework 2
- Phalcon
- SilverStripe
- Grav CMS
- TYPO3
- Joomla
- Drupal
- October CMS
- Framework-agnostic middleware and PSR-7 with php-middleware/phpdebugbar
- Dotkernel Frontend Application
(drop me a message or submit a PR to add your DebugBar related project here)
Installation
The best way to install DebugBar is using Composer with the following command:
composer require maximebf/debugbar --dev
Quick start
DebugBar is very easy to use and you can add it to any of your projects in no time.
The easiest way is using the render() functions
<?php // Require the Composer autoloader, if not already loaded require 'vendor/autoload.php'; use DebugBar\StandardDebugBar; $debugbar = new StandardDebugBar(); $debugbarRenderer = $debugbar->getJavascriptRenderer(); $debugbar["messages"]->addMessage("hello world!"); ?> <html> <head> <?php echo $debugbarRenderer->renderHead() ?> </head> <body> ... <?php echo $debugbarRenderer->render() ?> </body> </html>
The DebugBar uses DataCollectors to collect data from your PHP code. Some of them are
automated but others are manual. Use the DebugBar like an array where keys are the
collector names. In our previous example, we add a message to the MessagesCollector:
$debugbar["messages"]->addMessage("hello world!");
StandardDebugBar activates the following collectors:
MemoryCollector(memory)MessagesCollector(messages)PhpInfoCollector(php)RequestDataCollector(request)TimeDataCollector(time)ExceptionsCollector(exceptions)
Learn more about DebugBar in the docs.
Demo
To run the demo, clone this repository and start the Built-In PHP webserver from the root:
php -S localhost:8000
Then visit http://localhost:8000/demo/
Testing
To test, run php vendor/bin/phpunit.
To debug Browser tests, you can run PANTHER_NO_HEADLESS=1 vendor/bin/phpunit --debug. Run vendor/bin/bdi detect drivers to download the latest drivers.