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