\Symfony\Component\VarDumper\DumperCliDumper

CliDumper dumps variables for command line output.

Summary

Methods

Properties

Constants

__construct()
setOutput()
setCharset()
setIndentPad()
dump()
setColors()
setMaxStringWidth()
setStyles()
dumpScalar()
dumpString()
enterHash()
leaveHash()

$defaultOutput
$defaultColors

No constants found

dumpLine()
echoLine()
utf8Encode()
dumpEllipsis()
dumpKey()
style()
supportsColors()

$line
$lineDumper
$outputStream
$decimalPoint
$indentPad
$colors
$maxStringWidth
$styles
$controlCharsRx

N/A

No private methods found

$charset
$charsetConverter

N/A

File: vendor\symfony\var-dumper\Symfony\Component\VarDumper\Dumper\CliDumper.php
Package: Default
Class hierarchy: \Symfony\Component\VarDumper\Dumper\AbstractDumper

\Symfony\Component\VarDumper\Dumper\CliDumper

Properties

$defaultOutput

$defaultOutput :

Type

$defaultColors

$defaultColors :

Type

$line

$line :

Type

$lineDumper

$lineDumper :

Type

$outputStream

$outputStream :

Type

$decimalPoint

$decimalPoint :

Type

$indentPad

$indentPad :

Type

$colors

$colors :

Type

$maxStringWidth

$maxStringWidth :

Type

$styles

$styles :

Type

$controlCharsRx

$controlCharsRx :

Type

$charset

$charset :

Type

$charsetConverter

$charsetConverter :

Type

Methods

__construct()

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

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.

setOutput()

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

Sets the output destination of the dumps.

Parameters

callable|resource|string

$output

A line dumper callable, an opened stream or an output path.

Returns

callable|resource|string —

The previous output destination.

setCharset()

setCharset(string  $charset) : string

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

Parameters

string

$charset

The default character encoding to use for non-UTF8 strings.

Returns

string —

The previous charset.

setIndentPad()

setIndentPad(string  $pad) : string

Sets the indentation pad string.

Parameters

string

$pad

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

Returns

string —

The indent pad.

dump()

dump(\Symfony\Component\VarDumper\Cloner\Data  $data, callable|resource|string|null  $output = null)

Dumps a Data object.

Parameters

\Symfony\Component\VarDumper\Cloner\Data	$data	A Data object.
callable\|resource\|string\|null	$output	A line dumper callable, an opened stream or an output path.

setColors()

setColors(boolean  $colors)

Enables/disables colored output.

Parameters

boolean

$colors

setMaxStringWidth()

setMaxStringWidth(integer  $maxStringWidth)

Sets the maximum number of characters per line for dumped strings.

Parameters

integer

$maxStringWidth

setStyles()

setStyles(array  $styles)

Configures styles.

Parameters

array

$styles

A map of style names to style definitions.

dumpScalar()

dumpScalar(\Symfony\Component\VarDumper\Cloner\Cursor  $cursor,   $type,   $value)

{@inheritdoc}

Parameters

\Symfony\Component\VarDumper\Cloner\Cursor	$cursor
	$type
	$value

dumpString()

dumpString(\Symfony\Component\VarDumper\Cloner\Cursor  $cursor,   $str,   $bin,   $cut)

{@inheritdoc}

Parameters

\Symfony\Component\VarDumper\Cloner\Cursor	$cursor
	$str
	$bin
	$cut

enterHash()

enterHash(\Symfony\Component\VarDumper\Cloner\Cursor  $cursor,   $type,   $class,   $hasChild)

{@inheritdoc}

Parameters

\Symfony\Component\VarDumper\Cloner\Cursor	$cursor
	$type
	$class
	$hasChild

leaveHash()

leaveHash(\Symfony\Component\VarDumper\Cloner\Cursor  $cursor,   $type,   $class,   $hasChild,   $cut)

{@inheritdoc}

Parameters

\Symfony\Component\VarDumper\Cloner\Cursor	$cursor
	$type
	$class
	$hasChild
	$cut

dumpLine()

dumpLine(integer  $depth)

Dumps the current line.

Parameters

integer

$depth

The recursive depth in the dumped structure for the line being dumped.

echoLine()

echoLine(string  $line, integer  $depth,   $indentPad)

Generic line dumper callback.

Parameters

string	$line	The line to write.
integer	$depth	The recursive depth in the dumped structure.
	$indentPad

utf8Encode()

utf8Encode(string  $s) : string

Converts a non-UTF-8 string to UTF-8.

Parameters

string

The non-UTF-8 string to convert.

Returns

string —

The string converted to UTF-8.

dumpEllipsis()

dumpEllipsis(\Symfony\Component\VarDumper\Cloner\Cursor  $cursor, boolean  $hasChild, integer  $cut)

Dumps an ellipsis for cut children.

Parameters

\Symfony\Component\VarDumper\Cloner\Cursor	$cursor	The Cursor position in the dump.
boolean	$hasChild	When the dump of the hash has child item.
integer	$cut	The number of items the hash has been cut by.

dumpKey()

dumpKey(\Symfony\Component\VarDumper\Cloner\Cursor  $cursor)

Dumps a key in a hash structure.

Parameters

\Symfony\Component\VarDumper\Cloner\Cursor

$cursor

The Cursor position in the dump.

style()

style(string  $style, string  $value, array  $attr = array()) : string

Decorates a value with some style.

Parameters

string	$style	The type of style being applied.
string	$value	The value being styled.
array	$attr	Optional context information.

Returns

string —

The value with style decoration.

supportsColors()

supportsColors() : boolean

Returns

boolean —

Tells if the current output stream supports ANSI colors or not.