8000 [VarDumper] Add maxDepth & maxStringLength display options by nicolas-grekas · Pull Request #18948 · symfony/symfony · GitHub
[go: up one dir, main page]
Skip to content

[VarDumper] Add maxDepth & maxStringLength display options #18948

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.

Sign up for GitHub

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 2 commits into from
Jun 28, 2016
Merged

[VarDumper] Add maxDepth & maxStringLength display options #18948

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
58eb665
[VarDumper] Add maxDepth & maxStringLength display options
MGDSoft Mar 13, 2016
998ff33
[VarDumper] Tweak display options implementation
nicolas-grekas Jun 2, 2016
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
Next Next commit
[VarDumper] Add maxDepth & maxStringLength display options
  • Loading branch information
@MGDSoft @nicolas-grekas
MGDSoft authored and nicolas-grekas committed Jun 25, 2016
commit 58eb6651324db5fdf1aa6c01697105a064b261a3
135 changes: 117 additions & 18 deletions src/Symfony/Component/VarDumper/Dumper/HtmlDumper.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ class HtmlDumper extends CliDumper

protected $dumpHeader;
protected $dumpPrefix = '<pre class=sf-dump id=%s data-indent-pad="%s">';
protected $dumpSuffix = '</pre><script>Sfdump("%s")</script>';
protected $dumpSuffix = '</pre><script>Sfdump("%s"%s)</script>';
protected $dumpId = 'sf-dump';
protected $colors = true;
protected $headerIsDumped = false;
Expand All @@ -43,8 +43,17 @@ class HtmlDumper extends CliDumper
'meta' => 'color:#B729D9',
'key' => 'color:#56DB3A',
'index' => 'color:#1299DA',
'str .max-string-length b' => 'color:#A0A0A0',
);

protected $displayOptions = array(
Copy link
Member
@stof stof Jun 2, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should be private

'initDepth' => 1,
'maxDepth' => 1,
'maxStringLength' => 160,
);

protected $displayOptionsIsUpdated = false;

/**
* {@inheritdoc}
*/
Expand Down Expand Up @@ -75,6 +84,20 @@ public function setStyles(array $styles)
$this->styles = $styles + $this->styles;
}

/**
* Configures display options.
*
* @param array $displayOptions A map of displayOptions names to customize the behavior.
*/
public function setDisplayOptions(array $displayOptions)
{
if ($displayOptions)
{
$this->displayOptionsIsUpdated = true;
$this->displayOptions = $displayOptions + $this->displayOptions;
}
}

/**
* Sets an HTML header that will be dumped once in the output stream.
*
Expand All @@ -100,8 +123,9 @@ public function setDumpBoundaries($prefix, $suffix)
/**
* {@inheritdoc}
*/
public function dump(Data $data, $output = null)
public function dump(Data $data, $output = null, array $displayOptions = [])
{
$this->setDisplayOptions($displayOptions);
parent::dump($data, $output);
$this->dumpId = 'sf-dump-'.mt_rand();
}
Expand Down Expand Up @@ -141,8 +165,8 @@ protected function getDumpHeader()
};
}

