StreamOutput
class StreamOutput extends Output
StreamOutput записывает вывод в заданный поток.
Использование:
$output = new StreamOutput(fopen('php://stdout', 'w'));
Так как StreamOutput можно использовать любой поток, вы также можете использовать файл:
$output = new StreamOutput(fopen('/path/to/output.log', 'a', false));
Методы
| __construct(resource $stream, int $verbosity = self::VERBOSITY_NORMAL, bool $decorated = null, OutputFormatterInterface $formatter = null) | ||
| setFormatter(OutputFormatterInterface $formatter) Устанавливает форматер вывода. | from Output | |
| OutputFormatterInterface | getFormatter() Возвращает текущую инстанцию форматера вывода. | from Output |
| setDecorated(bool $decorated) Устанавливает флаг форматирования. | from Output | |
| bool | isDecorated() Возвращает флаг форматирования. | from Output |
| setVerbosity(int $level) Устанавливает уровень подробности вывода. | from Output | |
| int | getVerbosity() Возвращает текущий уровень подробности вывода. | from Output |
| isQuiet() {@inheritdoc} | from Output | |
| isVerbose() {@inheritdoc} | from Output | |
| isVeryVerbose() {@inheritdoc} | from Output | |
| isDebug() {@inheritdoc} | from Output | |
| writeln(string|array $messages, int $type = self::OUTPUT_NORMAL) Записывает сообщение в вывод и добавляет перевод строки в конце. | from Output | |
| write(string|array $messages, bool $newline = false, int $type = self::OUTPUT_NORMAL) Записывает сообщение в вывод. | from Output | |
| resource | getStream() Возвращает поток, присоединенный к этому экземпляру StreamOutput. |
Детали
__construct(resource $stream, int $verbosity = self::VERBOSITY_NORMAL, bool $decorated = null, OutputFormatterInterface $formatter = null)
Параметры
| resource | $stream | Поток |
| int | $verbosity | Уровень подробности (одна из констант VERBOSITY в OutputInterface) |
| bool | $decorated | Форматировать ли сообщения |
| OutputFormatterInterface | $formatter | Инстанция форматера вывода (null, чтобы использовать стандартный OutputFormatter) |
Исключения
| InvalidArgumentException | Если первый аргумент не является действительным потоком |
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 | Поток |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.7/Symfony/Component/Console/Output/StreamOutput.html
