\Symfony\Component\VarDumper\DumperCliDumper

CliDumper dumps variables for command line output.

Summary

Methods

Properties

Constants

__construct()
setColors()
setMaxStringWidth()
setStyles()
setDisplayOptions()
dumpScalar()
dumpString()
enterHash()
leaveHash()

$defaultColors
$defaultOutput

No constants found

dumpEllipsis()
dumpKey()
style()
supportsColors()
dumpLine()
endValue()

$colors
$maxStringWidth
$styles
$controlCharsRx
$controlCharsMap
$collapseNextHash
$expandNextHash

N/A

hasColorSupport()
isWindowsTrueColor()
getSourceLink()

$displayOptions
$handlesHrefGracefully

N/A

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

\Symfony\Component\VarDumper\Dumper\CliDumper

Properties

$defaultColors

$defaultColors :

Type

$defaultOutput

$defaultOutput :

Type

$colors

$colors :

Type

$maxStringWidth

$maxStringWidth :

Type

$styles

$styles :

Type

$controlCharsRx

$controlCharsRx :

Type

$controlCharsMap

$controlCharsMap :

Type

$collapseNextHash

$collapseNextHash :

Type

$expandNextHash

$expandNextHash :

Type

$displayOptions

$displayOptions :

Type

$handlesHrefGracefully

$handlesHrefGracefully :

Type

Methods

__construct()

__construct(  $output = null, \Symfony\Component\VarDumper\Dumper\string  $charset = null, \Symfony\Component\VarDumper\Dumper\int  $flags)

{@inheritdoc}

Parameters

	$output
\Symfony\Component\VarDumper\Dumper\string	$charset
\Symfony\Component\VarDumper\Dumper\int	$flags

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

setDisplayOptions()

setDisplayOptions(array  $displayOptions)

Configures display options.

Parameters

array

$displayOptions

A map of display options to customize the behavior

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

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

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

dumpLine()

dumpLine(  $depth,   $endOfValue = false)

{@inheritdoc}

Parameters

	$depth
	$endOfValue

endValue()

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

Parameters

\Symfony\Component\VarDumper\Cloner\Cursor

$cursor

hasColorSupport()

hasColorSupport(mixed  $stream)

Returns true if the stream supports colorization.

Reference: Composer\XdebugHandler\Process::supportsColor https://github.com/composer/xdebug-handler

Parameters

mixed

$stream

A CLI output stream

isWindowsTrueColor()

isWindowsTrueColor()

Returns true if the Windows terminal supports true color.

Note that this does not check an output stream, but relies on environment variables from known implementations, or a PHP and Windows version that supports true color.

getSourceLink()

getSourceLink(\Symfony\Component\VarDumper\Dumper\string  $file, \Symfony\Component\VarDumper\Dumper\int  $line)

Parameters

\Symfony\Component\VarDumper\Dumper\string	$file
\Symfony\Component\VarDumper\Dumper\int	$line