SymfonyStyle
класс SymfonyStyle расширяет OutputStyle
Вспомогательные методы форматирования вывода для руководства Symfony Style.
Константы
| MAX_LINE_LENGTH |
Методы
| __construct(InputInterface $input, OutputInterface $output) | ||
| newLine(int $count = 1) Добавляет новую строку(и). | ||
| ProgressBar | createProgressBar(int $max) | |
| write(string|array $messages, bool $newline = false, $type = self::OUTPUT_NORMAL) Выводит сообщение в вывод. | ||
| writeln(string|array $messages, $type = self::OUTPUT_NORMAL) Выводит сообщение в вывод и добавляет перевод строки в конце. | ||
| setVerbosity(int $level) Устанавливает уровень подробности вывода. | из OutputStyle | |
| int | getVerbosity() Возвращает текущий уровень подробности вывода. | из OutputStyle |
| setDecorated(bool $decorated) Устанавливает флаг форматирования. | из OutputStyle | |
| bool | isDecorated() Возвращает флаг форматирования. | из OutputStyle |
| setFormatter(OutputFormatterInterface $formatter) | из OutputStyle | |
| OutputFormatterInterface | getFormatter() Возвращает текущую сущность форматировщика вывода. | из OutputStyle |
| bool | isQuiet() Возвращает, является ли уровень подробности тихим (-q). | из OutputStyle |
| bool | isVerbose() Возвращает, является ли уровень подробности подробным (-v). | из OutputStyle |
| bool | isVeryVerbose() Возвращает, является ли уровень подробности очень подробным (-vv). | из OutputStyle |
| bool | isDebug() Возвращает, является ли уровень подробности отладочным (-vvv). | из OutputStyle |
| block(string|array $messages, string|null $type = null, string|null $style = null, string $prefix = ' ', bool $padding = false, bool $escape = true) Форматирует сообщение как блок текста. | ||
| title(string $message) Форматирует заголовок команды. | ||
| section(string $message) Форматирует заголовок раздела. | ||
| listing(array $elements) Форматирует список. | ||
| text(string|array $message) Форматирует информационный текст. | ||
| comment(string|array $message) Форматирует комментарий к команде. | ||
| success(string|array $message) Форматирует индикатор успешного результата. | ||
| error(string|array $message) Форматирует индикатор ошибки. | ||
| warning(string|array $message) Форматирует индикатор предупреждения. | ||
| note(string|array $message) Форматирует примечание. | ||
| caution(string|array $message) Форматирует предупреждение. | ||
| table(array $headers, array $rows) Форматирует таблицу. | ||
| string | ask(string $question, string|null $default = null, callable|null $validator = null) Задает вопрос. | |
| string | askHidden(string $question, callable|null $validator = null) Задает вопрос, скрывая ввод пользователя. | |
| bool | confirm(string $question, bool $default = true) Запрашивает подтверждение. | |
| string | choice(string $question, array $choices, string|int|null $default = null) Задает вопрос с выбором. | |
| progressStart(int $max) Инициализирует вывод прогресса. | ||
| progressAdvance(int $step = 1) Передвигает вывод прогресса на X шагов. | ||
| progressFinish() Завершает вывод прогресса. | ||
| string | askQuestion(Question $question) | |
| SymfonyStyle | getErrorStyle() Возвращает новый экземпляр, использующий stderr, если доступен. |
Подробное описание
__construct(InputInterface $input, OutputInterface $output)
Параметры
| InputInterface | $input | |
| OutputInterface | $output |
newLine(int $count = 1)
Добавить переводы строки.
Параметры
| int | $count | Количество переводов строки |
ProgressBar createProgressBar(int $max)
Параметры
| int | $max |
Возвращаемое значение
| ProgressBar |
write(string|array $messages, bool $newline = false, $type = self::OUTPUT_NORMAL)
Выводит сообщение в вывод.
Параметры
| string|array | $messages | Сообщение в виде массива строк или одной строки |
| bool | $newline | Добавить перевод строки |
| $type |
writeln(string|array $messages, $type = self::OUTPUT_NORMAL)
Выводит сообщение в вывод и добавляет перевод строки в конце.
Параметры
| string|array | $messages | Сообщение в виде массива строк или одной строки |
| $type |
setVerbosity(int $level)
Устанавливает уровень подробности вывода.
Параметры
| int | $level | Уровень подробности (один из констант VERBOSITY) |
int getVerbosity()
Возвращает текущий уровень подробности вывода.
Возвращаемое значение
| int | Текущий уровень подробности (один из констант VERBOSITY) |
setDecorated(bool $decorated)
Устанавливает флаг форматирования.
Параметры
| bool | $decorated | Форматировать ли сообщения |
bool isDecorated()
Возвращает флаг форматирования.
Возвращаемое значение
| bool | true, если вывод будет форматировать сообщения, иначе false |
setFormatter(OutputFormatterInterface $formatter)
Параметры
| OutputFormatterInterface | $formatter |
OutputFormatterInterface getFormatter()
Возвращает текущую инстанцию форматировщика вывода.
Возвращаемое значение
| OutputFormatterInterface |
bool isQuiet()
Возвращает, установлен ли уровень подробности "тихий" (-q).
Возвращаемое значение
| bool | true, если уровень подробности установлен в VERBOSITY_QUIET, иначе false |
bool isVerbose()
Возвращает, установлен ли уровень подробности "подробный" (-v).
Возвращаемое значение
| bool | true, если уровень подробности установлен в VERBOSITY_VERBOSE, иначе false |
bool isVeryVerbose()
Возвращает, установлен ли уровень подробности "очень подробный" (-vv).
Возвращаемое значение
| bool | true, если уровень подробности установлен в VERBOSITY_VERYVERBOSE, иначе false |
bool isDebug()
Возвращает, установлен ли уровень подробности "отладки" (-vvv).
Возвращаемое значение
| bool | true, если уровень подробности установлен в VERBOSITY_DEBUG, иначе false |
block(string|array $messages, string|null $type = null, string|null $style = null, string $prefix = ' ', bool $padding = false, bool $escape = true)
Форматирует сообщение в виде блока текста.
Параметры
| string|array | $messages | Сообщение для записи в блоке |
| string|null | $type | Тип блока (добавляется в [] в первой строке) |
| string|null | $style | Стиль, применяемый ко всему блоку |
| string | $prefix | Префикс для блока |
| bool | $padding | Добавить ли вертикальные отступы |
| bool | $escape | Необходимо ли экранировать сообщение |
title(string $message)
Форматирует заголовок команды.
Параметры
| string | $message |
section(string $message)
Форматирует заголовок раздела.
Параметры
| string | $message |
listing(array $elements)
Форматирует список.
Параметры
| array | $elements |
text(string|array $message)
Форматирует информационный текст.
Параметры
| string|array | $message |
comment(string|array $message)
Форматирует комментарий команды.
Параметры
| string|array | $message |
success(string|array $message)
Форматирует результат успешного выполнения.
Параметры
| string|array | $message |
error(string|array $message)
Форматирует ошибку.
Параметры
| string|array | $message |
warning(string|array $message)
Форматирует предупреждение.
Параметры
| string|array | $message |
note(string|array $message)
Форматирует примечание.
Параметры
| string|array | $message |
caution(string|array $message)
Форматирует предупреждение.
Параметры
| string|array | $message |
table(array $headers, array $rows)
Форматирует таблицу.
Параметры
| array | $headers | |
| array | $rows |
string ask(string $question, string|null $default = null, callable|null $validator = null)
Задает вопрос.
Параметры
| string | $question | |
| string|null | $default | |
| callable|null | $validator |
Возвращаемое значение
| string |
string askHidden(string $question, callable|null $validator = null)
Задает вопрос, скрывая ввод пользователя.
Параметры
| string | $question | |
| callable|null | $validator |
Возвращаемое значение
| string |
bool confirm(string $question, bool $default = true)
Запрашивает подтверждение.
Параметры
| string | $question | |
| bool | $default |
Возвращаемое значение
| bool |
string choice(string $question, array $choices, string|int|null $default = null)
Задает вопрос с выбором.
Параметры
| string | $question | |
| array | $choices | |
| string|int|null | $default |
Возвращаемое значение
| string |
progressStart(int $max)
Начинает вывод прогресса.
Параметры
| int | $max | Максимальное количество шагов (0, если неизвестно) |
progressAdvance(int $step = 1)
Перемещает вывод прогресса на X шагов.
Параметры
| int | $step | Количество шагов для продвижения |
progressFinish()
Завершает вывод прогресса.
string askQuestion(Question $question)
Параметры
| Question | $question |
Возвращаемое значение
| string |
SymfonyStyle getErrorStyle()
Возвращает новый экземпляр, использующий stderr, если доступен.
Возвращаемое значение
| SymfonyStyle |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.4/Symfony/Component/Console/Style/SymfonyStyle.html