class CliDumper extends AbstractDumper
CliDumper dumps variables for command line output.
DUMP_LIGHT_ARRAY | |
DUMP_STRING_LENGTH | |
DUMP_COMMA_SEPARATOR | |
DUMP_TRAILING_COMMA |
static | $defaultOutput | ||
static | $defaultColors |
__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. | from AbstractDumper |
string | setCharset(string $charset) Sets the default character encoding to use for non-UTF8 strings. | from AbstractDumper |
string | setIndentPad(string $pad) Sets the indentation pad string. | from AbstractDumper |
dump(Data $data, callable|resource|string|true|null $output = null) Dumps a Data object. | from AbstractDumper | |
setColors(bool $colors) Enables/disables colored output. | ||
setMaxStringWidth(int $maxStringWidth) Sets the maximum number of characters per line for dumped strings. | ||
setStyles(array $styles) Configures styles. | ||
dumpScalar(Cursor $cursor, string $type, scalar $value) Dumps a scalar value. | ||
dumpString(Cursor $cursor, string $str, bool $bin, int $cut) Dumps a string. | ||
enterHash(Cursor $cursor, int $type, string $class, bool $hasChild) Dumps while entering an hash. | ||
leaveHash(Cursor $cursor, int $type, string $class, bool $hasChild, int $cut) Dumps while leaving an hash. |
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 |
Sets the output destination of the dumps.
callable|resource|string | $output | A line dumper callable, an opened stream or an output path |
callable|resource|string | The previous output destination |
Sets the default character encoding to use for non-UTF8 strings.
string | $charset | The default character encoding to use for non-UTF8 strings |
string | The previous charset |
Sets the indentation pad string.
string | $pad | A string the will be prepended to dumped lines, repeated by nesting level |
string | The indent pad |
Dumps a Data object.
Data | $data | |
callable|resource|string|true|null | $output | A line dumper callable, an opened stream, an output path or true to return the dump |
Enables/disables colored output.
bool | $colors |
Sets the maximum number of characters per line for dumped strings.
int | $maxStringWidth |
Configures styles.
array | $styles | A map of style names to style definitions |
Dumps a scalar value.
Cursor | $cursor | The Cursor position in the dump |
string | $type | The PHP type of the value being dumped |
scalar | $value | The scalar value being dumped |
Dumps a string.
Cursor | $cursor | The Cursor position in the dump |
string | $str | The string being dumped |
bool | $bin | Whether $str is UTF-8 or binary encoded |
int | $cut | The number of characters $str has been cut by |
Dumps while entering an hash.
Cursor | $cursor | The Cursor position in the dump |
int | $type | A Cursor::HASH_* const for the type of hash |
string | $class | The object class, resource type or array count |
bool | $hasChild | When the dump of the hash has child item |
Dumps while leaving an hash.
Cursor | $cursor | The Cursor position in the dump |
int | $type | A Cursor::HASH_* const for the type of hash |
string | $class | The object class, resource type or array count |
bool | $hasChild | When the dump of the hash has child item |
int | $cut | The number of items the hash has been cut by |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/VarDumper/Dumper/CliDumper.html