Introduce DebugBarVarDumper for HTML variable dumping #344
Conversation
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
0e57c6e to
bf5fbb6
Compare
The Symfony VarDumper component includes an HtmlDumper that dumps variables in a rich HTML format that allows for expanding and collapsing individual tree nodes in the dumped variable. This makes it much more practical to navigate large/deep variables that have been dumped. DebugBarVarDumper provides a Debug Bar-friendly wrapper around the VarDumper component. It’s intended as a better alternative to DataFormatter::formatVar. It provides for: * Debug Bar-friendly styles for the VarDumper HTML. * Implements AssetProvider for returning VarDumper static assets (requires users of JavascriptRenderer to support inline assets). * Simplifies VarCloner and HtmlDumper function calls for cloning and dumping variables in a Debug Bar environment. VarDumper was originally written/targeted to be a replacement for var_dump, so the default behavior of HtmlDumper echoing static assets and variable dumps directly to the page output isn’t really appropriate. Furthermore, we must contend with several different Symfony versions going back to v2.6.0. This class provides a friendly wrapper. I have tested this with these Symfony versions: * v2.6.0 * v2.7.0 * v2.8.0 * v3.0.0 * v3.1.0 * v3.2.0 * v3.3.0 All seem to work fine, with graceful degradation as needed. Furthermore, the class is ready to take advantage of new features that I added and are upcoming in Symfony v3.4: * setMinDepth: symfony/symfony#23515 This feature will be valuable for the upcoming BacktraceCollector.
bf5fbb6 to
03da05e
Compare
|
Looks nice, thanks! |
|
Alright, not sure if you use Laravel, but I've updated laravel-debugbar in the dev ( Seems to be working :) Had to add the inline rendering, but otherwise did work. I did have to add |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The Symfony VarDumper component includes an
HtmlDumperthat dumps variables in a rich HTML format that allows for expanding and collapsing individual tree nodes in the dumped variable. This makes it much more practical to navigate large/deep variables that have been dumped.DebugBarVarDumperprovides a Debug Bar-friendly wrapper around the VarDumper component. It’s intended as an alternative toDataFormatter::formatVarto enable this rich HTML interface. It provides for:Debug Bar-friendly styles for the VarDumper HTML.
Implements
AssetProviderfor returning VarDumper static assets (requires users ofJavascriptRendererto support inline assets).Simplifies/wraps
VarClonerandHtmlDumperfunction calls for cloning and dumping variables in a Debug Bar environment. VarDumper was originally written/targeted to be a replacement forvar_dump, so the default behavior ofHtmlDumperechoing static assets and variable dumps directly to the page output isn’t really appropriate. Furthermore, we must contend with several different Symfony versions going back to v2.6.0. This class provides a friendly wrapper over all of that.I have tested this with these Symfony versions:
All seem to work fine, with graceful degradation as needed.
Furthermore, the class is ready to take advantage of new features that I added and are upcoming in Symfony v3.4:
This feature will be valuable for the upcoming BacktraceCollector.
Screenshots of how this looks with some of the collectors. After this PR is merged, I'll submit more pull requests to enable these collectors to integrate with this new feature.
Request collector:
Rich variable dumping in the message collector:
Upcoming backtrace collector:
