Spec-Zone.ru › Symfony 4.1

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|null $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()

Возвращает true, если уровень подробности тихий (-q).

из Output
bool isVerbose()

Возвращает true, если уровень подробности подробный (-v).

из Output
bool isVeryVerbose()

Возвращает true, если уровень подробности очень подробный (-vv).

из Output
bool isDebug()

Возвращает true, если уровень подробности отладочный (-vvv).

из Output
writeln(string|iterable $messages, int $options = self::OUTPUT_NORMAL)

Записывает сообщение в вывод и добавляет новую строку в конце.

из Output
write(string|iterable $messages, bool $newline = false, int $options = self::OUTPUT_NORMAL)

Записывает сообщение в вывод.

из Output
doWrite(string $message, bool $newline)

Записывает сообщение в вывод.

resource getStream()

Возвращает поток, присоединенный к этой инстанции StreamOutput.

bool hasColorSupport()

Возвращает true, если поток поддерживает цветовое форматирование.

Подробности

__construct(resource $stream, int|null $verbosity = self::VERBOSITY_NORMAL, bool $decorated = null, OutputFormatterInterface $formatter = null)

Параметры

resource $stream Ресурс потока
int|null $verbosity Уровень подробности (одно из значений констант VERBOSITY в OutputInterface)
bool $decorated Форматировать ли сообщения
OutputFormatterInterface $formatter Инстанция форматизатора вывода (null для использования по умолчанию)

Исключения

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()

Возвращает true, если уровень подробности тихий (-q).

Возвращаемое значение

bool true, если уровень подробности установлен в VERBOSITY_QUIET, иначе false

bool isVerbose()

Возвращает true, если уровень подробности подробный (-v).

Возвращаемое значение

bool true, если уровень подробности установлен в VERBOSITY_VERBOSE, иначе false

bool isVeryVerbose()

Возвращает true, если уровень подробности очень подробный (-vv).

Возвращаемое значение

bool true, если уровень подробности установлен в VERBOSITY_VERY_VERBOSE, иначе false

bool isDebug()

Возвращает true, если уровень подробности отладочный (-vvv).

Возвращаемое значение

bool true, если уровень подробности установлен в VERBOSITY_DEBUG, иначе false

writeln(string|iterable $messages, int $options = self::OUTPUT_NORMAL)

Записывает сообщение в вывод и добавляет новую строку в конце.

Параметры

string|iterable $messages Сообщение как итерируемый объект строк или одна строка
int $options Побитовая маска опций (одно из значений констант OUTPUT или VERBOSITY), 0 считается тем же, что и self::OUTPUT_NORMAL | self::VERBOSITY_NORMAL

write(string|iterable $messages, bool $newline = false, int $options = self::OUTPUT_NORMAL)

Записывает сообщение в вывод.

Параметры

string|iterable $messages Сообщение как итерируемый объект строк или одна строка
bool $newline Добавлять ли новую строку
int $options Побитовая маска опций (одно из значений констант OUTPUT или VERBOSITY), 0 считается тем же, что и self::OUTPUT_NORMAL | self::VERBOSITY_NORMAL

protected doWrite(string $message, bool $newline)

Записывает сообщение в вывод.

Параметры

string $message Сообщение для записи в вывод
bool $newline Добавлять ли новую строку

resource getStream()

Возвращает поток, присоединенный к этой инстанции StreamOutput.

Возвращаемое значение

resource Ресурс потока

protected bool hasColorSupport()

Возвращает true, если поток поддерживает цветовое форматирование.

Цветовое форматирование отключено, если не поддерживается потоком:

Это сложно на Windows, потому что Cygwin, Msys2 и т.д. эмулируют псевдотерминалы через именованные каналы, поэтому мы можем проверить только среду.

Ссылка: Composer\XdebugHandler\Process::supportsColor https://github.com/composer/xdebug-handler

Возвращаемое значение

bool true, если поток поддерживает цветовое форматирование, иначе false

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/Console/Output/StreamOutput.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API