class Output implements OutputInterface

Base class for output classes.

There are five levels of verbosity:

  • normal: no option passed (normal output)
  • verbose: -v (more output)
  • very verbose: -vv (highly extended output)
  • debug: -vvv (all debug output)
  • quiet: -q (no output)

Methods

__construct(int $verbosity = self::VERBOSITY_NORMAL, bool $decorated = false, OutputFormatterInterface $formatter = null)

No description

setFormatter(OutputFormatterInterface $formatter)

Sets output formatter.

getFormatter()

Returns current output formatter instance.

setDecorated(bool $decorated)

Sets the decorated flag.

bool
isDecorated()

Gets the decorated flag.

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).

writeln(string|array $messages, int $options = self::OUTPUT_NORMAL)

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

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

Writes a message to the output.

Details

at line line 40
__construct(int $verbosity = self::VERBOSITY_NORMAL, bool $decorated = false, OutputFormatterInterface $formatter = null)

Parameters

int $verbosity The verbosity level (one of the VERBOSITY constants in OutputInterface)
bool $decorated Whether to decorate messages
OutputFormatterInterface $formatter Output formatter instance (null to use default OutputFormatter)

at line line 50
setFormatter(OutputFormatterInterface $formatter)

Sets output formatter.

Parameters

OutputFormatterInterface $formatter

at line line 58
OutputFormatterInterface getFormatter()

Returns current output formatter instance.

at line line 66
setDecorated(bool $decorated)

Sets the decorated flag.

Parameters

bool $decorated Whether to decorate the messages

at line line 74
bool isDecorated()

Gets the decorated flag.

Return Value

bool true if the output will decorate messages, false otherwise

at line line 82
setVerbosity(int $level)

Sets the verbosity of the output.

Parameters

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

at line line 90
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 98
bool isQuiet()

Returns whether verbosity is quiet (-q).

Return Value

bool true if verbosity is set to VERBOSITY_QUIET, false otherwise

at line line 106
bool isVerbose()

Returns whether verbosity is verbose (-v).

Return Value

bool true if verbosity is set to VERBOSITY_VERBOSE, false otherwise

at line line 114
bool isVeryVerbose()

Returns whether verbosity is very verbose (-vv).

Return Value

bool true if verbosity is set to VERBOSITYVERYVERBOSE, false otherwise

at line line 122
bool isDebug()

Returns whether verbosity is debug (-vvv).

Return Value

bool true if verbosity is set to VERBOSITY_DEBUG, false otherwise

at line line 130
writeln(string|array $messages, int $options = 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 $options A bitmask of options (one of the OUTPUT or VERBOSITY constants), 0 is considered the same as self::OUTPUTNORMAL | self::VERBOSITYNORMAL

at line line 138
write(string|array $messages, bool $newline = false, int $options = 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 $options A bitmask of options (one of the OUTPUT or VERBOSITY constants), 0 is considered the same as self::OUTPUTNORMAL | self::VERBOSITYNORMAL