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) Устанавливает форматировщик вывода. | из Output | |
| OutputFormatterInterface | getFormatter() Возвращает текущую инстанцию форматировщика вывода. | из Output |
| setDecorated(bool $decorated) Устанавливает флаг форматирования. | из Output | |
| bool | isDecorated() Получает флаг форматирования. | из Output |
| setVerbosity(int $level) Устанавливает уровень подробности вывода. | из Output | |
| 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. |
Детали
__construct(resource $stream, int $verbosity = self::VERBOSITY_NORMAL, bool $decorated = null, OutputFormatterInterface $formatter = null)
Конструктор.
Параметры
| ресурс | $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) |
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 |
resource getStream()
Получает поток, присоединенный к этому экземпляру StreamOutput.
Возвращаемое значение
| ресурс | Ресурс потока |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.2/Symfony/Component/Console/Output/StreamOutput.html
