Debug Configuration Reference (DebugBundle)
Debug Configuration Reference (DebugBundle)¶
The DebugBundle integrates the VarDumper component
in Symfony applications. All these options are configured under the debug
key in your application configuration.
1 2 3 4 5 | # displays the default config values defined by Symfony
$ php bin/console config:dump-reference debug
# displays the actual config values used by your application
$ php bin/console debug:config debug
|
Note
When using XML, you must use the http://symfony.com/schema/dic/debug
namespace and the related XSD schema is available at:
https://symfony.com/schema/dic/debug/debug-1.0.xsd
Configuration¶
max_items¶
type: integer default: 2500
This is the maximum number of items to dump. Setting this option to -1
disables the limit.
min_depth¶
type: integer default: 1
Configures the minimum tree depth until which all items are guaranteed to
be cloned. After this depth is reached, only max_items items will be
cloned. The default value is 1, which is consistent with older Symfony
versions.
max_string_length¶
type: integer default: -1
This option configures the maximum string length before truncating the
string. The default value (-1) means that strings are never truncated.
dump_destination¶
type: string default: null
Configures the output destination of the dumps.
By default, the dumps are shown in the toolbar. Since this is not always
possible (e.g. when working on a JSON API), you can have an alternate output
destination for dumps. Typically, you would set this to php://stderr:
- YAML
1 2 3
# config/packages/debug.yaml debug: dump_destination: php://stderr
- XML
1 2 3 4 5 6 7 8 9 10 11
<!-- config/packages/debug.xml --> <?xml version="1.0" encoding="UTF-8" ?> <container xmlns="http://symfony.com/schema/dic/debug" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:debug="http://symfony.com/schema/dic/debug" xsi:schemaLocation="http://symfony.com/schema/dic/services https://symfony.com/schema/dic/services/services-1.0.xsd http://symfony.com/schema/dic/debug https://symfony.com/schema/dic/debug/debug-1.0.xsd"> <debug:config dump-destination="php://stderr"/> </container>
- PHP
1 2 3 4
// config/packages/debug.php $container->loadFromExtension('debug', [ 'dump_destination' => 'php://stderr', ]);
Configure it to "tcp://%env(VAR_DUMPER_SERVER)%" in order to use the ServerDumper feature.
This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.