ConsoleOutputInterface
интерфейс ConsoleOutputInterface реализует OutputInterface
ConsoleOutputInterface — это интерфейс, реализуемый классом ConsoleOutput.
Он добавляет информацию об потоках stderr и секции вывода.
Методы
| write(string|iterable $messages, bool $newline = false, int $options = 0) Записывает сообщение в вывод. | из OutputInterface | |
| writeln(string|iterable $messages, int $options = 0) Записывает сообщение в вывод и добавляет перевод строки в конце. | из OutputInterface | |
| setVerbosity(int $level) Устанавливает уровень подробности вывода. | из OutputInterface | |
| int | getVerbosity() Получает текущий уровень подробности вывода. | из OutputInterface |
| bool | isQuiet() Возвращает значение, указывающее, является ли уровень подробности тихим (-q). | из OutputInterface |
| bool | isVerbose() Возвращает значение, указывающее, является ли уровень подробности подробным (-v). | из OutputInterface |
| bool | isVeryVerbose() Возвращает значение, указывающее, является ли уровень подробности очень подробным (-vv). | из OutputInterface |
| bool | isDebug() Возвращает значение, указывающее, является ли уровень подробности отладочным (-vvv). | из OutputInterface |
| setDecorated(bool $decorated) Устанавливает флаг форматирования. | из OutputInterface | |
| bool | isDecorated() Получает флаг форматирования. | из OutputInterface |
| setFormatter(OutputFormatterInterface $formatter) | из OutputInterface | |
| OutputFormatterInterface | getFormatter() Возвращает текущую реализацию форматировщика вывода. | из OutputInterface |
| OutputInterface | getErrorOutput() Получает OutputInterface для ошибок. | |
| setErrorOutput(OutputInterface $error) | ||
| ConsoleSectionOutput | section() Создаёт новую секцию вывода |
Подробности
write(string|iterable $messages, bool $newline = false, int $options = 0)
Записывает сообщение в вывод.
Параметры
| string|iterable | $messages | Сообщение как итерируемый объект строк или одна строка |
| bool | $newline | Добавить ли перевод строки |
| int | $options | Побитовая маска опций (одна из констант OUTPUT или VERBOSITY), 0 считается эквивалентным self::OUTPUT_NORMAL | self::VERBOSITY_NORMAL |
writeln(string|iterable $messages, int $options = 0)
Записывает сообщение в вывод и добавляет перевод строки в конце.
Параметры
| string|iterable | $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 |
OutputInterface getErrorOutput()
Получает OutputInterface для ошибок.
Возвращаемое значение
| OutputInterface |
setErrorOutput(OutputInterface $error)
Параметры
| OutputInterface | $error |
ConsoleSectionOutput section()
Создаёт новую секцию вывода
Возвращаемое значение
| ConsoleSectionOutput |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/Console/Output/ConsoleOutputInterface.html