interface ConsoleOutputInterface implements OutputInterface

ConsoleOutputInterface is the interface implemented by ConsoleOutput class.

This adds information about stderr and section output stream.

Methods

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

Writes a message to the output.

writeln(string|iterable $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.

bool
isQuiet()

Returns whether verbosity is quiet (-q).

bool
isVerbose()

Returns whether verbosity is verbose (-v).

bool
isVeryVerbose()

Returns whether verbosity is very verbose (-vv).

bool
isDebug()

Returns whether verbosity is debug (-vvv).

setDecorated(bool $decorated)

Sets the decorated flag.

bool
isDecorated()

Gets the decorated flag.

setFormatter(OutputFormatterInterface $formatter)

No description

getFormatter()

Returns current output formatter instance.

getErrorOutput()

Gets the OutputInterface for errors.

setErrorOutput(OutputInterface $error)

No description

ConsoleSectionOutput
section()

Creates a new output section

Details

in OutputInterface at line 40
write(string|iterable $messages, bool $newline = false, int $options = 0)

Writes a message to the output.

Parameters

string|iterable $messages The message as an iterable 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

in OutputInterface at line 48
writeln(string|iterable $messages, int $options = 0)

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

Parameters

string|iterable $messages The message as an iterable 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

in OutputInterface at line 55
setVerbosity(int $level)

Sets the verbosity of the output.

Parameters

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

in OutputInterface 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)

in OutputInterface at line 69
bool isQuiet()

Returns whether verbosity is quiet (-q).

Return Value

bool true if verbosity is set to VERBOSITY_QUIET, false otherwise

in OutputInterface at line 76
bool isVerbose()

Returns whether verbosity is verbose (-v).

Return Value

bool true if verbosity is set to VERBOSITY_VERBOSE, false otherwise

in OutputInterface at line 83
bool isVeryVerbose()

Returns whether verbosity is very verbose (-vv).

Return Value

bool true if verbosity is set to VERBOSITY_VERY_VERBOSE, false otherwise

in OutputInterface at line 90
bool isDebug()

Returns whether verbosity is debug (-vvv).

Return Value

bool true if verbosity is set to VERBOSITY_DEBUG, false otherwise

in OutputInterface at line 97
setDecorated(bool $decorated)

Sets the decorated flag.

Parameters

bool $decorated Whether to decorate the messages

in OutputInterface at line 104
bool isDecorated()

Gets the decorated flag.

Return Value

bool true if the output will decorate messages, false otherwise

in OutputInterface at line 106
setFormatter(OutputFormatterInterface $formatter)

Parameters

OutputFormatterInterface $formatter

in OutputInterface at line 113
OutputFormatterInterface getFormatter()

Returns current output formatter instance.

at line 29
OutputInterface getErrorOutput()

Gets the OutputInterface for errors.

Return Value

OutputInterface

at line 31
setErrorOutput(OutputInterface $error)

Parameters

OutputInterface $error

at line 22
ConsoleSectionOutput section()

Creates a new output section

Return Value

ConsoleSectionOutput