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 | |
| ресурс | getStream() Получает поток, присоединённый к этому экземпляру StreamOutput. | из StreamOutput |
| OutputInterface | getErrorOutput() Получает OutputInterface для ошибок. | |
| setErrorOutput(OutputInterface $error) Устанавливает OutputInterface, используемый для ошибок. |
Подробности
__construct(int $verbosity = self::VERBOSITY_NORMAL, bool $decorated = null, OutputFormatterInterface $formatter = null)
Конструктор.
Параметры
| int | $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_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 |
ресурс getStream()
Получает поток, присоединённый к этому экземпляру StreamOutput.
Возвращаемое значение
| ресурс | Ресурс потока |
OutputInterface getErrorOutput()
Получает OutputInterface для ошибок.
Возвращаемое значение
| OutputInterface |
setErrorOutput(OutputInterface $error)
Устанавливает OutputInterface, используемый для ошибок.
Параметры
| OutputInterface | $error |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.2/Symfony/Component/Console/Output/ConsoleOutput.html