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 = 0)

Writes a message to the output.

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

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 40
write(string|array $messages, bool $newline = false, int $options = 0)

Writes a message to the output.

Parameters

string|array $messages The message as an array of strings 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::OUTPUT_NORMAL | self::VERBOSITY_NORMAL

at line 48
writeln(string|array $messages, int $options = 0)

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

Parameters

string|array $messages The message as an array of strings or a single string
int $options A bitmask of options (one of the OUTPUT or VERBOSITY constants), 0 is considered the same as self::OUTPUT_NORMAL | self::VERBOSITY_NORMAL

at line 55
setVerbosity(int $level)

Sets the verbosity of the output.

Parameters

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

at line 62
int getVerbosity()

Gets the current verbosity of the output.

Return Value

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

at line 69
setDecorated(bool $decorated)

Sets the decorated flag.

Parameters

bool $decorated Whether to decorate the messages

at line 76
bool isDecorated()

Gets the decorated flag.

Return Value

bool true if the output will decorate messages, false otherwise

at line 78
setFormatter(OutputFormatterInterface $formatter)

Parameters

OutputFormatterInterface $formatter

at line 85
OutputFormatterInterface getFormatter()

Returns current output formatter instance.