\Symfony\Component\VarDumper\DumperAbstractDumper

Abstract mechanism for dumping a Data object.

Summary

Methods
Properties
Constants
__construct()
setOutput()
setCharset()
setIndentPad()
dump()
$defaultOutput
No constants found
dumpLine()
echoLine()
utf8Encode()
$line
$lineDumper
$outputStream
$decimalPoint
$indentPad
N/A
No private methods found
$charset
$charsetConverter
N/A

Properties

$defaultOutput

$defaultOutput : 

Type

$line

$line : 

Type

$lineDumper

$lineDumper : 

Type

$outputStream

$outputStream : 

Type

$decimalPoint

$decimalPoint : 

Type

$indentPad

$indentPad : 

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.

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 $s

The non-UTF-8 string to convert.

Returns

string —

The string converted to UTF-8.