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)

No description

getFormatter()

Returns current output formatter instance.

Details

at line line 42
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

at line line 52
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 or a single string
int $type The type of output (one of the OUTPUT constants)

Exceptions

InvalidArgumentException When unknown output type is given

at line line 59
setVerbosity(int $level)

Sets the verbosity of the output.

Parameters

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

at line line 66
int getVerbosity()

Gets the current verbosity of the output.

Return Value

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

at line line 73
setDecorated(bool $decorated)

Sets the decorated flag.

Parameters

bool $decorated Whether to decorate the messages

at line line 80
bool isDecorated()

Gets the decorated flag.

Return Value

bool true if the output will decorate messages, false otherwise

at line line 82
setFormatter(OutputFormatterInterface $formatter)

Parameters

OutputFormatterInterface $formatter

at line line 89
OutputFormatterInterface getFormatter()

Returns current output formatter instance.