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) Устанавливает 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, если уровень подробности установлен в VERBOSITYVERYVERBOSE, иначе 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, используемый для ошибок.
Параметры
| OutputInterface | $error |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.1/Symfony/Component/Console/Output/ConsoleOutput.html