VarDumper and DebugBundle #10640
[DebugBundle] global dump() function for daily use
- Loading branch information
commit 9dea601234627d964b47457ff342e2b39d36c205
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| vendor/ | ||
| composer.lock | ||
| phpunit.xml |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <fabien@symfony.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\Bundle\DebugBundle; | ||
|
|
||
| use Symfony\Component\HttpKernel\Bundle\Bundle; | ||
| use Symfony\Component\VarDumper\Dumper\CliDumper; | ||
| use Symfony\Component\VarDumper\VarDumper; | ||
|
|
||
| /** | ||
| * @author Nicolas Grekas <p@tchwork.com> | ||
| */ | ||
| class DebugBundle extends Bundle | ||
| { | ||
| public function boot() | ||
| { | ||
| if ($this->container->getParameter('kernel.debug')) { | ||
| $container = $this->container; | ||
|
|
||
| // This code is here to lazy load the dump stack. This default | ||
| // configuration for CLI mode is overridden in HTTP mode on | ||
| // 'kernel.request' event | ||
| VarDumper::setHandler(function ($var) use ($container) { | ||
| $dumper = new CliDumper(); | ||
| $cloner = $container->get('var_dumper.cloner'); | ||
| $handler = function ($var) use ($dumper, $cloner) { | ||
| $dumper->dump($cloner->cloneVar($var)); | ||
| }; | ||
| VarDumper::setHandler($handler); | ||
| $handler($var); | ||
| }); | ||
| } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <fabien@symfony.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\Bundle\DebugBundle\DependencyInjection; | ||
|
|
||
| use Symfony\Component\Config\Definition\Builder\TreeBuilder; | ||
| use Symfony\Component\Config\Definition\ConfigurationInterface; | ||
|
|
||
| /** | ||
| * DebugExtension configuration structure. | ||
| * | ||
| * @author Nicolas Grekas <p@tchwork.com> | ||
| */ | ||
| class Configuration implements ConfigurationInterface | ||
| { | ||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function getConfigTreeBuilder() | ||
| { | ||
| $treeBuilder = new TreeBuilder(); | ||
| $rootNode = $treeBuilder->root('debug'); | ||
|
|
||
| $rootNode | ||
| ->children() | ||
| ->integerNode('max_items') | ||
| ->info('Max 628C number of displayed items past the first level, -1 means no limit') | ||
| ->min(-1) | ||
| ->defaultValue(250) | ||
| ->end() | ||
| ->integerNode('max_string_length') | ||
| ->info('Max length of displayed strings, -1 means no limit') | ||
| ->min(-1) | ||
| ->defaultValue(-1) | ||
| ->end() | ||
| ->end(); | ||
|
|
||
| return $treeBuilder; | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <fabien@symfony.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\Bundle\DebugBundle\DependencyInjection; | ||
|
|
||
| use Symfony\Component\Config\FileLocator; | ||
| use Symfony\Component\DependencyInjection\ContainerBuilder; | ||
| use Symfony\Component\DependencyInjection\Loader\XmlFileLoader; | ||
| use Symfony\Component\HttpKernel\DependencyInjection\Extension; | ||
|
|
||
| /** | ||
| * DebugExtension. | ||
| * | ||
| * @author Nicolas Grekas <p@tchwork.com> | ||
| */ | ||
| class DebugExtension extends Extension | ||
| { | ||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function load(array $configs, ContainerBuilder $container) | ||
| { | ||
| $configuration = new Configuration(); | ||
| $config = $this->processConfiguration($configuration, $configs); | ||
|
|
||
| $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config')); | ||
| $loader->load('services.xml'); | ||
|
|
||
| $container->setParameter( | ||
| 'var_dumper.cloner.class', | ||
| 'Symfony\Component\VarDumper\Cloner\\'.(function_exists('symfony_zval_info') ? 'Ext' : 'Php').'Cloner' | ||
| ); | ||
|
|
||
| $container->getDefinition('var_dumper.cloner') | ||
| ->addMethodCall('setMaxItems', array($config['max_items'])) | ||
| ->addMethodCall('setMaxString', array($config['max_string_length'])); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| dump() function | ||
| ================ | ||
|
|
||
| This bundle provides a better `dump()` function, that you can use instead of | ||
| `var_dump()`, *better* meaning: | ||
|
|
||
| - per object and resource types specialized view: e.g. filter out Doctrine noise | ||
| while dumping a single proxy entity, or get more insight on opened files with | ||
| `stream_get_meta_data()`. Add your own dedicated `Dumper\Caster` and get the | ||
| view *you* need. | ||
| - configurable output format: HTML, command line with colors or [a dedicated high | ||
|
|
||
| accuracy JSON format](Resource/doc/json-spec.md). | ||
| - ability to dump internal references, either soft ones (objects or resources) | ||
| or hard ones (`=&` on arrays or objects properties). Repeated occurrences of | ||
| the same object/array/resource won't appear again and again anymore. Moreover, | ||
| you'll be able to inspect the reference structure of your data. | ||
| - ability to operate in the context of an output buffering handler. | ||
| - full exposure of the internal mechanisms used for walking through an arbitrary | ||
| PHP data structure. | ||
|
|
||
| Calling `dump($myVvar)` works in all PHP code and `{% dump myVar %}` or | ||
| `{{ dump(myVar) }}` in Twig templates. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| <?xml version="1.0" ?> | ||
|
|
||
| <container xmlns="http://symfony.com/schema/dic/services" | ||
| xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||
| xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd"> | ||
|
|
||
| <parameters> | ||
| <parameter key="data_collector.dump.class">Symfony\Component\HttpKernel\DataCollector\DumpDataCollector</parameter> | ||
| <parameter key="debug.dump_listener.class">Symfony\Component\HttpKernel\EventListener\DumpListener</parameter> | ||
| </parameters> | ||
|
|
||
| <services> | ||
| <service id="data_collector.dump" class="%data_collector.dump.class%"> | ||
|
There was a problem hiding this comment. this service does not look like it is retrieved dynamically at runtime, so it should be marked as private There was a problem hiding this comment. See the service just below that takes the container and this service name: data_collector.dump is dynamically lazy loaded. |
||
| <tag name="data_collector" id="dump" template="@Debug/Profiler/dump.html.twig" /> | ||
| <argument type="service" id="debug.stopwatch" on-invalid="ignore" /> | ||
| </service> | ||
|
|
||
| <service id="debug.dump_listener" class="%debug.dump_listener.class%"> | ||
| <tag name="kernel.event_subscriber" /> | ||
| <argument type="service" id="service_container" /> | ||
| <argument>data_collector.dump</argument> | ||
| </service> | ||
|
|
||
| <service id="var_dumper.cloner" class="%var_dumper.cloner.class%" /> | ||
| </services> | ||
|
|
||
| </container> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| Copyright (c) 2004-2014 Fabien Potencier | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is furnished | ||
| to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
| THE SOFTWARE. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| {% extends '@WebProfiler/Profiler/layout.html.twig' %} | ||
|
|
||
| {% block toolbar %} | ||
| {% set dumps_count = collector.dumpsCount %} | ||
|
|
||
| {% if dumps_count %} | ||
| {% set icon %} | ||
| <img alt="dump()" src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABUAAAAcCAYAAACOGPReAAACcUlEQVRIx+1UPUwUYRB97+Pc8ychMSaE4E+BrYWVgCd7e5dYQSxoiIFEjYWVdNiJiVjaSGFhowUkhsLEH2Jhcvsd54nYaQ0USoAYG7WBvWOfhd+R87zFC40N00z2zTdv30xmBti3/2ZBECy3+pZJgXw+f0rSiKQBkt2SOkluSFoh+SqKoplyufylJdIgCNIAJgGMkUzXcEkAEJM0DtqUNAVgwlq7Vc9hGtR1ACiSHCeZlvQGwFClUjkKYAVAexzHFyXNAkiTvEXSury/lTqFRZI9kr4DuGKtfV6L53K5tTAMu+reZwDMkuwC8F5SUFNcr3TSEf4g6dcTuvIP139ba8vGmD5JawB6Adz9o/xMJnMSwJhLvhGG4acm/T/UCBQKhc9xHA8DAMkxx/Ob1PO8UdfDD8Vi8WnCQAw1A+fn599KegbgoOd5Izukkgbc354kjZi1di4pJumx84M7pCRPO/DdXhaD5ILz3QDAXC4XATiQ8H48DMP7jWA2mx00xrxMUB3Rjcs6gE5JZ621H/ewwsdIfgOwHoZhV22klpz883spX1Kf80v1czrnwKtJidlsdnCXnl6r5zEAUK1WpwFskjwXBMFws8SkHvq+f4HkEIDN7e3tmR3SUqm06o4DADzyff9MK2X39/efMMbU5vpBqVRabVzTCUmLJNvb2tpKu5XrFPamUqkFksfd7t9pevry+XxHHMcvSPa4Hr+W9LBarVrP836mUqkjlUqlF8B1kpcBUNKiMeZSoVD4+q97eg/Azdo9lRSTNDXvsC0AUwBuN97TXS9/HMejAAbcpnQC2JC0THIuiqLppMvfsrnN27d/2y+hkCBqr75LOwAAAABJRU5ErkJggg==" /> | ||
| <span class="sf-toolbar-status sf-toolbar-status-yellow">{{ dumps_count }}</span> | ||
| {% endset %} | ||
|
|
||
| {% set text %} | ||
| <div style="width: 450px; overflow: hidden;"> | ||
| <div class="sf-toolbar-info-piece"> | ||
| <b>dump()</b> | ||
| </div> | ||
| {% for dump in collector.getDumps('html') %} | ||
| <div class="sf-toolbar-info-piece"> | ||
| in {% if dump.file %}<abbr title="{{ dump.file }}">{{ dump.name }}</abbr>{% else %}{{ dump.name }}{% endif %} | ||
| line {{ dump.line }}: | ||
| {{ dump.data|raw }} | ||
| </div> | ||
| {% endfor %} | ||
| <img src="data:image/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==" onload="var h = this.parentNode.innerHTML, rx=/<script>(.*?)<\/script>/g, s; while (s = rx.exec(h)) {eval(s[1]);};" /> | ||
| </div> | ||
| {% endset %} | ||
|
|
||
| {% include '@WebProfiler/Profiler/toolbar_item.html.twig' with { 'link': true } %} | ||
| {% endif %} | ||
| {% endblock %} | ||
|
|
||
| {% block menu %} | ||
| <span class="label"> | ||
| <span class="icon"> | ||
| {{- "" -}} | ||
| <img alt="dump()" src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABwAAAAcCAYAAAByDd+UAAADdUlEQVRIx71WPWwcVRD+ZneN3NzKiAgiJIrwZ9EQ2xchI+/uvb0g8SOouGtAKQAnSkHSJCZF6jSBUCQFkoNEEILGoaDCQVzeu1sLgeAI4cdyBE2qEMtE6LZA2bvbScGcWRt77+wYpntv5833vu/NzgywDVNK3VZK3d7OWRoQYC+ACgCfiEYB7JZPvzPzNQARgIvGmKt3Bej7/rjjOG8D2D8ggVqn05mJoujKlgCLxaJTKBTOENGRdT5LAH4D8KKsPwUwAWBPxoeZ+Vwcx8eazWZnfWxr/YbneSOu684T0VEB+4uZT3e73ce01k8w8+Ger9a6orV+mJn3AbjAzCkAIqKjruvOe543kstQmF0iorJc9TKA140x13s+5XL5fma+KYBrzgdBsM+yrI+J6PGexK1W67ks0zUMRcayLC/EcfxsFgwAkiRJNnufRqPxnW3bTzPzV7K1v1AonNlQ0jAMJ+TNAGCemac3egPHcdq5WVOr3bJt+yUAv+JvfY/4vj++EcPTIvGf7Xb7gDGmu1HA5eXlpG+q1mq3mPkAAAZAkun/AAZBMJZJ/VMLCwsrmwVbXFxsp2l6ME3Tg3mgxphvAHzSkzYMwycBwAEA27YrkiQJgA/6MajX6+8P+F/OAnhVYlcB/GjJwhe9I2PMH9gh01o3APTU8rNvOCrAV7DzdlXIjAIAhWGYABjKO5Gm6fP1en0+zycMw8MA3svzYebEwv9sJLe7AWA3M79jjJnZSYAwDL+UP+CG1vpBK1OUQUTj/wGpvSLn0mrSMHPUy1al1H07yC4AsEvINFYBu93unGzeQ0Sv9QtUKpWmS6XS9ACYhzIJM7cKGEXRT8z8hXw76XnerrwolmWdtyzrfB92TwF4RZaXjDG/rKmlaZqekNo34jjOh9VqddsZPDk5eS8zfwSAmDll5hP/Kt6NRuMHAGdF2hdWVlZmi8Wis1Uwz/NGhoeHP8v0xLPZWWcNi1ardVyaLgC84bru51NTUw8NCiYz0NdE5PcaRxzHM5uOGM1ms9PpdF7OgD4zNDS0pJQ6pZR6JG+qU0rN2rb9ba+EMfPldrtdWd9T84aod4nozYwPA1hi5p+JqCp7FwGMAXh00CGK+mTahDTmgcdEAG9prb+/q0E4CIIx27Yr0sZGiegBoXITwDUiiph5bpBBeLsVJJEus2W7A2Z3gfLvF5gPAAAAAElFTkSuQmCC" /> | ||
| {{- "" -}} | ||
| </span> | ||
| <strong>dump()</strong> | ||
| <span class="count"> | ||
| <span>{{ collector.dumpsCount }}</span> | ||
| </span> | ||
| </span> | ||
| {% endblock %} | ||
|
|
||
| {% block panel %} | ||
| <h2>dump()</h2> | ||
|
|
||
| <style> | ||
| li.sf-dump { | ||
| list-style-type: disc; | ||
| } | ||
| .sf-dump ol>li { | ||
| padding: 0; | ||
| } | ||
| .sf-dump a { | ||
| cursor: pointer; | ||
| } | ||
| .sf-dump-compact { | ||
| display: none; | ||
| } | ||
| </style> | ||
|
|
||
| <ul class="alt"> | ||
| {% for dump in collector.getDumps('html') %} | ||
| <li class="sf-dump sf-reset"> | ||
| in {% if dump.file %}<abbr title="{{ dump.file }}">{{ dump.name }}</abbr>{% else %}{{ dump.name }}{% endif %} | ||
| line {{ dump.line }}: | ||
| <a onclick="Sfjs.dump.toggle(this)">▶</a> | ||
| <span class="sf-dump-compact"> | ||
| {% if dump.fileExcerpt %}{{ dump.fileExcerpt|raw }}{% else %}{{ dump.file|file_excerpt(dump.line) }}{% endif %} | ||
| </span> | ||
|
|
||
| {{ dump.data|raw }} | ||
| </li> | ||
| {% endfor %} | ||
| </ul> | ||
| {% endblock %} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <fabien@symfony.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\Bundle\DebugBundle\Tests\DependencyInjection; | ||
|
|
||
| use Symfony\Bundle\DebugBundle\DependencyInjection\DebugExtension; | ||
| use Symfony\Component\DependencyInjection\ContainerBuilder; | ||
| use Symfony\Component\DependencyInjection\ParameterBag\ParameterBag; | ||
|
|
||
| class DebugExtensionTest extends \PHPUnit_Framework_TestCase | ||
| { | ||
| public function testLoadWithoutConfiguration() | ||
| { | ||
| $container = $this->createContainer(); | ||
| $container->registerExtension(new DebugExtension()); | ||
| $container->loadFromExtension('debug', array()); | ||
| $this->compileContainer($container); | ||
|
|
||
| $expectedTags = array( | ||
| array( | ||
| "id" => "dump", | ||
| "template" => "@Debug/Profiler/dump.html.twig", | ||
| ), | ||
| ); | ||
|
|
||
| $this->assertSame($expectedTags, $container->getDefinition('data_collector.dump')->getTag('data_collector')); | ||
| } | ||
|
|
||
| private function createContainer() | ||
| { | ||
| $container = new ContainerBuilder(new ParameterBag(array( | ||
| 'kernel.cache_dir' => __DIR__, | ||
| 'kernel.root_dir' => __DIR__.'/Fixtures', | ||
| 'kernel.charset' => 'UTF-8', | ||
| 'kernel.debug' => true, | ||
| 'kernel.bundles' => array('DebugBundle' => 'Symfony\\Bundle\\DebugBundle\\DebugBundle'), | ||
| ))); | ||
|
|
||
| return $container; | ||
| } | ||
|
|
||
| private function compileContainer(ContainerBuilder $container) | ||
| { | ||
| $container->getCompilerPassConfig()->setOptimizationPasses(array()); | ||
| $container->getCompilerPassConfig()->setRemovingPasses(array()); | ||
| $container->compile(); | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
put the ; on the next line aligned to the start of the $rootNode->