ConsoleOutput
class ConsoleOutput extends StreamOutput implements ConsoleOutputInterface
ConsoleOutput — это класс по умолчанию для всего вывода в командной строке. Он использует STDOUT и STDERR.
Этот класс — удобная оболочка вокруг StreamOutput для STDOUT и STDERR.
$output = new ConsoleOutput();
Это эквивалентно:
$output = new StreamOutput(fopen('php://stdout', 'w'));
$stdErr = new StreamOutput(fopen('php://stderr', 'w'));
Методы
| __construct(int $verbosity = self::VERBOSITY_NORMAL, bool $decorated = null, OutputFormatterInterface $formatter = null) | ||
| setFormatter(OutputFormatterInterface $formatter) | ||
| OutputFormatterInterface | getFormatter() Возвращает текущую инстанцию форматировщика вывода. | из Output |
| setDecorated(bool $decorated) Устанавливает флаг форматирования. | ||
| bool | isDecorated() Возвращает флаг форматирования. | из Output |
| setVerbosity(int $level) Устанавливает уровень подробности вывода. | ||
| int | getVerbosity() Возвращает текущий уровень подробности вывода. | из Output |
| bool | isQuiet() Возвращает значение, если уровень подробности — «тихий» (-q). | из Output |
| bool | isVerbose() Возвращает значение, если уровень подробности — «подробный» (-v). | из Output |
| bool | isVeryVerbose() Возвращает значение, если уровень подробности — «очень подробный» (-vv). | из Output |
| bool | isDebug() Возвращает значение, если уровень подробности — «отладочный» (-vvv). | из Output |
| writeln(string|array $messages, int $options = self::OUTPUT_NORMAL) Записывает сообщение в вывод и добавляет перевод строки в конце. | из Output | |
| write(string|array $messages, bool $newline = false, int $options = self::OUTPUT_NORMAL) Записывает сообщение в вывод. | из Output | |
| resource | getStream() Возвращает поток, присоединённый к этому экземпляру StreamOutput. | из StreamOutput |
| OutputInterface | getErrorOutput() Возвращает OutputInterface для ошибок. | |
| setErrorOutput(OutputInterface $error) |
Детали
__construct(int $verbosity = self::VERBOSITY_NORMAL, bool $decorated = null, OutputFormatterInterface $formatter = null)
Параметры
| int | $verbosity | Уровень подробности (один из констант VERBOSITY в OutputInterface) |
| bool | $decorated | Выводить ли форматированные сообщения |
| OutputFormatterInterface | $formatter | Инстанция форматировщика вывода (null для использования по умолчанию) |
setFormatter(OutputFormatterInterface $formatter)
Параметры
| OutputFormatterInterface | $formatter |
OutputFormatterInterface getFormatter()
Возвращает текущую инстанцию форматировщика вывода.
Возвращаемое значение
| OutputFormatterInterface |
setDecorated(bool $decorated)
Устанавливает флаг форматирования.
Параметры
| bool | $decorated | Выводить ли форматированные сообщения |
bool isDecorated()
Возвращает флаг форматирования.
Возвращаемое значение
| bool | true, если вывод будет форматировать сообщения, false иначе |
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_VERYVERBOSE, false иначе |
bool isDebug()
Возвращает значение, если уровень подробности — «отладочный» (-vvv).
Возвращаемое значение
| bool | true, если уровень подробности установлен как VERBOSITY_DEBUG, false иначе |
writeln(string|array $messages, int $options = self::OUTPUT_NORMAL)
Записывает сообщение в вывод и добавляет перевод строки в конце.
Параметры
| string|array | $messages | Сообщение в виде массива строк или одной строки |
| int | $options | Маска опций (одна из констант OUTPUT или VERBOSITY), 0 считается эквивалентным self::OUTPUT_NORMAL | self::VERBOSITY_NORMAL |
write(string|array $messages, bool $newline = false, int $options = self::OUTPUT_NORMAL)
Записывает сообщение в вывод.
Параметры
| string|array | $messages | Сообщение в виде массива строк или одной строки |
| bool | $newline | Добавлять ли перевод строки |
| int | $options | Маска опций (одна из констант OUTPUT или VERBOSITY), 0 считается эквивалентным self::OUTPUT_NORMAL | self::VERBOSITY_NORMAL |
resource getStream()
Возвращает поток, присоединённый к этому экземпляру StreamOutput.
Возвращаемое значение
| resource | Ресурс потока |
OutputInterface getErrorOutput()
Возвращает OutputInterface для ошибок.
Возвращаемое значение
| OutputInterface |
setErrorOutput(OutputInterface $error)
Параметры
| OutputInterface | $error |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.3/Symfony/Component/Console/Output/ConsoleOutput.html