Référence de la classe CliDumper

Graphe d'héritage de CliDumper:

Fonctions membres publiques
	__construct ($output=null, string $charset=null, int $flags=0)
	setColors (bool $colors)
	setMaxStringWidth (int $maxStringWidth)
	setStyles (array $styles)
	setDisplayOptions (array $displayOptions)
	dumpScalar (Cursor $cursor, string $type, $value)
	dumpString (Cursor $cursor, string $str, bool $bin, int $cut)
	enterHash (Cursor $cursor, int $type, $class, bool $hasChild)
	leaveHash (Cursor $cursor, int $type, $class, bool $hasChild, int $cut)
Fonctions membres publiques hérités de AbstractDumper
	__construct ($output=null, string $charset=null, int $flags=0)
	setOutput ($output)
	setCharset (string $charset)
	setIndentPad (string $pad)
	dump (Data $data, $output=null)
Fonctions membres publiques hérités de DataDumperInterface
	dump (Data $data)

Attributs publics statiques
static	$defaultColors
static	$defaultOutput = 'php://stdout'
static	n
Attributs publics statiques hérités de AbstractDumper
static	$defaultOutput = 'php://output'

Fonctions membres protégées
	dumpEllipsis (Cursor $cursor, bool $hasChild, int $cut)
	dumpKey (Cursor $cursor)
	style (string $style, string $value, array $attr=[])
	supportsColors ()
	dumpLine (int $depth, bool $endOfValue=false)
	endValue (Cursor $cursor)
Fonctions membres protégées hérités de AbstractDumper
	dumpLine (int $depth)
	echoLine (string $line, int $depth, string $indentPad)
	utf8Encode (?string $s)

Attributs protégés
	$colors
	$maxStringWidth = 0
	$styles
	$collapseNextHash = false
	$expandNextHash = false
Attributs protégés hérités de AbstractDumper
	$line = ''
	$lineDumper
	$outputStream
	$decimalPoint
	$indentPad = ' '
	$flags

Attributs protégés statiques
static	$controlCharsRx = '/[\x00-\x1F\x7F]+/'
static	$controlCharsMap

Fonctions membres privées
	hasColorSupport ($stream)
	isWindowsTrueColor ()
	getSourceLink (string $file, int $line)

Attributs privés
	$displayOptions
	$handlesHrefGracefully

Membres hérités additionnels
Champs de données hérités de AbstractDumper
const	DUMP_LIGHT_ARRAY = 1
const	DUMP_STRING_LENGTH = 2
const	DUMP_COMMA_SEPARATOR = 4
const	DUMP_TRAILING_COMMA = 8

Description détaillée

CliDumper dumps variables for command line output.

Auteur

Nicolas Grekas p@tch.nosp@m.work.nosp@m..com

Documentation des constructeurs et destructeur

__construct()

__construct	(		$output = null,
		string	$charset = null,
		int	$flags = 0
	)

{}

Références AbstractDumper\$charset, AbstractDumper\$flags, $output, Symfony\Contracts\Service\__construct(), CliDumper\isWindowsTrueColor(), et CliDumper\setStyles().

Documentation des fonctions membres

dumpEllipsis()

dumpEllipsis ( Cursor  $cursor, bool  $hasChild, int  $cut  )

protected

Dumps an ellipsis for cut children.

Paramètres

bool	$hasChild	When the dump of the hash has child item
int	$cut	The number of items the hash has been cut by

Références CliDumper\dumpLine().

Référencé par CliDumper\leaveHash().

dumpKey()

dumpKey ( Cursor  $cursor )

protected

Dumps a key in a hash structure.

Références $attr, $key, $style, elseif, Cursor\HASH_ASSOC, Cursor\HASH_INDEXED, Cursor\HASH_OBJECT, Cursor\HASH_RESOURCE, null, CliDumper\style(), et AbstractDumper\utf8Encode().

Référencé par CliDumper\dumpScalar(), CliDumper\dumpString(), et CliDumper\enterHash().

dumpLine()

dumpLine ( int  $depth, bool  $endOfValue = false  )

protected

{}

Référencé par CliDumper\dumpEllipsis(), CliDumper\dumpString(), CliDumper\endValue(), et CliDumper\enterHash().

dumpScalar()

dumpScalar	(	Cursor	$cursor,
		string	$type,
			$value
	)

{Dumps a scalar value.

Paramètres

string	$type	The PHP type of the value being dumped
string | int | float | bool	$value	The scalar value being dumped

}

Implémente DumperInterface.

Références $attr, $style, $type, $value, CliDumper\dumpKey(), CliDumper\endValue(), CliDumper\style(), et AbstractDumper\utf8Encode().

dumpString()

dumpString	(	Cursor	$cursor,
		string	$str,
		bool	$bin,
		int	$cut
	)

{Dumps a string.

Paramètres

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

}

Implémente DumperInterface.

