1. class
  2. Symfony
  3. Component
  4. Console
  5. Output
  6. ConsoleOutput

ConsoleOutput

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)

Constructor.

setFormatter(OutputFormatterInterface $formatter)

Sets output formatter.

OutputFormatterInterface
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()

No description

from Output
isVerbose()

No description

from Output
isVeryVerbose()

No description

from Output
isDebug()

No description

from Output
writeln(string|array $messages, int $options = 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 $options = self::OUTPUT_NORMAL)

Writes a message to the output.

from Output
resource
getStream()

Gets the stream attached to this StreamOutput instance.

from StreamOutput
OutputInterface
getErrorOutput()

Gets the OutputInterface for errors.

setErrorOutput(OutputInterface $error)

Sets the OutputInterface used for errors.

Details

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

Constructor.

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

Sets output formatter.

Parameters

OutputFormatterInterface $formatter

in Output at line line 60
OutputFormatterInterface getFormatter()

Returns current output formatter instance.

Return Value

OutputFormatterInterface

at line line 58
setDecorated(bool $decorated)

Sets the decorated flag.

Parameters

bool $decorated Whether to decorate the messages

in Output at line line 76
bool isDecorated()

Gets the decorated flag.

Return Value

bool true if the output will decorate messages, false otherwise

at line line 76
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 92
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 97
isQuiet()

in Output at line line 102
isVerbose()

in Output at line line 107
isVeryVerbose()

in Output at line line 112
isDebug()

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

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

in StreamOutput at line line 65
resource getStream()

Gets the stream attached to this StreamOutput instance.

Return Value

resource A stream resource

at line line 85
OutputInterface getErrorOutput()

Gets the OutputInterface for errors.

Return Value

OutputInterface

at line line 93
setErrorOutput(OutputInterface $error)

Sets the OutputInterface used for errors.

Parameters

OutputInterface $error