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