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() Возвращает текущую инстанцию форматировщика вывода.	from Output
	setDecorated(bool $decorated) Устанавливает флаг форматирования.
bool	isDecorated() Получает флаг форматирования.	from Output
	setVerbosity(int $level) Устанавливает уровень подробности вывода.
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 $options = self::OUTPUT_NORMAL) Выводит сообщение в вывод и добавляет в конец новую строку.	from Output
	write(string\|array $messages, bool $newline = false, int $options = self::OUTPUT_NORMAL) Выводит сообщение в вывод.	from Output
resource	getStream() Возвращает поток, присоединённый к этому экземпляру StreamOutput.	from 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 $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/2.8/Symfony/Component/Console/Output/ConsoleOutput.html