CliDumper

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

Параметры

callable|resource|string|null	$output	Функция вывода строки, открытый поток или путь к выводу, по умолчанию static::$defaultOutput
string	$charset	Кодировка по умолчанию для строк, не являющихся UTF-8
int	$flags	Битовое поле констант static::DUMP_*, для настройки отображения вывода

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

Устанавливает место назначения вывода.

Параметры

callable|resource|string

$output

Функция вывода строки, открытый поток или путь к выводу

Значение результата

callable|resource|string

Предыдущее место назначения вывода

string setCharset(string $charset)

Устанавливает кодировку по умолчанию для строк, не являющихся UTF-8.

Параметры

string

$charset

Кодировка по умолчанию для строк, не являющихся UTF-8

Значение результата

string

Предыдущая кодировка

string setIndentPad(string $pad)

Устанавливает отступ.

Параметры

string

$pad

Строка, которая будет добавляться к выводимым строкам, повторяясь в зависимости от уровня вложенности

Значение результата

string

Предыдущий отступ

dump(Data $data, callable|resource|string|true|null $output = null)

Выводит объект Data.

Параметры

Data	$data
callable|resource|string|true|null	$output	Функция вывода строки, открытый поток, путь к выводу или true для возврата вывода

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

Выводит текущую строку.

Параметры

int	$depth	Уровень вложенности выводимой структуры, или -1 для сигнализации об окончании вывода вызываемой функции
	$endOfValue

protected echoLine(string $line, int $depth, string $indentPad)

Функция вывода строки.

Параметры

string	$line	Строка для вывода
int	$depth	Уровень вложенности в выводимой структуре
string	$indentPad	Строка отступа

protected string utf8Encode(string $s)

Преобразует строку в UTF-8, если она не в UTF-8.

Параметры

string

$s

Строка, которую необходимо преобразовать

Значение результата

string

Строка, преобразованная в UTF-8

setColors(bool $colors)

Включает/выключает цветной вывод.

Параметры

bool

$colors

setMaxStringWidth(int $maxStringWidth)

Устанавливает максимальную ширину строки для выводимых строк.

Параметры

int

$maxStringWidth

setStyles(array $styles)

Настраивает стили.

Параметры

array

$styles

Словарь названий стилей и определений стилей

dumpScalar(Cursor $cursor, string $type, string|int|float|bool $value)

Выводит скалярное значение.

Параметры

Cursor	$cursor	Положение курсора в выводе
string	$type	Тип PHP значения, которое выводится
string|int|float|bool	$value	Скалярное значение, которое выводится

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

Выводит строку.

Параметры

Cursor	$cursor	Положение курсора в выводе
string	$str	Выводимая строка
bool	$bin	Является ли $str строкой UTF-8 или двоичной
int	$cut	Количество символов, на которое была усечена строка

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

Выводит при входе в массив.

Параметры

Cursor	$cursor	Положение курсора в выводе
int	$type	Константа Cursor::HASH_* для типа массива
string	$class	Класс объекта, тип ресурса или количество элементов массива
bool	$hasChild	Если массив имеет дочерние элементы

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

Выводит при выходе из массива.

Параметры

Cursor	$cursor	Положение курсора в выводе
int	$type	Константа Cursor::HASH_* для типа массива
string	$class	Класс объекта, тип ресурса или количество элементов массива
bool	$hasChild	Если массив имеет дочерние элементы
int	$cut	Количество элементов, на которое был сокращен массив

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

Выводит многоточие для усеченных дочерних элементов.

Параметры

Cursor	$cursor	Положение курсора в выводе
bool	$hasChild	Если массив имеет дочерние элементы
int	$cut	Количество элементов, на которое был сокращен массив

protected dumpKey(Cursor $cursor)

Выводит ключ в структуре массива.

Параметры

Cursor

$cursor

Положение курсора в выводе

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

Декорирует значение стилем.

Параметры

string	$style	Тип применяемого стиля
string	$value	Значение, которое нужно стилизовать
array	$attr	Дополнительная информация о контексте

Значение результата

string

Значение со стилистическим декором

protected bool supportsColors()

Значение результата

bool	Указывает, поддерживает ли текущий выходной поток ANSI-цвета или нет

protected endValue(Cursor $cursor)

Параметры

Cursor

$cursor