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 $options)

Writes a message to the output.

writeln(string|array $messages, int $options)

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)
OutputFormatterInterface getFormatter()

Returns current output formatter instance.

Details

write(string|array $messages, bool $newline = false, int $options)

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

writeln(string|array $messages, int $options)

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

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)

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

setFormatter(OutputFormatterInterface $formatter)

Parameters

OutputFormatterInterface $formatter

OutputFormatterInterface getFormatter()

Returns current output formatter instance.

Return Value

OutputFormatterInterface

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