W3cubDocs

Symfony\Component\Console\Output\OutputInterface

interface OutputInterface

OutputInterface is the interface implemented by all Output classes.

Constants

VERBOSITY_QUIET
VERBOSITY_NORMAL
VERBOSITY_VERBOSE
VERBOSITY_VERY_VERBOSE
VERBOSITY_DEBUG
OUTPUT_NORMAL
OUTPUT_RAW
OUTPUT_PLAIN

Methods

	write(string\|array $messages, bool $newline = false, int $type = self::OUTPUT_NORMAL) Writes a message to the output.
	writeln(string\|array $messages, int $type = self::OUTPUT_NORMAL) Writes a message to the output and adds a newline at the end.
	setVerbosity(int $level) Sets the verbosity of the output.
int	getVerbosity() Gets the current verbosity of the output.
	setDecorated(bool $decorated) Sets the decorated flag.
bool	isDecorated() Gets the decorated flag.
	setFormatter(OutputFormatterInterface $formatter) Sets output formatter.
OutputFormatterInterface	getFormatter() Returns current output formatter instance.

Details

public 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

public 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

public setVerbosity(int $level)

Sets the verbosity of the output.

Parameters

int

$level

The level of verbosity (one of the VERBOSITY constants)

public int getVerbosity()

Gets the current verbosity of the output.

Return Value

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

public setDecorated(bool $decorated)

Sets the decorated flag.

Parameters

bool

$decorated

Whether to decorate the messages

public bool isDecorated()

Gets the decorated flag.

Return Value

bool	true if the output will decorate messages, false otherwise

public setFormatter(OutputFormatterInterface $formatter)

Sets output formatter.

Parameters

OutputFormatterInterface

$formatter

public OutputFormatterInterface getFormatter()

Returns current output formatter instance.

Return Value

OutputFormatterInterface

© 2004–2016 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.7/Symfony/Component/Console/Output/OutputInterface.html