8000 Document new environment variables and display options by sawmurai · Pull Request #7217 · symfony/symfony-docs · GitHub
[go: up one dir, main page]
Skip to content

Document new environment variables and display options #7217

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 9 commits into from
Apr 15, 2017
Merged

Document new environment variables and display options #7217

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
7b26e44
Document new environment variables and display options
sawmurai Dec 3, 2016
adbec6d
Reformat documentation and link to class doc.
sawmurai Dec 3, 2016
9340846
Replaced the list to use an unordered list
javiereguiluz Dec 3, 2016
dfb6d6a
Trimmed some lines to respect the 80-char soft limit
javiereguiluz Dec 3, 2016
ad90321
Describe flags in more detail
sawmurai Dec 3, 2016
6b2248e
Fix mention of file
sawmurai Dec 3, 2016
0c46fce
Respect 80 chars line length
sawmurai Dec 3, 2016
2ef1b60
Fix format
Dec 8, 2016
29080a6
Minor formatting changes
javiereguiluz Apr 15, 2017
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
Prev Previous commit
Minor formatting changes
  • Loading branch information
@javiereguiluz
javiereguiluz authored Apr 15, 2017
commit 29080a6814567c4daf1eedd9b306491b747aa946
101 changes: 50 additions & 51 deletions components/var_dumper/advanced.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,93 +182,92 @@ them from re-implementing the logic required to walk through a
:class:`Symfony\\Component\\VarDumper\\Cloner\\Data` object's internal structure.

The :class:`Symfony\\Component\\VarDumper\\Dumper\\HtmlDumper` limits string
length and nesting depth of the output. These options can be overriden by
providing a third parameter when calling
length and nesting depth of the output to make it more readable. These options
can be overriden by the third optional parameter of the
:method:`dump(Data $data) <Symfony\\Component\\VarDumper\\Dumper\\DataDumperInterface::dump>`
::
method::

use Symfony\Component\VarDumper\Dumper\HtmlDumper;

$output = fopen('php://memory', 'r+b');

$dumper = new HtmlDumper();
$dumper->dump($var, $output, array(
// 1 and 160 are the default values for these options
'maxDepth' => 1,
'maxStringLength' => 160
));

// Limit nesting to 1 level and string length to 160 characters (default)

The output format of a dumper can be fine tuned by the two flags
``DUMP_STRING_LENGTH`` and ``DUMP_LIGHT_ARRAY`` which are passed as a bitmap
in the third constructor argument. They can also be set via environment
variables when using
:method:`assertDumpEquals($dump, $data, $message) <Symfony\\Component\\VarDumper\\Test\\VarDumperTestTrait::assertDumpEquals>`
during unit testing. The flags can be configured in the PHPUnit configuration.
during unit testing.

* If ``DUMP_STRING_LENGTH`` is set, then the length of a string is displayed
next to its content.
If ``DUMP_STRING_LENGTH`` is set, then the length of a string is displayed
next to its content:

.. code-block:: php
.. code-block:: php

use Symfony\Component\VarDumper\Dumper\AbstractDumper;
use Symfony\Component\VarDumper\Dumper\CliDumper;
use Symfony\Component\VarDumper\Dumper\AbstractDumper;
use Symfony\Component\VarDumper\Dumper\CliDumper;

$var = array('test');
$dumper = new CliDumper();
echo $dumper->dump($var, true);
$var = array('test');
$dumper = new CliDumper();
echo $dumper->dump($var, true);

// array:1 [
// 0 => "test"
// ]
// array:1 [
// 0 => "test"
// ]

$dumper = new CliDumper(null, null, AbstractDumper::DUMP_STRING_LENGTH);
echo $dumper->dump($var, true);
$dumper = new CliDumper(null, null, AbstractDumper::DUMP_STRING_LENGTH);
echo $dumper->dump($var, true);

// (added string length before the string)
// array:1 [
// 0 => (4) "test"
// ]
// (added string length before the string)
// array:1 [
// 0 => (4) "test"
// ]

* If ``DUMP_LIGHT_ARRAY`` is set, then arrays are dumped in a shortened format
similar to PHP's short array notation.
If ``DUMP_LIGHT_ARRAY`` is set, then arrays are dumped in a shortened format
similar to PHP's short array notation:

.. code-block:: php
.. code-block:: php

use Symfony\Component\VarDumper\Dumper\AbstractDumper;
use Symfony\Component\VarDumper\Dumper\CliDumper;
use Symfony\Component\VarDumper\Dumper\AbstractDumper;
use Symfony\Component\VarDumper\Dumper\CliDumper;

$var = array('test');
$dumper = new CliDumper();
echo $dumper->dump($var, true);
$var = array('test');
$dumper = new CliDumper();
echo $dumper->dump($var, true);

// array:1 [
// 0 => "test"
// ]
// array:1 [
// 0 => "test"
// ]

$dumper = new CliDumper(null, null, AbstractDumper::DUMP_LIGHT_ARRAY);
echo $dumper->dump($var, true);
$dumper = new CliDumper(null, null, AbstractDumper::DUMP_LIGHT_ARRAY);
echo $dumper->dump($var, true);

// (no more array:1 prefix)
// [
// 0 => "test"
// ]
// (no more array:1 prefix)
// [
// 0 => "test"
// ]

* If you would like to use both options, then you can just
combine them by using a the logical OR operator ``|``.
If you would like to use both options, then you can just combine them by
using a the logical OR operator ``|``:

.. code-block:: php
.. code-block:: php

use Symfony\Component\VarDumper\Dumper\AbstractDumper;
use Symfony\Component\VarDumper\Dumper\CliDumper;
use Symfony\Component\VarDumper\Dumper\AbstractDumper;
use Symfony\Component\VarDumper\Dumper\CliDumper;

$var = array('test');
$dumper = new CliDumper(null, null, AbstractDumper::DUMP_STRING_LENGTH | AbstractDumper::DUMP_LIGHT_ARRAY);
echo $dumper->dump($var, true);
$var = array('test');
$dumper = new CliDumper(null, null, AbstractDumper::DUMP_STRING_LENGTH | AbstractDumper::DUMP_LIGHT_ARRAY);
echo $dumper->dump($var, true);

// [
// 0 => (4) "test"
// ]
// [
// 0 => (4) "test"
// ]

Casters
-------
Expand Down
0