class ConsoleOutput extends StreamOutput implements ConsoleOutputInterface

ConsoleOutput is the default class for all CLI output. It uses STDOUT.

This class is a convenient wrapper around StreamOutput.

$output = new ConsoleOutput();

This is equivalent to:

$output = new StreamOutput(fopen('php://stdout', 'w'));

Methods

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

No description

setFormatter(OutputFormatterInterface $formatter)

No description

getFormatter()

Returns current output formatter instance.

from Output
setDecorated(bool $decorated)

Sets the decorated flag.

bool
isDecorated()

Gets the decorated flag.

from Output
setVerbosity(int $level)

Sets the verbosity of the output.

int
getVerbosity()

Gets the current verbosity of the output.

from Output
isQuiet()

{@inheritdoc}

from Output
isVerbose()

{@inheritdoc}

from Output
isVeryVerbose()

{@inheritdoc}

from Output
isDebug()

{@inheritdoc}

from Output
writeln(string|array $messages, int $type = self::OUTPUT_NORMAL)

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

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

Writes a message to the output.

from Output
resource
getStream()

Gets the stream attached to this StreamOutput instance.

getErrorOutput()

Gets the OutputInterface for errors.

setErrorOutput(OutputInterface $error)

No description

Details

at line line 38
__construct(int $verbosity = self::VERBOSITY_NORMAL, bool $decorated = null, 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 62
setFormatter(OutputFormatterInterface $formatter)

Parameters

OutputFormatterInterface $formatter

in Output at line line 58
OutputFormatterInterface getFormatter()

Returns current output formatter instance.

at line line 53
setDecorated(bool $decorated)

Sets the decorated flag.

Parameters

bool $decorated Whether to decorate the messages

in Output 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 71
setVerbosity(int $level)

Sets the verbosity of the output.

Parameters

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

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

in Output at line line 98
isQuiet()

{@inheritdoc}

in Output at line line 106
isVerbose()

{@inheritdoc}

in Output at line line 114
isVeryVerbose()

{@inheritdoc}

in Output at line line 122
isDebug()

{@inheritdoc}

in Output at line line 130
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

in Output at line line 138
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

in StreamOutput at line line 61
resource getStream()

Gets the stream attached to this StreamOutput instance.

Return Value

resource A stream resource

at line line 80
OutputInterface getErrorOutput()

Gets the OutputInterface for errors.

Return Value

OutputInterface

at line line 88
setErrorOutput(OutputInterface $error)

Parameters

OutputInterface $error