OutputInterface
интерфейс 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() Возвращает значение, указывающее, установлен ли тихий режим (-q). | |
| bool | isVerbose() Возвращает значение, указывающее, установлен ли подробный режим (-v). | |
| bool | isVeryVerbose() Возвращает значение, указывающее, установлен ли очень подробный режим (-vv). | |
| bool | isDebug() Возвращает значение, указывающее, установлен ли отладочный режим (-vvv). | |
| 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()
Возвращает значение, указывающее, установлен ли тихий режим (-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 |
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.0/Symfony/Component/Console/Output/OutputInterface.html
