ConsoleOutput
class ConsoleOutput extends StreamOutput implements ConsoleOutputInterface
ConsoleOutput — это стандартный класс для вывода в консоли. Он использует STDOUT.
Этот класс является удобной обёрткой вокруг StreamOutput.
$output = new ConsoleOutput();
Это эквивалентно:
$output = new StreamOutput(fopen('php://stdout', '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 |
| isQuiet() {@inheritdoc} | из Output | |
| isVerbose() {@inheritdoc} | из Output | |
| isVeryVerbose() {@inheritdoc} | из Output | |
| isDebug() {@inheritdoc} | из Output | |
| writeln(string|array $messages, int $type = self::OUTPUT_NORMAL) Выводит сообщение в вывод и добавляет перевод строки в конце. | из Output | |
| write(string|array $messages, bool $newline = false, int $type = 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) |
isQuiet()
{@inheritdoc}
isVerbose()
{@inheritdoc}
isVeryVerbose()
{@inheritdoc}
isDebug()
{@inheritdoc}
writeln(string|array $messages, int $type = self::OUTPUT_NORMAL)
Выводит сообщение в вывод и добавляет перевод строки в конце.
Параметры
| string|array | $messages | Сообщение в виде массива строк или одной строки |
| int | $type | Тип вывода (одна из констант OUTPUT) |
Исключения
| InvalidArgumentException | При указании неизвестного типа вывода |
write(string|array $messages, bool $newline = false, int $type = self::OUTPUT_NORMAL)
Выводит сообщение в вывод.
Параметры
| string|array | $messages | Сообщение в виде массива строк или одной строки |
| bool | $newline | Добавить ли перевод строки |
| int | $type | Тип вывода (одна из констант OUTPUT) |
Исключения
| InvalidArgumentException | При указании неизвестного типа вывода |
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/2.7/Symfony/Component/Console/Output/ConsoleOutput.html
