Spec-Zone.ru › Symfony 3.0

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() из Output
isVerbose() из Output
isVeryVerbose() из Output
isDebug() из 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)

isQuiet()

isVerbose()

isVeryVerbose()

isDebug()

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.0/Symfony/Component/Console/Output/ConsoleOutput.html

Spec-Zone.ru

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