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

No description

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.

isQuiet()

{@inheritdoc}

isVerbose()

{@inheritdoc}

isVeryVerbose()

{@inheritdoc}

isDebug()

{@inheritdoc}

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.

doWrite(string $message, bool $newline)

Writes a message to the output.

Details

at 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 50
setFormatter(OutputFormatterInterface $formatter)

Parameters

OutputFormatterInterface $formatter

at line 58
OutputFormatterInterface getFormatter()

Returns current output formatter instance.

at line 66
setDecorated(bool $decorated)

Sets the decorated flag.

Parameters

bool $decorated Whether to decorate the messages

at line 74
bool isDecorated()

Gets the decorated flag.

Return Value

bool true if the output will decorate messages, false otherwise

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

{@inheritdoc}

at line 106
isVerbose()

{@inheritdoc}

at line 114
isVeryVerbose()

{@inheritdoc}

at line 122
isDebug()

{@inheritdoc}

at 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 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 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 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 174
abstract protected doWrite(string $message, bool $newline)

Writes a message to the output.

Parameters

string $message A message to write to the output
bool $newline Whether to add a newline or not