AbstractDumper

class AbstractDumper implements DataDumperInterface, DumperInterface

Abstract mechanism for dumping a Data object.

Constants

DUMP_LIGHT_ARRAY
DUMP_STRING_LENGTH
DUMP_COMMA_SEPARATOR
DUMP_TRAILING_COMMA

Properties

static $defaultOutput

Methods

__construct(callable|resource|string|null $output = null, string $charset = null, int $flags)
callable|resource|string setOutput(callable|resource|string $output)

Sets the output destination of the dumps.

string setCharset(string $charset)

Sets the default character encoding to use for non-UTF8 strings.

string setIndentPad(string $pad)

Sets the indentation pad string.

dump(Data $data, callable|resource|string|true|null $output = null)

Dumps a Data object.

Details

__construct(callable|resource|string|null $output = null, string $charset = null, int $flags)

Parameters

callable|resource|string|null $output A line dumper callable, an opened stream or an output path, defaults to static::$defaultOutput
string $charset The default character encoding to use for non-UTF8 strings
int $flags A bit field of static::DUMP_* constants to fine tune dumps representation

callable|resource|string setOutput(callable|resource|string $output)

Sets the output destination of the dumps.

Parameters

callable|resource|string $output A line dumper callable, an opened stream or an output path

Return Value

callable|resource|string The previous output destination

string setCharset(string $charset)

Sets the default character encoding to use for non-UTF8 strings.

Parameters

string $charset The default character encoding to use for non-UTF8 strings

Return Value

string The previous charset

string setIndentPad(string $pad)

Sets the indentation pad string.

Parameters

string $pad A string the will be prepended to dumped lines, repeated by nesting level

Return Value

string The indent pad

dump(Data $data, callable|resource|string|true|null $output = null)

Dumps a Data object.

Parameters

Data $data
callable|resource|string|true|null $output A line dumper callable, an opened stream, an output path or true to return the dump

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/VarDumper/Dumper/AbstractDumper.html