Skip to content

[VarDumper] Add filter in VarDumperTestTrait #22588

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
nicolas-grekas merged 1 commit into from
Jul 3, 2017
Merged

[VarDumper] Add filter in VarDumperTestTrait #22588

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
33 changes: 33 additions & 0 deletions UPGRADE-4.0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -540,6 +540,39 @@ Validator
changed to `true` as of 4.0. If you need the previous behaviour ensure to
set the option to `false`.

VarDumper
---------

* The `VarDumperTestTrait::assertDumpEquals()` method expects a 3rd `$context = null`
argument and moves `$message = ''` argument at 4th position.

Before:

```php
VarDumperTestTrait::assertDumpEquals($dump, $data, $message = '');
```

After:

```php
VarDumperTestTrait::assertDumpEquals($dump, $data, $filter = 0, $message = '');
```

* The `VarDumperTestTrait::assertDumpMatchesFormat()` method expects a 3rd `$context = null`
argument and moves `$message = ''` argument at 4th position.

Before:

```php
VarDumperTestTrait::assertDumpMatchesFormat($dump, $data, $message = '');
```

After:

```php
VarDumperTestTrait::assertDumpMatchesFormat($dump, $data, $filter = 0, $message = '');
```

Workflow
--------

Expand Down
24 changes: 18 additions & 6 deletions src/Symfony/Component/VarDumper/Test/VarDumperTestTrait.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,29 @@
*/
trait VarDumperTestTrait
{
public function assertDumpEquals($dump, $data, $message = '')
public function assertDumpEquals($dump, $data, $filter = 0, $message = '')
{
$this->assertSame(rtrim($dump), $this->getDump($data), $message);
if (is_string($filter)) {
@trigger_error(sprintf('The $message argument of the %s() at 3rd position is deprecated since version 3.4 and will be moved at 4th position in 4.0.', __METHOD__), E_USER_DEPRECATED);
$message = $filter;
$filter = 0;
}

$this->assertSame(rtrim($dump), $this->getDump($data, null, $filter), $message);
}

public function assertDumpMatchesFormat($dump, $data, $message = '')
public function assertDumpMatchesFormat($dump, $data, $filter = 0, $message = '')
{
$this->assertStringMatchesFormat(rtrim($dump), $this->getDump($data), $message);
if (is_string($filter)) {
@trigger_error(sprintf('The $message argument of the %s() at 3rd position is deprecated since version 3.4 and will be moved at 4th position in 4.0.', __METHOD__), E_USER_DEPRECATED);
$message = $filter;
$filter = 0;
}

$this->assertStringMatchesFormat(rtrim($dump), $this->getDump($data, null, $filter), $message);
}

protected function getDump($data, $key = null)
protected function getDump($data, $key = null, $filter = 0)
{
$flags = getenv('DUMP_LIGHT_ARRAY') ? CliDumper::DUMP_LIGHT_ARRAY : 0;
$flags |= getenv('DUMP_STRING_LENGTH') ? CliDumper::DUMP_STRING_LENGTH : 0;
Expand All @@ -38,7 +50,7 @@ protected function getDump($data, $key = null)
$cloner->setMaxItems(-1);
$dumper = new CliDumper(null, null, $flags);
$dumper->setColors(false);
$data = $cloner->cloneVar($data)->withRefHandles(false);
$data = $cloner->cloneVar($data, $filter)->withRefHandles(false);
if (null !== $key && null === $data = $data->seek($key)) {
return;
}
Expand Down