[VarDumper] Improved dump in html #12109
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
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 |
|---|---|---|
|
|
@@ -12,6 +12,7 @@ | |
| namespace Symfony\Component\VarDumper\Dumper; | ||
|
|
||
| use Symfony\Component\VarDumper\Cloner\Cursor; | ||
| use Symfony\Component\VarDumper\Cloner\Data; | ||
|
|
||
| /** | ||
| * HtmlDumper dumps variables as HTML. | ||
|
|
@@ -23,8 +24,9 @@ class HtmlDumper extends CliDumper | |
| public static $defaultOutputStream = 'php://output'; | ||
|
|
||
| protected $dumpHeader; | ||
| protected $dumpPrefix = '<pre id=%id%>'; | ||
| protected $dumpSuffix = '</pre><script>Sfjs.dump.instrument()</script>'; | ||
| protected $dumpId = 'sf-dump'; | ||
| protected $colors = true; | ||
| protected $headerIsDumped = false; | ||
| protected $lastDepth = -1; | ||
|
|
@@ -82,6 +84,15 @@ public function setDumpBoundaries($prefix, $suffix) | |
| $this->dumpSuffix = $suffix; | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function dump(Data $data, $lineDumper = null) | ||
| { | ||
| $this->dumpId = 'sf-dump-'.mt_rand(); | ||
| parent::dump($data, $lineDumper); | ||
| } | ||
|
|
||
| /** | ||
| * Dumps the HTML header. | ||
| */ | ||
|
|
@@ -90,7 +101,7 @@ protected function getDumpHeader() | |
| $this->headerIsDumped = true; | ||
|
|
||
| if (null !== $this->dumpHeader) { | ||
| return str_replace('%id%', $this->dumpId, $this->dumpHeader); | ||
| } | ||
|
|
||
| $line = <<<'EOHTML' | ||
|
|
@@ -129,7 +140,7 @@ protected function getDumpHeader() | |
| }; | ||
| </script> | ||
| <style> | ||
| #%id% { | ||
| display: block; | ||
| background-color: #300a24; | ||
| white-space: pre; | ||
|
|
@@ -138,31 +149,33 @@ protected function getDumpHeader() | |
| font: 12px monospace, sans-serif; | ||
| padding: 5px; | ||
| } | ||
| #%id% span { | ||
| display: inline; | ||
| } | ||
| #%id% .sf-dump-compact { | ||
| display: none; | ||
| } | ||
| #%id% abbr { | ||
| text-decoration: none; | ||
| border: none; | ||
| cursor: help; | ||
| } | ||
| #%id% a { | ||
| text-decoration: none; | ||
| cursor: pointer; | ||
| } | ||
| #%id% a:hover { | ||
| text-decoration: underline; | ||
| } | ||
| EOHTML; | ||
|
|
||
| foreach ($this->styles as $class => $style) { | ||
| $line .= "#%id% .sf-dump-$class {{$style}}"; | ||
|
There was a problem hiding this comment. Just for the reader wondering why, I used |
||
| } | ||
|
|
||
| $this->dumpHeader = preg_replace('/\s+/', ' ', $line).'</style>'.$this->dumpHeader; | ||
|
|
||
| return str_replace('%id%', $this->dumpId, $this->dumpHeader); | ||
| } | ||
|
|
||
| /** | ||
|
|
@@ -201,9 +214,9 @@ protected function style($style, $val) | |
| if ('ref' === $style) { | ||
| $ref = substr($val, 1); | ||
| if ('#' === $val[0]) { | ||
| return "<a class=sf-dump-ref name=\"{$this->dumpId}-ref$ref\">$val</a>"; | ||
|
There was a problem hiding this comment. Having different ids is great, why is it also required for names? There was a problem hiding this comment. @nicolas-grekas the name of the anchor is used to reference it There was a problem hiding this comment. There was a problem hiding this comment. Oh I didn't see that, it's a cool feature! |
||
| } else { | ||
| return "<a class=sf-dump-ref href=\"#{$this->dumpId}-ref$ref\">$val</a>"; | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -236,14 +249,14 @@ protected function dumpLine($depth) | |
| } | ||
|
|
||
| if (-1 === $this->lastDepth) { | ||
| $this->line = str_replace('%id%', $this->dumpId, $this->dumpPrefix).$this->line; | ||
| } | ||
| if (!$this->headerIsDumped) { | ||
| $this->line = $this->getDumpHeader().$this->line; | ||
| } | ||
|
|
||
| if (-1 === $depth) { | ||
| $this->line .= str_replace('%id%', $this->dumpId, $this->dumpSuffix); | ||
| parent::dumpLine(0); | ||
| } | ||
| $this->lastDepth = $depth; | ||
|
|
||
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
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.
please add quotes around the attribute (otherwise you need a more complex escaping)
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.
Generated id is safe, it contains only
[a-z0-9-]