Spec-Zone.ru › Symfony 4.0

CliDumper

class CliDumper extends AbstractDumper

CliDumper выводит переменные для вывода в консоли.

Постоянные значения

DUMP_LIGHT_ARRAY
DUMP_STRING_LENGTH
DUMP_COMMA_SEPARATOR
DUMP_TRAILING_COMMA

Свойства

static $defaultOutput
static $defaultColors

Методы

__construct(callable|resource|string|null $output = null, string $charset = null, int $flags)
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|true|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, int $flags)

Параметры

callable|resource|string|null $output Вызываемый объект для вывода строки, открытый поток или путь к выводу, по умолчанию static::$defaultOutput
string $charset Кодировка по умолчанию для строк, отличных от UTF-8
int $flags Поле битов из статических констант 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 для возвращения дампа

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 Количество элементов, на которое был урезан хэш

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/VarDumper/Dumper/CliDumper.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API