function toggle(a, recursive) {
var s = a.nextSibling || {}, oldClass = s.className, arrow, newClass;
function toggle(a, depth) {
var s = a.nextSibling || {}, oldClass = s.className, arrow, newClass, i;

if ('sf-dump-compact' == oldClass) {
arrow = '▼';
Expand All @@ -157,13 +181,21 @@ function toggle(a, recursive) {
a.lastChild.innerHTML = arrow;
s.className = newClass;

if (recursive) {
if (depth) {

try {
a = s.querySelectorAll('.'+oldClass);
for (s = 0; s < a.length; ++s) {
if (a[s].className !== newClass) {
a[s].className = newClass;
a[s].previousSibling.lastChild.innerHTML = arrow;

for (i = 0; i < a.length; ++i) {
if (depth != 'ALL' && isNaN(depth) == false) {
if (getLevelNodeForParent(s, a[i]) >= depth) {
continue;
}
}

if (a[i].className !== newClass) {
a[i].className = newClass;
a[i].previousSibling.lastChild.innerHTML = arrow;
}
}
} catch (e) {
Expand All @@ -173,9 +205,26 @@ function toggle(a, recursive) {
return true;
};

return function (root) {
function getLevelNodeForParent(parentNode, currentNode, level) {
level = level || 0;
level++;

if (parentNode.isSameNode(currentNode)) {
return level-1;
}

currentNode = currentNode.parentNode;

return getLevelNodeForParent(parentNode, currentNode, level);
}

return function (root, options) {
root = doc.getElementById(root);
EOHTML;

$line .= 'options = options || '.json_encode($this->displayOptions).';';

$line .= <<<'EOHTML'
function a(e, f) {
addEventListener(root, e, function (e) {
if ('A' == e.target.tagName) {
Expand Down Expand Up @@ -204,7 +253,8 @@ function isCtrlKey(e) {
a('click', function (a, e) {
if (/\bsf-dump-toggle\b/.test(a.className)) {
e.preventDefault();
if (!toggle(a, isCtrlKey(e))) {
var maxDepth = isCtrlKey(e) ? 'ALL' : options.maxDepth ;
if (!toggle(a, maxDepth)) {
var r = doc.getElementById(a.getAttribute('href').substr(1)),
s = r.previousSibling,
f = r.parentNode,
Expand All @@ -218,7 +268,7 @@ function isCtrlKey(e) {
r.innerHTML = r.innerHTML.replace(new RegExp('^'+f[0].replace(rxEsc, '\\$1'), 'mg'), t[0]);
}
if ('sf-dump-compact' == r.className) {
toggle(s, isCtrlKey(e));
toggle(s, maxDepth);
}
}

Expand All @@ -238,7 +288,8 @@ function isCtrlKey(e) {
elt = root.getElementsByTagName('A'),
len = elt.length,
i = 0,
t = [];
t = [],
temp;

while (i < len) t.push(elt[i++]);

Expand All @@ -248,12 +299,11 @@ function isCtrlKey(e) {

while (i < len) t.push(elt[i++]);

root = t;
len = t.length;
i = t = 0;
i = 0;

while (i < len) {
elt = root[i];
elt = t[i];
if ("SAMP" == elt.tagName) {
elt.className = "sf-dump-expanded";
a = elt.previousSibling || {};
Expand All @@ -267,7 +317,7 @@ function isCtrlKey(e) {
a.title = (a.title ? a.title+'\n[' : '[')+keyHint+'+click] Expand all children';
a.innerHTML += '<span>▼</span>';
a.className += ' sf-dump-toggle';
if ('sf-dump' != elt.parentNode.className) {
if (getLevelNodeForParent(root, a) > options.initDepth) {
toggle(a);
}
} else if ("sf-dump-ref" == elt.className && (a = elt.getAttribute('href'))) {
Expand Down Expand Up @@ -297,6 +347,42 @@ function isCtrlKey(e) {
}
++i;
}

if (options.maxStringLength) {
configureMaxStringCollapse();
}

function configureMaxStringCollapse()
{
var t = root.querySelectorAll('.sf-dump-str'), i = 0;

for (i = 0; i < t.length; ++i) {
elt = t[i];
if (elt.innerText.length > options.maxStringLength) {
elt.innerHTML = '<span class="max-string-length collapsed">' +
'<span class="collapsed">' + elt.innerText.substring(0, options.maxStringLength)+'...' +' <b>[+]</b></span>'+
'<span class="expanded">' + elt.innerHTML +' <b>[-]</b></span>' +
'</span>';
}
}

t = root.querySelectorAll('.max-string-length span b');

for (i = 0; i < t.length; ++i) {
t[i].addEventListener("click", function(e) {
toggleMaxStringLength(e.target.parentNode.parentNode);
});
}

function toggleMaxStringLength(elt) {

if (elt.className == 'max-string-length expanded') {
elt.className = 'max-string-length collapsed';
}else{
elt.className = 'max-string-length expanded';
}
}
}
};

})(document);
Expand Down Expand Up @@ -324,6 +410,15 @@ function isCtrlKey(e) {
border: 0;
outline: none;
}
pre.sf-dump .max-string-length.expanded .collapsed {
display:none;
}
pre.sf-dump .max-string-length.collapsed .expanded {
display:none
Copy link
Contributor
@phansys phansys Jun 4, 2016
67ED

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing delimiter.

}
pre.sf-dump .max-string-length b {
cursor: pointer;
}
EOHTML;

foreach ($this->styles as $class => $style) {
Expand Down Expand Up @@ -438,7 +533,11 @@ protected function dumpLine($depth, $endOfValue = false)
}

if (-1 === $depth) {
$this->line .= sprintf($this->dumpSuffix, $this->dumpId);
$this->line .= sprintf(
$this->dumpSuffix,
$this->dumpId,
$this->displayOptionsIsUpdated ? ','.json_encode($this->displayOptions) : ''
);
}
$this->lastDepth = $depth;

Expand Down
0