Spec-Zone.ru › Symfony 4.1

SymfonyStyle

класс SymfonyStyle расширяет OutputStyle

Справочные методы для форматирования вывода в стиле Symfony.

Константы

MAX_LINE_LENGTH

Методы

__construct(InputInterface $input, OutputInterface $output)
newLine(int $count = 1)

Добавить новую строку(и).

ProgressBar createProgressBar(int $max = 0)
write(string|iterable $messages, bool $newline = false, $type = self::OUTPUT_NORMAL)

Выводит сообщение в выходной поток.

writeln(string|iterable $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
getErrorOutput() из 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)

Форматирует таблицу.

mixed ask(string $question, string|null $default = null, callable|null $validator = null)

Задает вопрос.

mixed askHidden(string $question, callable|null $validator = null)

Задает вопрос, скрывая ввод пользователя.

bool confirm(string $question, bool $default = true)

Запрашивает подтверждение.

mixed choice(string $question, array $choices, string|int|null $default = null)

Задает вопрос с выбором.

progressStart(int $max = 0)

Начинает вывод прогресса.

progressAdvance(int $step = 1)

Передвигает вывод прогресса на X шагов.

progressFinish()

Завершает вывод прогресса.

mixed 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 = 0)

Параметры

int $max

Возвращаемое значение

ProgressBar

write(string|iterable $messages, bool $newline = false, $type = self::OUTPUT_NORMAL)

Выводит сообщение в выходной поток.

Параметры

string|iterable $messages Сообщение как итерируемый набор строк или одна строка
bool $newline Добавлять ли перевод строки
$type

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

Выводит сообщение в выходной поток и добавляет перевод строки в конце.

Параметры

string|iterable $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_VERY_VERBOSE, в противном случае false

bool isDebug()

Возвращает, установлен ли режим отладки (-vvv).

Возвращаемое значение

bool true, если уровень подробности установлен в VERBOSITY_DEBUG, в противном случае false

protected getErrorOutput()

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

mixed ask(string $question, string|null $default = null, callable|null $validator = null)

Задает вопрос.

Параметры

string $question
string|null $default
callable|null $validator

Возвращаемое значение

mixed

mixed askHidden(string $question, callable|null $validator = null)

Задает вопрос с скрытым вводом пользователя.

Параметры

string $question
callable|null $validator

Возвращаемое значение

mixed

bool confirm(string $question, bool $default = true)

Задает вопрос для подтверждения.

Параметры

string $question
bool $default

Возвращаемое значение

bool

mixed choice(string $question, array $choices, string|int|null $default = null)

Задает вопрос выбора.

Параметры

string $question
array $choices
string|int|null $default

Возвращаемое значение

mixed

progressStart(int $max = 0)

Начинает вывод прогресса.

Параметры

int $max Максимальное количество шагов (0, если неизвестно)

progressAdvance(int $step = 1)

Перемещает вывод прогресса на X шагов.

Параметры

int $step Число шагов для продвижения

progressFinish()

Завершает вывод прогресса.

mixed askQuestion(Question $question)

Параметры

Question $question

Значение возврата

mixed

SymfonyStyle getErrorStyle()

Возвращает новый экземпляр, использующий stderr, если доступен.

Значение возврата

SymfonyStyle

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/Console/Style/SymfonyStyle.html

Spec-Zone.ru

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