PHP: 7.2.5+, 8.0+, current release: 1.2.1 build 2023-11-16
eXtended Dump Bundle is an extension to the Symfony framework. It extends the excellent framework dump function with new features. It attaches a new dockable window to the application with the debug collected by all dumps made by the new way. In one place you can get quick access to dumped objects and variables and information related to the system. Bundle provides a new global function xdump so that you can use eXtended Dump anywhere in your application code.
composer require szczyglis/extended-dump-bundle
- new, configurable window containing grouped dumped objects
- new global function:
xdump, for quick debugging - all dumped objects grouped in one handy place
- displaying in one handy place many useful information, such as debug of the current user, the request and response objects, variables from $_GET, $_POST, $_SESSION, $_COOKIE, $_ENV and $_SERVER, information about PHP and modules, Doctrine entities and repositories with properties and methods list, parameters list and more
- ability to extend with Events
- customizable layout (Twig)
- fully configurable
Appearance after installation:
After installing, a small icon will appear in the lower right corner of the page, pressing it will open the debugger window:
The debug window is divided into 3 sections:
- app - the section contains all variables collected with the use of the
xdumpfunction, - event - the event section displays the debug added using your own Event Subscriber,
- system - displays handy, most useful system information.
The extension adds to framework a new global function called xdump. Thanks to it, you can use eXtended Dump from anywhere in the code. It works similar to the standard dump function, except that debugged objects fly collectively to the eXtended Dump window.
Example of use:
/**
* @Route("/", name="index")
* @param Request $request
* @return Response
*/
public function index(Request $request)
{
$foo1 = 'bar1';
$foo2 = 'bar2';
$foo3 = 'bar3';
xdump($foo1, $foo2, $foo3);
return $this->render('index.html.twig');
}The above code added anywhere in the application (both in controllers and in services) will add the "app" section to the debugger and display the dumped object (or objects) there.
Example of use:
<?php
// src/Controller/IndexController.php
namespace App\Controller;
use Symfony\Component\HttpFoundation\RedirectResponse;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Annotation\Route;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
/**
* Class IndexController
* @package App\Controller
*/
class IndexController extends AbstractController
{
/**
* @Route("/", name="index")
* @param Request $request
* @return Response
*/
public function index(Request $request)
{
$foo1 = 'bar1';
$foo2 = 'bar2';
xdump($foo1, $foo2); // you can put one or multiple arguments
return $this->render('index.html.twig');
}
}Result of the action:
You can use eXtended Dump in Twig templates - twig extension is included in the package.
To use in a template, just use the xdump function inside twig template:
# templates/template.html.twig
{% set foo = "I'm in Twig!" %}
{% set bar = "I'm in Twig too!" %}
{{ xdump(foo, bar) }} # you can dump multiple objects at once also in TwigResult of the action:
You can extend the debugger window with your own elements that will be placed there permanently. Thanks to this, you can, for example, have a quick preview of the status of selected objects in the application. To do this, create a new EventSubscriber or EventListener and handle the Szczyglis\ExtendedDumpBundle\Event\RenderEvent:
Example of use:
<?php
// src/EventSubscriber/CustomDumpSubscriber.php
namespace App\EventSubscriber;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Szczyglis\ExtendedDumpBundle\Event\ExtendedDumpEvents;
use Szczyglis\ExtendedDumpBundle\Event\RenderEvent;
class CustomDumpSubscriber implements EventSubscriberInterface
{
/**
* @param RenderEvent $event
*/
public function onRender(RenderEvent $event)
{
$foo = "I want to be dumped every time!";
$event->add($foo, "I'm Event object");
}
/**
* @return array
*/
public static function getSubscribedEvents()
{
return [
ExtendedDumpEvents::RENDER => 'onRender',
];
}
}The above will add a new section to the debugger window with the following elements added:
You can add multiple items:
class CustomDumpSubscriber implements EventSubscriberInterface
{
/**
* @param RenderEvent $event
*/
public function onRender(RenderEvent $event)
{
$foo1 = "bar1";
$foo2 = "bar2";
$event->add($foo1, "Optional label to display");
$event->add($foo2);
} You can fully customize window appearance, CSS and JS by overriding templates from ./src/Resources/views in your own templates directory.
This section displays the current Request and Response objects:
This section displays a list of all entities used in the application, along with the names and types of defined fields, methods from the class of the given Entity, as well as methods available in the repositories:
This section displays the contents of $_GET, $_POST, $_SESSION and $_COOKIE:
This section displays the object with the currently logged in user:
Useful information about the server is displayed in this section, such as the PHP version, the versions of the loaded modules, and the contents of $_ENV and $_SERVER:
This section displays the values of all parameters defined in the application:
In config/packages/extended_dump.yaml, you can create a configuration and change the way sections are displayed.
The default appearance of extended_dump.yaml:
# config/packages/extended_dump.yaml
extended_dump:
env: [dev] # Array with enabled environments, if empty then only DEV environment will be enabled
display:
enabled: true # Enable/disable Xdump dockable window
dump:
max_depth: 1 # Var Dumper max depth config value
max_string_depth: 160 # Var Dumper max max string depth config value
max_items: -1 # Var Cloner max items config value
sections:
app:
enabled: true # Enable/disable App section
collapsed: false # Collapse App section at start
event:
enabled: true # Enable/disable Event section
collapsed: false # Collapse Event section at start
system:
enabled: true # Enable/disable System section
collapsed: false # Collapse System section at start
items:
request: true # Enable/disable Request dump
response: true # Enable/disable Response dump
session: true # Enable/disable Session dump
get: true # Enable/disable $_GET dump
post: true # Enable/disable $_POST dump
cookies: true # Enable/disable Cookies dump
user: true # Enable/disable User dump
server: true # Enable/disable Server dump
doctrine: true # Enable/disable Doctrine dump
parameters: true # Enable/disable Parameters dumpExample config template is included in package: ./src/Resources/config/extended_dump.yaml.
Symfony 4.4+:
Symfony 5.x:
Symfony 6.x:
- 1.0.13 - Published first release. (2022-04-25)
- 1.0.36 - Added support for multiple arguments in xdump(), user debug moved to bottom of the debugger window, added version info, added dumped items counters and some more features (2022-04-29)
- 1.1.8 - Added doctrine entities and repositories debugger, added parameters dumper, increased configuration options and added some other small improvements (2022-04-29)
- 1.2.0 - Added session exist check, added Content Security Policy nonce append (2023-11-05)
- 1.2.1 - added style nonce append (2023-11-21)
14X6zSCbkU5wojcXZMgT9a4EnJNcieTrcr
or by PayPal: https://www.paypal.me/szczyglinski
Enjoy!
MIT License | 2022 Marcin 'szczyglis' Szczygliński
https://github.com/szczyglis-dev/extended-dump-bundle
Contact: szczyglis@protonmail.com