ConsoleOutputInterface
interface ConsoleOutputInterface implements OutputInterface
ConsoleOutputInterface — это интерфейс, реализуемый классом ConsoleOutput.
Он добавляет информацию об потоке вывода stderr.
Методы
| write(string|array $messages, Boolean $newline = false, integer $type = self::OUTPUT_NORMAL) Выводит сообщение в выходной поток. | from OutputInterface | |
| writeln(string|array $messages, integer $type = self::OUTPUT_NORMAL) Выводит сообщение в выходной поток и добавляет перевод строки в конце. | from OutputInterface | |
| setVerbosity(integer $level) Устанавливает уровень подробности вывода. | from OutputInterface | |
| integer | getVerbosity() Получает текущий уровень подробности вывода. | from OutputInterface |
| setDecorated(Boolean $decorated) Устанавливает флаг форматирования. | from OutputInterface | |
| Boolean | isDecorated() Получает флаг форматирования. | from OutputInterface |
| setFormatter(OutputFormatterInterface $formatter) Устанавливает форматировщик вывода. | from OutputInterface | |
| OutputFormatterInterface | getFormatter() Возвращает текущую инстанцию форматировщика вывода. | from OutputInterface |
| OutputInterface | getErrorOutput() Получает OutputInterface для ошибок. | |
| setErrorOutput(OutputInterface $error) Устанавливает OutputInterface, используемый для ошибок. |
Подробности
write(string|array $messages, Boolean $newline = false, integer $type = self::OUTPUT_NORMAL)
Выводит сообщение в выходной поток.
Параметры
| string|array | $messages | Сообщение в виде массива строк или одной строки |
| Boolean | $newline | Добавлять ли перевод строки |
| integer | $type | Тип вывода (одно из констант OUTPUT) |
Исключения
| InvalidArgumentException | При указании неизвестного типа вывода |
writeln(string|array $messages, integer $type = self::OUTPUT_NORMAL)
Выводит сообщение в выходной поток и добавляет перевод строки в конце.
Параметры
| string|array | $messages | Сообщение в виде массива строк или одной строки |
| integer | $type | Тип вывода (одно из констант OUTPUT) |
Исключения
| InvalidArgumentException | При указании неизвестного типа вывода |
setVerbosity(integer $level)
Устанавливает уровень подробности вывода.
Параметры
| integer | $level | Уровень подробности (одно из констант VERBOSITY) |
integer getVerbosity()
Получает текущий уровень подробности вывода.
Возвращаемое значение
| integer | Текущий уровень подробности (одно из констант VERBOSITY) |
setDecorated(Boolean $decorated)
Устанавливает флаг форматирования.
Параметры
| Boolean | $decorated | Форматировать ли сообщения |
Boolean isDecorated()
Получает флаг форматирования.
Возвращаемое значение
| Boolean | true, если сообщения будут форматированы, иначе false |
setFormatter(OutputFormatterInterface $formatter)
Устанавливает форматировщик вывода.
Параметры
| OutputFormatterInterface | $formatter |
OutputFormatterInterface getFormatter()
Возвращает текущую инстанцию форматировщика вывода.
Возвращаемое значение
| OutputFormatterInterface |
OutputInterface getErrorOutput()
Получает OutputInterface для ошибок.
Возвращаемое значение
| OutputInterface |
setErrorOutput(OutputInterface $error)
Устанавливает OutputInterface, используемый для ошибок.
Параметры
| OutputInterface | $error |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Component/Console/Output/ConsoleOutputInterface.html