ConsoleOutput

class ConsoleOutput extends StreamOutput implements ConsoleOutputInterface

ConsoleOutput is the default class for all CLI output. It uses STDOUT and STDERR.

This class is a convenient wrapper around StreamOutput for both STDOUT and STDERR.

$output = new ConsoleOutput();

This is equivalent to:

$output = new StreamOutput(fopen('php://stdout', 'w'));
$stdErr = new StreamOutput(fopen('php://stderr', 'w'));

Methods

	__construct(int $verbosity = self::VERBOSITY_NORMAL, bool $decorated = null, OutputFormatterInterface $formatter = null) Constructor.
	setFormatter(OutputFormatterInterface $formatter) Sets output formatter.
OutputFormatterInterface	getFormatter() Returns current output formatter instance.	from Output
	setDecorated(bool $decorated) Sets the decorated flag.
bool	isDecorated() Gets the decorated flag.	from Output
	setVerbosity(int $level) Sets the verbosity of the output.
int	getVerbosity() Gets the current verbosity of the output.	from Output
bool	isQuiet() Returns whether verbosity is quiet (-q).	from Output
bool	isVerbose() Returns whether verbosity is verbose (-v).	from Output
bool	isVeryVerbose() Returns whether verbosity is very verbose (-vv).	from Output
bool	isDebug() Returns whether verbosity is debug (-vvv).	from Output
	writeln(string\|array $messages, int $options = 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 $options = self::OUTPUT_NORMAL) Writes a message to the output.	from Output
resource	getStream() Gets the stream attached to this StreamOutput instance.	from StreamOutput
OutputInterface	getErrorOutput() Gets the OutputInterface for errors.
	setErrorOutput(OutputInterface $error) Sets the OutputInterface used for errors.

Details

__construct(int $verbosity = self::VERBOSITY_NORMAL, bool $decorated = null, 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)

bool isQuiet()

Returns whether verbosity is quiet (-q).

Return Value

bool	true if verbosity is set to VERBOSITY_QUIET, false otherwise

bool isVerbose()

Returns whether verbosity is verbose (-v).

Return Value

bool	true if verbosity is set to VERBOSITY_VERBOSE, false otherwise

bool isVeryVerbose()

Returns whether verbosity is very verbose (-vv).

Return Value

bool	true if verbosity is set to VERBOSITYVERYVERBOSE, false otherwise

bool isDebug()

Returns whether verbosity is debug (-vvv).

Return Value

bool	true if verbosity is set to VERBOSITY_DEBUG, false otherwise

writeln(string|array $messages, int $options = 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	$options	A bitmask of options (one of the OUTPUT or VERBOSITY constants), 0 is considered the same as self::OUTPUTNORMAL \| self::VERBOSITYNORMAL

write(string|array $messages, bool $newline = false, int $options = 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	$options	A bitmask of options (one of the OUTPUT or VERBOSITY constants), 0 is considered the same as self::OUTPUTNORMAL \| self::VERBOSITYNORMAL

resource getStream()

Gets the stream attached to this StreamOutput instance.

Return Value

resource

A stream resource

OutputInterface getErrorOutput()

Gets the OutputInterface for errors.

Return Value

OutputInterface

setErrorOutput(OutputInterface $error)

Sets the OutputInterface used for errors.

Parameters

OutputInterface

$error

Links:

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

doc_Symfony

2016-10-28 06:11:24

Comments