BufferedOutput

class BufferedOutput extends Output

Methods

	__construct(int $verbosity = self::VERBOSITY_NORMAL, bool $decorated = false, OutputFormatterInterface $formatter = null) Constructor.	from Output
	setFormatter(OutputFormatterInterface $formatter) Sets output formatter.	from Output
OutputFormatterInterface	getFormatter() Returns current output formatter instance.	from Output
	setDecorated(bool $decorated) Sets the decorated flag.	from Output
bool	isDecorated() Gets the decorated flag.	from Output
	setVerbosity(int $level) Sets the verbosity of the output.	from Output
int	getVerbosity() Gets the current verbosity of the output.	from Output
	isQuiet()	from Output
	isVerbose()	from Output
	isVeryVerbose()	from Output
	isDebug()	from Output
	writeln(string\|array $messages, int $type = self::OUTPUT_NORMAL) Writes a message to the output and adds a newline at the end.	from Output
	write(string\|array $messages, bool $newline = false, int $type = self::OUTPUT_NORMAL) Writes a message to the output.	from Output
string	fetch() Empties buffer and returns its content.

Details

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

Constructor.

Parameters

int	$verbosity	The verbosity level (one of the VERBOSITY constants in OutputInterface)
bool	$decorated	Whether to decorate messages
OutputFormatterInterface	$formatter	Output formatter instance (null to use default OutputFormatter)

setFormatter(OutputFormatterInterface $formatter)

Sets output formatter.

Parameters

OutputFormatterInterface

$formatter

OutputFormatterInterface getFormatter()

Returns current output formatter instance.

Return Value

OutputFormatterInterface

setDecorated(bool $decorated)

Sets the decorated flag.

Parameters

bool

$decorated

Whether to decorate the messages

bool isDecorated()

Gets the decorated flag.

Return Value

bool	true if the output will decorate messages, false otherwise

setVerbosity(int $level)

Sets the verbosity of the output.

Parameters

int

$level

The level of verbosity (one of the VERBOSITY constants)

int getVerbosity()

Gets the current verbosity of the output.

Return Value

int	The current level of verbosity (one of the VERBOSITY constants)

isQuiet()

isVerbose()

isVeryVerbose()

isDebug()

writeln(string|array $messages, int $type = self::OUTPUT_NORMAL)

Writes a message to the output and adds a newline at the end.

Parameters

string\|array	$messages	The message as an array of lines of a single string
int	$type	The type of output (one of the OUTPUT constants)

Exceptions

InvalidArgumentException

When unknown output type is given

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

Writes a message to the output.

Parameters

string\|array	$messages	The message as an array of lines or a single string
bool	$newline	Whether to add a newline
int	$type	The type of output (one of the OUTPUT constants)

Exceptions

InvalidArgumentException

When unknown output type is given

string fetch()

Empties buffer and returns its content.

Return Value

string

Links:

http://api.symfony.com/master/Symfony/Component/Console/Output/BufferedOutput.html

doc_Symfony

2016-10-28 06:07:16

Comments