SymfonyStyle
class SymfonyStyle extends 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) Устанавливает уровень подробности вывода. | from OutputStyle | |
| int | getVerbosity() Получает текущий уровень подробности вывода. | from OutputStyle |
| setDecorated(bool $decorated) Устанавливает флаг форматирования. | from OutputStyle | |
| bool | isDecorated() Получает флаг форматирования. | from OutputStyle |
| setFormatter(OutputFormatterInterface $formatter) Устанавливает форматировщик вывода. | from OutputStyle | |
| OutputFormatterInterface | getFormatter() Возвращает текущую инстанцию форматировщика вывода. | from OutputStyle |
| block(string|array $messages, string|null $type = null, string|null $style = null, string $prefix = ' ', bool $padding = false) Форматирует сообщение в виде блока текста. | ||
| title(string $message) Форматирует заголовок команды. | ||
| section(string $message) Форматирует заголовок раздела. | ||
| listing(array $elements) Форматирует список. | ||
| text(string|array $message) Форматирует информационный текст. | ||
| comment($message) {@inheritdoc} | ||
| 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) |
Подробности
__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 |
block(string|array $messages, string|null $type = null, string|null $style = null, string $prefix = ' ', bool $padding = false)
Форматирует сообщение как блок текста.
Параметры
| string|array | $messages | Сообщение для записи в блоке |
| string|null | $type | Тип блока (добавляется в [] в первой строке) |
| string|null | $style | Стиль, применяемый к всему блоку |
| string | $prefix | Префикс для блока |
| bool | $padding | Добавлять ли вертикальное отступы |
title(string $message)
Форматирует заголовок команды.
Параметры
| string | $message |
section(string $message)
Форматирует заголовок раздела.
Параметры
| string | $message |
listing(array $elements)
Форматирует список.
Параметры
| array | $elements |
text(string|array $message)
Форматирует информационный текст.
Параметры
| string|array | $message |
comment($message)
{@inheritdoc}
Параметры
| $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 |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Component/Console/Style/SymfonyStyle.html