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