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|null $verbosity = self::VERBOSITY_NORMAL, bool $decorated = null, OutputFormatterInterface $formatter = null) | ||
| setFormatter(OutputFormatterInterface $formatter) | ||
| OutputFormatterInterface | getFormatter() Возвращает текущий экземпляр форматировщика вывода. | from Output |
| setDecorated(bool $decorated) Устанавливает флаг форматирования. | ||
| bool | isDecorated() Возвращает флаг форматирования. | from Output |
| setVerbosity(int $level) Устанавливает уровень подробности вывода. | ||
| int | getVerbosity() Возвращает текущий уровень подробности вывода. | from Output |
| bool | isQuiet() Возвращает true, если уровень подробности — «тихий» (-q). | from Output |
| bool | isVerbose() Возвращает true, если уровень подробности — «подробный» (-v). | from Output |
| bool | isVeryVerbose() Возвращает true, если уровень подробности — «очень подробный» (-vv). | from Output |
| bool | isDebug() Возвращает true, если уровень подробности — «отладочный» (-vvv). | from Output |
| writeln(string|iterable $messages, int $options = self::OUTPUT_NORMAL) Выводит сообщение в вывод с добавлением новой строки в конце. | from Output | |
| write(string|iterable $messages, bool $newline = false, int $options = self::OUTPUT_NORMAL) Выводит сообщение в вывод. | from Output | |
| doWrite(string $message, bool $newline) Выводит сообщение в вывод. | from StreamOutput | |
| resource | getStream() Возвращает поток, прикрепленный к этому экземпляру StreamOutput. | from StreamOutput |
| bool | hasColorSupport() Возвращает true, если поток поддерживает форматирование цветом. | from StreamOutput |
| ConsoleSectionOutput | section() Создаёт новый раздел вывода. | |
| OutputInterface | getErrorOutput() Возвращает OutputInterface для сообщений об ошибках. | |
| setErrorOutput(OutputInterface $error) | ||
| bool | hasStdoutSupport() Возвращает true, если текущая среда поддерживает вывод в STDOUT. | |
| bool | hasStderrSupport() Возвращает true, если текущая среда поддерживает вывод в STDERR. |
Подробности
__construct(int|null $verbosity = self::VERBOSITY_NORMAL, bool $decorated = null, OutputFormatterInterface $formatter = null)
Параметры
| int|null | $verbosity | Уровень подробности (одно из значений констант VERBOSITY в OutputInterface) |
| bool | $decorated | Применять ли форматирование к сообщениям |
| OutputFormatterInterface | $formatter | Экземпляр форматировщика вывода (null для использования по умолчанию OutputFormatter) |
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_VERY_VERBOSE, иначе false |
bool isDebug()
Возвращает, является ли уровень подробности отладочным (-vvv).
Значение возврата
| bool | true, если уровень подробности установлен в VERBOSITY_DEBUG, иначе false |
writeln(string|iterable $messages, int $options = self::OUTPUT_NORMAL)
Выводит сообщение в вывод с добавлением новой строки в конце.
Параметры
| string|iterable | $messages | Сообщение как итерируемый объект строк или одна строка |
| int | $options | Побитовая маска опций (одно из значений констант OUTPUT или VERBOSITY), 0 считается эквивалентным self::OUTPUT_NORMAL | self::VERBOSITY_NORMAL |
write(string|iterable $messages, bool $newline = false, int $options = self::OUTPUT_NORMAL)
Выводит сообщение в вывод.
Параметры
| string|iterable | $messages | Сообщение как итерируемый объект строк или одна строка |
| bool | $newline | Добавлять ли новую строку |
| int | $options | Побитовая маска опций (одно из значений констант OUTPUT или VERBOSITY), 0 считается эквивалентным self::OUTPUT_NORMAL | self::VERBOSITY_NORMAL |
protected doWrite(string $message, bool $newline)
Выводит сообщение в вывод.
Параметры
| string | $message | Сообщение для вывода |
| bool | $newline | Добавлять ли новую строку |
resource getStream()
Возвращает поток, присоединённый к этому экземпляру StreamOutput.
Значение возврата
| resource | Ресурс потока |
protected bool hasColorSupport()
Возвращает true, если поток поддерживает цвет.
Цвет отключается, если он не поддерживается потоком:
Это сложно на Windows, потому что Cygwin, Msys2 и т. д. эмулируют псевдотерминалы через именованные каналы, поэтому мы можем проверить только среду.
Ссылка: Composer\XdebugHandler\Process::supportsColor https://github.com/composer/xdebug-handler
Значение возврата
| bool | true, если поток поддерживает цвет, иначе false |
ConsoleSectionOutput section()
Создаёт новый раздел вывода.
Значение возврата
| ConsoleSectionOutput |
OutputInterface getErrorOutput()
Возвращает OutputInterface для ошибок.
Значение возврата
| OutputInterface |
setErrorOutput(OutputInterface $error)
Параметры
| OutputInterface | $error |
protected bool hasStdoutSupport()
Возвращает true, если текущая среда поддерживает запись консольного вывода в STDOUT.
Значение возврата
| bool |
protected bool hasStderrSupport()
Возвращает true, если текущая среда поддерживает запись консольного вывода в STDERR.
Значение возврата
| bool |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/Console/Output/ConsoleOutput.html