Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[VarDumper] Dynamic HTML dumper #12125

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 5, 2014
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -286,7 +286,7 @@
max-height: 480px;
word-wrap: break-word;
overflow: hidden;
overflow-y: scroll;
overflow-y: auto;
}

table.sf-toolbar-ajax-requests {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,10 @@ public function testDump()
$dump = $collector->getDumps('html');
$this->assertTrue(isset($dump[0]['data']));
$dump[0]['data'] = preg_replace('/^.*?<pre/', '<pre', $dump[0]['data']);
preg_match('/sf-dump-(\\d{2,})/', $dump[0]['data'], $matches);
$dumpId = $matches[1];

$xDump = array(
array(
'data' => "<pre id=sf-dump-{$dumpId}><span class=sf-dump-0><span class=sf-dump-num>123</span>\n</span></pre><script>Sfjs.dump.instrument()</script>\n",
'data' => "<pre class=sf-dump><span class=sf-dump-num>123</span>\n</pre><script>Sfjs.dump.instrument()</script>\n",
'name' => 'DumpDataCollectorTest.php',
'file' => __FILE__,
'line' => $line,
Expand Down
2 changes: 1 addition & 1 deletion src/Symfony/Component/VarDumper/Dumper/CliDumper.php
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ public function leaveObject(Cursor $cursor, $class, $hasChild, $cut)
*/
public function enterResource(Cursor $cursor, $res, $hasChild)
{
$this->enterHash($cursor, 'resource:'.$this->style('note', $res).' {', $hasChild);
$this->enterHash($cursor, $this->style('note', ':'.$res).' {', $hasChild);
}

/**
Expand Down
117 changes: 86 additions & 31 deletions src/Symfony/Component/VarDumper/Dumper/HtmlDumper.php
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ class HtmlDumper extends CliDumper
public static $defaultOutputStream = 'php://output';

protected $dumpHeader;
protected $dumpPrefix = '<pre id=%id%>';
protected $dumpPrefix = '<pre class=sf-dump>';
protected $dumpSuffix = '</pre><script>Sfjs.dump.instrument()</script>';
protected $dumpId = 'sf-dump';
protected $colors = true;
Expand Down Expand Up @@ -101,7 +101,7 @@ protected function getDumpHeader()
$this->headerIsDumped = true;

if (null !== $this->dumpHeader) {
return str_replace('%id%', $this->dumpId, $this->dumpHeader);
return $this->dumpHeader;
}

$line = <<<'EOHTML'
Expand All @@ -110,19 +110,81 @@ protected function getDumpHeader()
Sfjs.dump = Sfjs.dump || {};
Sfjs.dump.childElts = Sfjs.dump.childElts || document.getElementsByName('sf-dump-child');
Sfjs.dump.childLen = Sfjs.dump.childLen || 0;
Sfjs.dump.refElts = Sfjs.dump.refElts || document.getElementsByName('sf-dump-ref');
Sfjs.dump.refLen = Sfjs.dump.refLen || 0;
if (!Sfjs.dump.refStyle) {
Sfjs.dump.refStyle = document.createElement('style');
document.documentElement.firstChild.appendChild(Sfjs.dump.refStyle);
}
Sfjs.dump.instrument = Sfjs.dump.instrument || function () {
var elt,
i = this.childLen,
aCompact = '▶</a><span class="sf-dump-compact">',
aExpanded = '▼</a><span class="sf-dump-expanded">';
var elt, i, ref;

i = this.childLen;
this.childLen= this.childElts.length;

while (i < this.childLen) {
elt = this.childElts[i];
if ("" == elt.className) {
elt.className = "sf-dump-child";
elt.innerHTML = '<a class=sf-dump-ref onclick="Sfjs.dump.toggle(this)">'+('sf-dump-0' == elt.parentNode.className ? aExpanded : aCompact)+elt.innerHTML+'</span>';
elt.innerHTML = '<a class=sf-dump-ref onclick="Sfjs.dump.toggle(this)"><span>▼</span></a><span class="sf-dump-expanded">'+elt.innerHTML+'</span>';
if ('sf-dump-expanded' == elt.parentNode.className) {
if (elt.children[1].firstChild.nextSibling.id) {
elt.firstChild.appendChild(elt.children[1].firstChild);
elt.firstChild.appendChild(elt.children[1].firstChild);
}
Sfjs.dump.toggle(elt.firstChild);
}
}
++i;
}

i = this.refLen;
this.refLen= this.refElts.length;

function instrumentRef(elt) {
var ref = elt.id;

if (elt.href) {
ref = elt.getAttribute('href').substr(1);
if ('@' == elt.innerHTML.charAt(0)) {
elt.onclick = function() {
var r = document.getElementById(ref).parentNode.parentNode,
f = r && r.parentNode,
t = elt.parentNode,
c = elt.cloneNode(true);
if (r && r.className == "sf-dump-child") {
f.insertBefore(c, r);
try {
t.replaceChild(r, elt);
f.replaceChild(elt, c);
Sfjs.dump.refStyle.innerHTML = '';
r = r.firstChild;
c = r.nextSibling;
if ('sf-dump-compact' == c.className) {
Sfjs.dump.toggle(r);
}

return false;
} catch (e) {
f.removeChild(c);
}
}
};
}
}
elt.className += ' '+ref;
elt.onmouseover = function() {
Sfjs.dump.refStyle.innerHTML = 'pre.sf-dump .'+ref+'{background-color: yellow; border-radius: 2px}';
};
elt.onmouseout = function() {
Sfjs.dump.refStyle.innerHTML = '';
};
}

while (i < this.refLen) {
elt = this.refElts[i];
if ("sf-dump-ref" == elt.className) {
instrumentRef(elt);
}
++i;
}
Expand All @@ -131,51 +193,47 @@ protected function getDumpHeader()
var s = a.nextElementSibling;

if ('sf-dump-compact' == s.className) {
a.innerHTML = '▼';
a.firstChild.innerHTML = '▼';
s.className = 'sf-dump-expanded';
} else {
a.innerHTML = '▶';
a.firstChild.innerHTML = '▶';
s.className = 'sf-dump-compact';
}
};
</script>
<style>
#%id% {
pre.sf-dump {
display: block;
background-color: #300a24;
white-space: pre;
line-height: 1.2em;
color: #eee8d5;
font: 12px monospace, sans-serif;
padding: 5px;
border-radius: 5px;
}
#%id% span {
pre.sf-dump span {
display: inline;
}
#%id% .sf-dump-compact {
pre.sf-dump .sf-dump-compact {
display: none;
}
#%id% abbr {
pre.sf-dump abbr {
text-decoration: none;
border: none;
cursor: help;
}
#%id% a {
pre.sf-dump 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}}";
$line .= "pre.sf-dump .sf-dump-$class {{$style}}";
}

$this->dumpHeader = preg_replace('/\s+/', ' ', $line).'</style>'.$this->dumpHeader;

return str_replace('%id%', $this->dumpId, $this->dumpHeader);
return $this->dumpHeader = preg_replace('/\s+/', ' ', $line).'</style>'.$this->dumpHeader;
}

/**
Expand Down Expand Up @@ -214,9 +272,9 @@ protected function style($style, $val)
if ('ref' === $style) {
$ref = substr($val, 1);
if ('#' === $val[0]) {
return "<span class=sf-dump-ref id=\"{$this->dumpId}-ref$ref\">$val</span>";
return "<span class=sf-dump-ref name=sf-dump-ref id=\"{$this->dumpId}-ref$ref\">$val</span>";
} else {
return "<a class=sf-dump-ref href=\"#{$this->dumpId}-ref$ref\">$val</a>";
return "<a class=sf-dump-ref name=sf-dump-ref href=\"#{$this->dumpId}-ref$ref\">$val</a>";
}
}

Expand All @@ -231,7 +289,9 @@ protected function style($style, $val)
}
} elseif ('note' === $style) {
if (false !== $c = strrpos($val, '\\')) {
$val = sprintf('<abbr title="%s" class=sf-dump-%s>%s</abbr>', $val, $style, substr($val, $c+1));
return sprintf('<abbr title="%s" class=sf-dump-%s>%s</abbr>', $val, $style, substr($val, $c+1));
} elseif (':' === $val[0]) {
return sprintf('<abbr title="Resource of type `%s`" class=sf-dump-%s>%s</abbr>', substr($val, 1), $style, $val);
}
}

Expand All @@ -243,20 +303,15 @@ protected function style($style, $val)
*/
protected function dumpLine($depth)
{
switch ($this->lastDepth - $depth) {
case +1: $this->line = '</span>'.$this->line; break;
case -1: $this->line = "<span class=sf-dump-$depth>$this->line"; break;
}

if (-1 === $this->lastDepth) {
$this->line = str_replace('%id%', $this->dumpId, $this->dumpPrefix).$this->line;
$this->line = $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);
$this->line .= $this->dumpSuffix;
parent::dumpLine(0);
}
$this->lastDepth = $depth;
Expand Down
4 changes: 2 additions & 2 deletions src/Symfony/Component/VarDumper/Tests/CliDumperTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ public function testGet()
"str" => "déjà"
7 => b"é"
"[]" => []
"res" => resource:stream {
"res" => :stream {
wrapper_type: "plainfile"
stream_type: "STDIO"
mode: "r"
Expand All @@ -68,7 +68,7 @@ public function testGet()
eof: false
options: []
}
8 => resource:Unknown {}
8 => :Unknown {}
"obj" => Symfony\Component\VarDumper\Tests\Fixture\DumbFoo { #2
foo: "foo"
"bar": "bar"
Expand Down
50 changes: 25 additions & 25 deletions src/Symfony/Component/VarDumper/Tests/HtmlDumperTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -44,14 +44,14 @@ public function testGet()
$out = preg_replace('/[ \t]+$/m', '', $out);
$var['file'] = htmlspecialchars($var['file'], ENT_QUOTES, 'UTF-8');
$intMax = PHP_INT_MAX;
preg_match('/sf-dump-(\\d{2,})/', $out, $matches);
$dumpId = $matches[1];
preg_match('/sf-dump-\d+/', $out, $dumpId);
$dumpId = $dumpId[0];

$this->assertSame(
<<<EOTXT
<foo></foo><bar><span class=sf-dump-0><span class=sf-dump-note>array:25</span> [<span name=sf-dump-child>
<span class=sf-dump-1>"<span class=sf-dump-meta>number</span>" => <span class=sf-dump-num>1</span>
<span class=sf-dump-meta>0</span> => <span class=sf-dump-const>null</span> <span class=sf-dump-ref id="sf-dump-{$dumpId}-ref1">#1</span>
<foo></foo><bar><span class=sf-dump-note>array:25</span> [<span name=sf-dump-child>
"<span class=sf-dump-meta>number</span>" => <span class=sf-dump-num>1</span>
<span class=sf-dump-meta>0</span> => <span class=sf-dump-const>null</span> <span class=sf-dump-ref name=sf-dump-ref id="{$dumpId}-ref1">#1</span>
"<span class=sf-dump-meta>const</span>" => <span class=sf-dump-num>1.1</span>
<span class=sf-dump-meta>1</span> => <span class=sf-dump-const>true</span>
<span class=sf-dump-meta>2</span> => <span class=sf-dump-const>false</span>
Expand All @@ -62,8 +62,8 @@ public function testGet()
"<span class=sf-dump-meta>str</span>" => "<span class=sf-dump-str>d&#233;j&#224;</span>"
<span class=sf-dump-meta>7</span> => b"<span class=sf-dump-str>&#233;</span>"
"<span class=sf-dump-meta>[]</span>" => []
"<span class=sf-dump-meta>res</span>" => resource:<span class=sf-dump-note>stream</span> {<span name=sf-dump-child>
<span class=sf-dump-2><span class=sf-dump-meta>wrapper_type</span>: "<span class=sf-dump-str>plainfile</span>"
"<span class=sf-dump-meta>res</span>" => <abbr title="Resource of type `stream`" class=sf-dump-note>:stream</abbr> {<span name=sf-dump-child>
<span class=sf-dump-meta>wrapper_type</span>: "<span class=sf-dump-str>plainfile</span>"
<span class=sf-dump-meta>stream_type</span>: "<span class=sf-dump-str>STDIO</span>"
<span class=sf-dump-meta>mode</span>: "<span class=sf-dump-str>r</span>"
<span class=sf-dump-meta>unread_bytes</span>: <span class=sf-dump-num>0</span>
Expand All @@ -72,14 +72,14 @@ public function testGet()
<span class=sf-dump-meta>blocked</span>: <span class=sf-dump-const>true</span>
<span class=sf-dump-meta>eof</span>: <span class=sf-dump-const>false</span>
<span class=sf-dump-meta>options</span>: []
</span></span>}
<span class=sf-dump-meta>8</span> => resource:<span class=sf-dump-note>Unknown</span> {}
"<span class=sf-dump-meta>obj</span>" => <span class=sf-dump-note><abbr title="Symfony\Component\VarDumper\Tests\Fixture\DumbFoo" class=sf-dump-note>DumbFoo</abbr></span> {<span name=sf-dump-child> <span class=sf-dump-ref id="sf-dump-{$dumpId}-ref2">#2</span>
<span class=sf-dump-2><span class=sf-dump-public>foo</span>: "<span class=sf-dump-str>foo</span>"
</span>}
<span class=sf-dump-meta>8</span> => <abbr title="Resource of type `Unknown`" class=sf-dump-note>:Unknown</abbr> {}
"<span class=sf-dump-meta>obj</span>" => <abbr title="Symfony\Component\VarDumper\Tests\Fixture\DumbFoo" class=sf-dump-note>DumbFoo</abbr> {<span name=sf-dump-child> <span class=sf-dump-ref name=sf-dump-ref id="{$dumpId}-ref2">#2</span>
<span class=sf-dump-public>foo</span>: "<span class=sf-dump-str>foo</span>"
"<span class=sf-dump-public>bar</span>": "<span class=sf-dump-str>bar</span>"
</span></span>}
</span>}
"<span class=sf-dump-meta>closure</span>" => <span class=sf-dump-note>Closure</span> {<span name=sf-dump-child>
<span class=sf-dump-2><span class=sf-dump-meta>reflection</span>: """
<span class=sf-dump-meta>reflection</span>: """
<span class=sf-dump-str>Closure [ &lt;user&gt; {$closureLabel} Symfony\Component\VarDumper\Tests\Fixture\{closure} ] {</span>
<span class=sf-dump-str> @@ {$var['file']} {$var['line']} - {$var['line']}</span>

Expand All @@ -89,22 +89,22 @@ public function testGet()
<span class=sf-dump-str> }</span>
<span class=sf-dump-str>}</span>
"""
</span></span>}
</span>}
"<span class=sf-dump-meta>line</span>" => <span class=sf-dump-num>{$var['line']}</span>
"<span class=sf-dump-meta>nobj</span>" => <span class=sf-dump-note>array:1</span> [<span name=sf-dump-child>
<span class=sf-dump-2><span class=sf-dump-meta>0</span> => {} <span class=sf-dump-ref id="sf-dump-{$dumpId}-ref3">#3</span>
</span></span>]
"<span class=sf-dump-meta>recurs</span>" => <span class=sf-dump-note>array:1</span> [<span name=sf-dump-child> <span class=sf-dump-ref id="sf-dump-{$dumpId}-ref4">#4</span>
<span class=sf-dump-2><span class=sf-dump-meta>0</span> => <a class=sf-dump-ref href="#sf-dump-{$dumpId}-ref4">&4</a> <span class=sf-dump-note>array:1</span> [<a class=sf-dump-ref href="#sf-dump-{$dumpId}-ref4">@4</a>]
</span></span>]
<span class=sf-dump-meta>9</span> => <a class=sf-dump-ref href="#sf-dump-{$dumpId}-ref1">&1</a> <span class=sf-dump-const>null</span>
"<span class=sf-dump-meta>sobj</span>" => <span class=sf-dump-note><abbr title="Symfony\Component\VarDumper\Tests\Fixture\DumbFoo" class=sf-dump-note>DumbFoo</abbr></span> {<a class=sf-dump-ref href="#sf-dump-{$dumpId}-ref2">@2</a>}
"<span class=sf-dump-meta>snobj</span>" => <a class=sf-dump-ref href="#sf-dump-{$dumpId}-ref3">&3</a> {<a class=sf-dump-ref href="#sf-dump-{$dumpId}-ref3">@3</a>}
"<span class=sf-dump-meta>snobj2</span>" => {<a class=sf-dump-ref href="#sf-dump-{$dumpId}-ref3">@3</a>}
<span class=sf-dump-meta>0</span> => {} <span class=sf-dump-ref name=sf-dump-ref id="{$dumpId}-ref3">#3</span>
</span>]
"<span class=sf-dump-meta>recurs</span>" => <span class=sf-dump-note>array:1</span> [<span name=sf-dump-child> <span class=sf-dump-ref name=sf-dump-ref id="{$dumpId}-ref4">#4</span>
<span class=sf-dump-meta>0</span> => <a class=sf-dump-ref name=sf-dump-ref href="#{$dumpId}-ref4">&4</a> <span class=sf-dump-note>array:1</span> [<a class=sf-dump-ref name=sf-dump-ref href="#{$dumpId}-ref4">@4</a>]
</span>]
<span class=sf-dump-meta>9</span> => <a class=sf-dump-ref name=sf-dump-ref href="#{$dumpId}-ref1">&1</a> <span class=sf-dump-const>null</span>
"<span class=sf-dump-meta>sobj</span>" => <abbr title="Symfony\Component\VarDumper\Tests\Fixture\DumbFoo" class=sf-dump-note>DumbFoo</abbr> {<a class=sf-dump-ref name=sf-dump-ref href="#{$dumpId}-ref2">@2</a>}
"<span class=sf-dump-meta>snobj</span>" => <a class=sf-dump-ref name=sf-dump-ref href="#{$dumpId}-ref3">&3</a> {<a class=sf-dump-ref name=sf-dump-ref href="#{$dumpId}-ref3">@3</a>}
"<span class=sf-dump-meta>snobj2</span>" => {<a class=sf-dump-ref name=sf-dump-ref href="#{$dumpId}-ref3">@3</a>}
"<span class=sf-dump-meta>file</span>" => "<span class=sf-dump-str>{$var['file']}</span>"
b"<span class=sf-dump-meta>bin-key-&#233;</span>" => ""
</span></span>]
</span></bar>
</span>]
</bar>

EOTXT
,
Expand Down