Skip to content

[VarDumper] Handle "title" attribute on virtual properties #19714

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 1 commit into from
Aug 23, 2016
Merged

[VarDumper] Handle "title" attribute on virtual properties #19714

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion src/Symfony/Component/VarDumper/Caster/ExceptionCaster.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ public static function castTraceStub(TraceStub $trace, array $a, Stub $stub, $is
$stub->handle = 0;
$frames = $trace->value;
$prefix = Caster::PREFIX_VIRTUAL;
$format = "\0~Stack level %s.\0%s";

$a = array();
$j = count($frames);
Expand Down Expand Up @@ -124,7 +125,7 @@ public static function castTraceStub(TraceStub $trace, array $a, Stub $stub, $is
$frame->value['args'] = $f[$prefix.'args'];
}
}
$a[$prefix.$j.'. '.$label] = $frame;
$a[sprintf($format, $j, $label)] = $frame;

$lastCall = ' ==> '.$call;
}
Expand Down
5 changes: 4 additions & 1 deletion src/Symfony/Component/VarDumper/Dumper/CliDumper.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -342,13 +342,16 @@ protected function dumpKey(Cursor $cursor)
} elseif (0 < strpos($key, "\0", 1)) {
$key = explode("\0", substr($key, 1), 2);

switch ($key[0]) {
switch ($key[0][0]) {
case '+': // User inserted keys
$attr['dynamic'] = true;
$this->line .= '+'.$bin.'"'.$this->style('public', $key[1], $attr).'": ';
break 2;
case '~':
$style = 'meta';
if (isset($key[0][1])) {
$attr['title'] = substr($key[0], 1);
}
break;
case '*':
$style = 'protected';
Expand Down
2 changes: 2 additions & 0 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 @@ -445,6 +445,8 @@ protected function style($style, $value, $attr = array())
return sprintf('<abbr title="%s" class=sf-dump-%s>%s</abbr>', $v, $style, substr($v, $c + 1));
} elseif ('protected' === $style) {
$style .= ' title="Protected property"';
} elseif ('meta' === $style && isset($attr['title'])) {
$style .= sprintf(' title="%s"', htmlspecialchars($attr['title'], ENT_QUOTES, 'UTF-8'));
} elseif ('private' === $style) {
$style .= sprintf(' title="Private property defined in class:&#10;`%s`"', $attr['class']);
}
Expand Down
74 changes: 54 additions & 20 deletions src/Symfony/Component/VarDumper/Tests/Caster/ExceptionCasterTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@
namespace Symfony\Component\VarDumper\Tests\Caster;

use Symfony\Component\VarDumper\Caster\ExceptionCaster;
use Symfony\Component\VarDumper\Cloner\VarCloner;
use Symfony\Component\VarDumper\Dumper\HtmlDumper;
use Symfony\Component\VarDumper\Test\VarDumperTestTrait;

class ExceptionCasterTest extends \PHPUnit_Framework_TestCase
Expand All @@ -38,14 +40,14 @@ public function testDefaultSettings()
#message: "foo"
#code: 0
#file: "%sExceptionCasterTest.php"
#line: 23
#line: 25
-trace: {
%d. %sExceptionCasterTest.php:23: {
22: {
23: return new \Exception('foo');
24: }
%sExceptionCasterTest.php:25: {
24: {
25: return new \Exception('foo');
26: }
}
%d. %sExceptionCasterTest.php:%d: {
%sExceptionCasterTest.php:%d: {
%d: {
%d: $e = $this->getTestException(1);
%d:
Expand All @@ -65,12 +67,12 @@ public function testSeek()

$expectedDump = <<<'EODUMP'
{
%d. %sExceptionCasterTest.php:23: {
22: {
23: return new \Exception('foo');
24: }
%sExceptionCasterTest.php:25: {
24: {
25: return new \Exception('foo');
26: }
}
%d. %sExceptionCasterTest.php:%d: {
%sExceptionCasterTest.php:%d: {
%d: {
%d: $e = $this->getTestException(2);
%d:
Expand All @@ -94,14 +96,14 @@ public function testNoArgs()
#message: "foo"
#code: 0
#file: "%sExceptionCasterTest.php"
#line: 23
#line: 25
-trace: {
%d. %sExceptionCasterTest.php:23: {
22: {
23: return new \Exception('foo');
24: }
%sExceptionCasterTest.php:25: {
24: {
25: return new \Exception('foo');
26: }
}
%d. %sExceptionCasterTest.php:%d: {
%sExceptionCasterTest.php:%d: {
%d: {
%d: $e = $this->getTestException(1);
%d: ExceptionCaster::$traceArgs = false;
Expand All @@ -122,13 +124,45 @@ public function testNoSrcContext()
#message: "foo"
#code: 0
#file: "%sExceptionCasterTest.php"
#line: 23
#line: 25
-trace: {
%d. %sExceptionCasterTest.php: 23
%d. %sExceptionCasterTest.php: %d
%sExceptionCasterTest.php: 25
%sExceptionCasterTest.php: %d
%A
EODUMP;

$this->assertDumpMatchesFormat($expectedDump, $e);
}

public function testHtmlDump()
{
$e = $this->getTestException(1);
ExceptionCaster::$srcContext = -1;

$h = fopen('php://memory', 'r+b');
$cloner = new VarCloner();
$cloner->setMaxItems(1);
$dumper = new HtmlDumper($h);
$dumper->setDumpHeader('<foo></foo>');
$dumper->setDumpBoundaries('<bar>', '</bar>');
$dumper->dump($cloner->cloneVar($e)->withRefHandles(false));
$dump = stream_get_contents($h, -1, 0);
fclose($h);

$expectedDump = <<<'EODUMP'
<foo></foo><bar><span class=sf-dump-note>Exception</span> {<samp>
#<span class=sf-dump-protected title="Protected property">message</span>: "<span class=sf-dump-str title="3 characters">foo</span>"
#<span class=sf-dump-protected title="Protected property">code</span>: <span class=sf-dump-num>0</span>
#<span class=sf-dump-protected title="Protected property">file</span>: "<span class=sf-dump-str title="%d characters">%sExceptionCasterTest.php</span>"
#<span class=sf-dump-protected title="Protected property">line</span>: <span class=sf-dump-num>25</span>
-<span class=sf-dump-private title="Private property defined in class:&#10;`Exception`">trace</span>: {<samp>
<span class=sf-dump-meta title="Stack level %d.">%sExceptionCasterTest.php</span>: <span class=sf-dump-num>25</span>
&hellip;12
</samp>}
</samp>}
</bar>
EODUMP;

$this->assertStringMatchesFormat($expectedDump, $dump);
}
}
6 changes: 3 additions & 3 deletions src/Symfony/Component/VarDumper/Tests/Caster/ReflectionCasterTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,17 +177,17 @@ public function testGenerator()
0 => ReflectionGenerator {
this: Symfony\Component\VarDumper\Tests\Fixtures\GeneratorDemo { …}
trace: {
3. %sGeneratorDemo.php:9: {
%sGeneratorDemo.php:9: {
8: {
9: yield 1;
10: }
}
2. %sGeneratorDemo.php:20: {
%sGeneratorDemo.php:20: {
19: {
20: yield from GeneratorDemo::foo();
21: }
}
1. %sGeneratorDemo.php:14: {
%sGeneratorDemo.php:14: {
13: {
14: yield from bar();
15: }
Expand Down
10 changes: 5 additions & 5 deletions src/Symfony/Component/VarDumper/Tests/CliDumperTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -288,23 +288,23 @@ public function testThrowingCaster()
⚠: Symfony\Component\VarDumper\Exception\ThrowingCasterException {{$r}
#message: "Unexpected Exception thrown from a caster: Foobar"
-trace: {
%d. {$twig}
%d. %sTemplate.php:%d: {
{$twig}
%sTemplate.php:%d: {
%d: try {
%d: \$this->doDisplay(\$context, \$blocks);
%d: } catch (Twig_Error \$e) {
}
%d. %sTemplate.php:%d: {
%sTemplate.php:%d: {
%d: {
%d: \$this->displayWithErrorHandling(\$this->env->mergeGlobals(\$context), array_merge(\$this->blocks, \$blocks));
%d: }
}
%d. %sTemplate.php:%d: {
%sTemplate.php:%d: {
%d: try {
%d: \$this->display(\$context);
%d: } catch (Exception \$e) {
}
%d. %sCliDumperTest.php:{$line}: {
%sCliDumperTest.php:{$line}: {
%d: }
{$line}: };'),
%d: ));
Expand Down