HtmlDumper
class HtmlDumper extends CliDumper
HtmlDumper выводит переменные в формате HTML.
Постоянные значения
| DUMP_LIGHT_ARRAY | |
| DUMP_STRING_LENGTH |
Свойства
| static | $defaultOutput | ||
| static | $defaultColors | из CliDumper |
Методы
| __construct(callable|resource|string|null $output = null, string $charset = null, int $flags) | ||
| callable|resource|string | setOutput(callable|resource|string $output) Устанавливает место назначения вывода результатов. | из AbstractDumper |
| string | setCharset(string $charset) Устанавливает кодировку по умолчанию для строк, не являющихся UTF-8. | из AbstractDumper |
| string | setIndentPad(string $pad) Устанавливает строку отступа. | из AbstractDumper |
| dump(Data $data, callable|resource|string|true|null $output = null, array $extraDisplayOptions = array()) Выводит объект Data. | ||
| setColors(bool $colors) Включает/выключает цветной вывод. | из CliDumper | |
| setMaxStringWidth(int $maxStringWidth) Устанавливает максимальное число символов в строке для выводимых строк. | из CliDumper | |
| setStyles(array $styles) Настраивает стили. | ||
| dumpScalar(Cursor $cursor, string $type, scalar $value) Выводит скалярное значение. | из CliDumper | |
| dumpString(Cursor $cursor, string $str, bool $bin, int $cut) Выводит строку. | из CliDumper | |
| enterHash(Cursor $cursor, int $type, string $class, bool $hasChild) Выводит при входе в хэш. | ||
| leaveHash(Cursor $cursor, int $type, string $class, bool $hasChild, int $cut) Выводит при выходе из хэша. | ||
| setDisplayOptions(array $displayOptions) Настраивает параметры отображения. | ||
| setDumpHeader(string $header) Устанавливает HTML-заголовок, который будет выведен один раз в поток вывода. | ||
| setDumpBoundaries(string $prefix, string $suffix) Устанавливает HTML-префикс и суффикс, которые будут обрамлять каждый отдельный вывод. |
Подробное описание
__construct(callable|resource|string|null $output = null, string $charset = null, int $flags)
Параметры
| 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 | Объект Data |
| callable|resource|string|true|null | $output | Вызываемый объект для вывода на строку, открытый поток, путь к выводу или true для возвращения дампа |
| array | $extraDisplayOptions |
setColors(bool $colors)
Включает/выключает цветной вывод.
Параметры
| bool | $colors |
setMaxStringWidth(int $maxStringWidth)
Устанавливает максимальное количество символов на строку для выводимых строк.
Параметры
| int | $maxStringWidth |
setStyles(array $styles)
Настраивает стили.
Параметры
| array | $styles | Карта имен стилей к определениям стилей |
dumpScalar(Cursor $cursor, string $type, scalar $value)
Выводит скалярное значение.
Параметры
| Cursor | $cursor | Позиция курсора в дампе |
| string | $type | Тип PHP значения, которое выводится |
| scalar | $value | Скалярное значение, которое выводится |
dumpString(Cursor $cursor, string $str, bool $bin, int $cut)
Выводит строку.
Параметры
| Cursor | $cursor | Позиция курсора в дампе |
| string | $str | Выводимая строка |
| bool | $bin | Является ли $str кодированной UTF-8 или двоичной |
| int | $cut | Количество символов, на которое $str была усечена |
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 | Количество элементов, на которое хеш был усечен |
setDisplayOptions(array $displayOptions)
Настраивает параметры отображения.
Параметры
| array | $displayOptions | Карта параметров отображения для настройки поведения |
setDumpHeader(string $header)
Устанавливает HTML заголовок, который будет выведен один раз в потоке вывода.
Параметры
| string | $header | HTML строка |
setDumpBoundaries(string $prefix, string $suffix)
Устанавливает HTML префикс и суффикс, которые будут обрамлять каждый отдельный дамп.
Параметры
| string | $prefix | Предварительная HTML строка |
| string | $suffix | Присоединяемая HTML строка |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.2/Symfony/Component/VarDumper/Dumper/HtmlDumper.html