StyleInterface
интерфейс StyleInterface
Помощники форматирования вывода.
Методы
| title(string $message) Форматирует заголовок команды. | ||
| section(string $message) Форматирует заголовок раздела. | ||
| listing(array $elements) Форматирует список. | ||
| text(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) Задает вопрос с выбором. | |
| newLine(int $count = 1) Добавляет перенос(ы) строки. | ||
| progressStart(int $max) Начинает вывод прогресса. | ||
| progressAdvance(int $step = 1) Продвигает вывод прогресса на X шагов. | ||
| progressFinish() Завершает вывод прогресса. |
Подробности
title(string $message)
Форматирует заголовок команды.
Параметры
| string | $message |
section(string $message)
Форматирует заголовок раздела.
Параметры
| string | $message |
listing(array $elements)
Форматирует список.
Параметры
| array | $elements |
text(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 |
newLine(int $count = 1)
Добавляет перенос(ы) строки.
Параметры
| int | $count | Количество переносов строки |
progressStart(int $max)
Начинает вывод прогресса.
Параметры
| int | $max | Максимальное количество шагов (0, если неизвестно) |
progressAdvance(int $step = 1)
Продвигает вывод прогресса на X шагов.
Параметры
| int | $step | Количество шагов для продвижения |
progressFinish()
Завершает вывод прогресса.
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Component/Console/Style/StyleInterface.html
