HtmlDumper

__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, array $extraDisplayOptions = array())

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

Параметры

Data	$data
callable|resource|string|true|null	$output	Вызываемый объект для вывода строки, открытый поток, путь к файлу вывода или true для возврата вывода
array	$extraDisplayOptions

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

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

Возвращаемое значение

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	Позиция Cursor в выводе
string	$type	Тип значения PHP для вывода
string|int|float|bool	$value	Скалярное значение для вывода

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

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

Параметры

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

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

Выводит данные при входе в хеш.

Параметры

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

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

Выводит данные при выходе из хеша.

Параметры

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

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

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

Параметры

Cursor	$cursor	Позиция Cursor в выводе
bool	$hasChild	Когда вывод хеша имеет дочерние элементы
int	$cut	Количество элементов, на которое хеш был усечен

protected dumpKey(Cursor $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

setDisplayOptions(array $displayOptions)

Настраивает параметры отображения.

Параметры

array

$displayOptions

Словарь параметров отображения для настройки поведения

setDumpHeader(string $header)

Устанавливает HTML-заголовок, который будет выведен один раз в потоке вывода.

Параметры

string

$header

HTML-строка

setDumpBoundaries(string $prefix, string $suffix)

Устанавливает HTML-префикс и суффикс, которые будут охватывать каждый отдельный вывод.

Параметры

string	$prefix	HTML-строка, добавляемая в начало
string	$suffix	HTML-строка, добавляемая в конец

protected getDumpHeader()

Выводит HTML-заголовок.