Spec-Zone.ru › Symfony 2.7

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, int $type = self::OUTPUT_NORMAL)

Записывает сообщение в вывод.

writeln(string|array $messages, int $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
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)

Форматирует информационный текст.

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, int $type = self::OUTPUT_NORMAL)

Выводит сообщение в вывод.

Параметры

string|array $messages Сообщение в виде массива строк или одной строки
bool $newline Добавить ли новую строку
int $type Тип вывода (один из констант OUTPUT)

Исключения

InvalidArgumentException При задании неизвестного типа вывода

writeln(string|array $messages, int $type = self::OUTPUT_NORMAL)

Выводит сообщение в вывод и добавляет новую строку в конце.

Параметры

string|array $messages Сообщение в виде массива строк или одной строки
int $type Тип вывода (один из констант OUTPUT)

Исключения

InvalidArgumentException При задании неизвестного типа вывода

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

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/2.7/Symfony/Component/Console/Style/SymfonyStyle.html

Spec-Zone.ru

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