OutputInterface
interface OutputInterface
OutputInterface — это интерфейс, реализуемый всеми классами Output.
Постоянные значения
| VERBOSITY_QUIET | |
| VERBOSITY_NORMAL | |
| VERBOSITY_VERBOSE | |
| VERBOSITY_VERY_VERBOSE | |
| VERBOSITY_DEBUG | |
| OUTPUT_NORMAL | |
| OUTPUT_RAW | |
| OUTPUT_PLAIN |
Методы
| write(string|array $messages, bool $newline = false, int $options) Выводит сообщение в вывод. | ||
| writeln(string|array $messages, int $options) Выводит сообщение в вывод и добавляет перевод строки в конце. | ||
| setVerbosity(int $level) Устанавливает уровень подробности вывода. | ||
| int | getVerbosity() Возвращает текущий уровень подробности вывода. | |
| bool | isQuiet() Возвращает значение true, если уровень подробности тихий (-q), иначе false. | |
| bool | isVerbose() Возвращает значение true, если уровень подробности подробный (-v), иначе false. | |
| bool | isVeryVerbose() Возвращает значение true, если уровень подробности очень подробный (-vv), иначе false. | |
| bool | isDebug() Возвращает значение true, если уровень подробности отладочный (-vvv), иначе false. | |
| setDecorated(bool $decorated) Устанавливает флаг форматирования. | ||
| bool | isDecorated() Возвращает значение флага форматирования. | |
| setFormatter(OutputFormatterInterface $formatter) | ||
| OutputFormatterInterface | getFormatter() Возвращает текущий экземпляр форматировщика вывода. |
Подробности
write(string|array $messages, bool $newline = false, int $options)
Выводит сообщение в вывод.
Параметры
| string|array | $messages | Сообщение в виде массива строк или одной строки |
| bool | $newline | Добавить ли перевод строки |
| int | $options | Побитовая маска опций (одна из констант OUTPUT или VERBOSITY), 0 считается эквивалентным self::OUTPUT_NORMAL | self::VERBOSITY_NORMAL |
writeln(string|array $messages, int $options)
Выводит сообщение в вывод и добавляет перевод строки в конце.
Параметры
| string|array | $messages | Сообщение в виде массива строк или одной строки |
| int | $options | Побитовая маска опций (одна из констант OUTPUT или VERBOSITY), 0 считается эквивалентным self::OUTPUT_NORMAL | self::VERBOSITY_NORMAL |
setVerbosity(int $level)
Устанавливает уровень подробности вывода.
Параметры
| int | $level | Уровень подробности (одна из констант VERBOSITY) |
int getVerbosity()
Возвращает текущий уровень подробности вывода.
Возвращаемое значение
| int | Текущий уровень подробности (одна из констант VERBOSITY) |
bool isQuiet()
Возвращает true, если уровень подробности тихий (-q), иначе false.
Возвращаемое значение
| bool | true, если уровень подробности установлен в VERBOSITY_QUIET, иначе false |
bool isVerbose()
Возвращает true, если уровень подробности подробный (-v), иначе false.
Возвращаемое значение
| bool | true, если уровень подробности установлен в VERBOSITY_VERBOSE, иначе false |
bool isVeryVerbose()
Возвращает true, если уровень подробности очень подробный (-vv), иначе false.
Возвращаемое значение
| bool | true, если уровень подробности установлен в VERBOSITY_VERY_VERBOSE, иначе false |
bool isDebug()
Возвращает true, если уровень подробности отладочный (-vvv), иначе false.
Возвращаемое значение
| bool | true, если уровень подробности установлен в VERBOSITY_DEBUG, иначе false |
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/3.3/Symfony/Component/Console/Output/OutputInterface.html
