OutputStyle
абстрактный класс OutputStyle реализует OutputInterface, StyleInterface
Декорирует вывод, добавляя вспомогательные функции форматирования консоли.
Методы
| __construct(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) Устанавливает уровень подробности вывода. | ||
| int | getVerbosity() Получает текущий уровень подробности вывода. | |
| setDecorated(bool $decorated) Устанавливает флаг форматирования. | ||
| bool | isDecorated() Получает флаг форматирования. | |
| setFormatter(OutputFormatterInterface $formatter) | ||
| OutputFormatterInterface | getFormatter() Возвращает текущую инстанцию форматировщика вывода. | |
| bool | isQuiet() Возвращает значение, указывающее, что уровень подробности — «тихий» (-q). | |
| bool | isVerbose() Возвращает значение, указывающее, что уровень подробности — «подробный» (-v). | |
| bool | isVeryVerbose() Возвращает значение, указывающее, что уровень подробности — «очень подробный» (-vv). | |
| bool | isDebug() Возвращает значение, указывающее, что уровень подробности — «отладочный» (-vvv). | |
| getErrorOutput() |
Подробности
__construct(OutputInterface $output)
Параметры
| 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()
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/Console/Style/OutputStyle.html