Références $attr, $i, AbstractDumper\$indentPad, CliDumper\$maxStringWidth, CliDumper\dumpKey(), CliDumper\dumpLine(), elseif, CliDumper\endValue(), CliDumper\style(), et AbstractDumper\utf8Encode().

endValue()

endValue ( Cursor  $cursor )

protected

Références Stub\ARRAY_ASSOC, Stub\ARRAY_INDEXED, CliDumper\dumpLine(), et elseif.

Référencé par CliDumper\dumpScalar(), CliDumper\dumpString(), et CliDumper\leaveHash().

enterHash()

enterHash	(	Cursor	$cursor,
		int	$type,
			$class,
		bool	$hasChild
	)

{Dumps while entering an hash.

Paramètres

int	$type	A Cursor::HASH_* const for the type of hash
string | int	$class	The object class, resource type or array count
bool	$hasChild	When the dump of the hash has child item

}

Implémente DumperInterface.

Références $attr, $class, AbstractDumper\$flags, $prefix, $type, CliDumper\dumpKey(), CliDumper\dumpLine(), elseif, Cursor\HASH_OBJECT, Cursor\HASH_RESOURCE, null, CliDumper\style(), CliDumper\supportsColors(), et AbstractDumper\utf8Encode().

getSourceLink()

getSourceLink ( string  $file, int  $line  )

private

Références AbstractDumper\$line.

Référencé par CliDumper\style().

hasColorSupport()

hasColorSupport (   $stream )

private

Returns true if the stream supports colorization.

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

Paramètres

mixed

$stream

A CLI output stream

Références Laminas\Diactoros\$stream.

Référencé par CliDumper\supportsColors().

isWindowsTrueColor()

isWindowsTrueColor ( )

private

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.

Références $result, et $version.

Référencé par CliDumper\__construct().

leaveHash()

leaveHash	(	Cursor	$cursor,
		int	$type,
			$class,
		bool	$hasChild,
		int	$cut
	)

{Dumps while leaving an hash.

Paramètres

int	$type	A Cursor::HASH_* const for the type of hash
string | int	$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

}

Implémente DumperInterface.

Références $type, CliDumper\dumpEllipsis(), CliDumper\endValue(), Cursor\HASH_OBJECT, et Cursor\HASH_RESOURCE.

setColors()

setColors

(

bool

$colors

)

Enables/disables colored output.

Références CliDumper\$colors.

setDisplayOptions()

setDisplayOptions

(

array

$displayOptions

)

Configures display options.

Paramètres

array

$displayOptions

A map of display options to customize the behavior

Références CliDumper\$displayOptions.

setMaxStringWidth()

setMaxStringWidth

(

int

$maxStringWidth

)

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

Références CliDumper\$maxStringWidth.

setStyles()

setStyles

(

array

$styles

)

Configures styles.

Paramètres

array

$styles

A map of style names to style definitions

Références CliDumper\$styles.

Référencé par CliDumper\__construct().

style()

style ( string  $style, string  $value, array  $attr = []  )

protected

Decorates a value with some style.

Paramètres

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

Renvoie

string

Références $attr, $c, $href, $i, $prefix, $value, elseif, CliDumper\getSourceLink(), null, et CliDumper\supportsColors().

Référencé par CliDumper\dumpKey(), CliDumper\dumpScalar(), CliDumper\dumpString(), et CliDumper\enterHash().

supportsColors()

supportsColors ( )

protected

Renvoie

bool

Références CliDumper\$colors, $i, AbstractDumper\$outputStream, CliDumper\hasColorSupport(), et null.

Référencé par CliDumper\enterHash(), et CliDumper\style().

Documentation des champs

$collapseNextHash

$collapseNextHash = false

protected

$colors

$colors

protected

Référencé par CliDumper\setColors(), et CliDumper\supportsColors().

$controlCharsMap

$controlCharsMap

staticprotected

Valeur initiale :

= [
        "\t" => '\t'

$controlCharsRx

$controlCharsRx = '/[\x00-\x1F\x7F]+/'

staticprotected

$defaultColors

$defaultColors

static

$defaultOutput

$defaultOutput = 'php://stdout'

static

$displayOptions

$displayOptions

private

Valeur initiale :

= [
        'fileLinkFormat' => null

Référencé par CliDumper\setDisplayOptions().

$expandNextHash

$expandNextHash = false

protected

$handlesHrefGracefully

$handlesHrefGracefully

private

$maxStringWidth

$maxStringWidth = 0

protected

Référencé par CliDumper\dumpString(), et CliDumper\setMaxStringWidth().

$styles

$styles

protected

Valeur initiale :

= [
        
        'default' => '0;38;5;208'

Référencé par CliDumper\setStyles().

n

n

static

Valeur initiale :

=> '\n',
        "\v" => '\v',
        "\f" => '\f',
        "\r" => '\r',
        "\033" => '\e',
    ]

Référencé par HtmlDumper\getDumpHeader().

---

La documentation de cette classe a été générée à partir du fichier suivant :

• CliDumper.php