ConsoleOutput

$output = new ConsoleOutput();

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

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

Parameters

int|null	$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)

setFormatter(OutputFormatterInterface $formatter)

Parameters

OutputFormatterInterface

$formatter

OutputFormatterInterface getFormatter()

Returns current output formatter instance.

Return Value

OutputFormatterInterface

setDecorated(bool $decorated)

Sets the decorated flag.

Parameters

bool

$decorated

Whether to decorate the messages

bool isDecorated()

Gets the decorated flag.

Return Value

bool	true if the output will decorate messages, false otherwise

setVerbosity(int $level)

Sets the verbosity of the output.

Parameters

int

$level

The level of verbosity (one of the VERBOSITY constants)

int getVerbosity()

Gets the current verbosity of the output.

Return Value

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

bool isQuiet()

Returns whether verbosity is quiet (-q).

Return Value

bool	true if verbosity is set to VERBOSITY_QUIET, false otherwise

bool isVerbose()

Returns whether verbosity is verbose (-v).

Return Value

bool	true if verbosity is set to VERBOSITY_VERBOSE, false otherwise

bool isVeryVerbose()

Returns whether verbosity is very verbose (-vv).

Return Value

bool	true if verbosity is set to VERBOSITY_VERY_VERBOSE, false otherwise

bool isDebug()

Returns whether verbosity is debug (-vvv).

Return Value

bool	true if verbosity is set to VERBOSITY_DEBUG, false otherwise

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

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

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

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

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

resource getStream()

Gets the stream attached to this StreamOutput instance.

Return Value

resource

A stream resource

protected bool hasColorSupport()

Returns true if the stream supports colorization.

Colorization is disabled if not supported by the stream:

This is tricky on Windows, because Cygwin, Msys2 etc emulate pseudo terminals via named pipes, so we can only check the environment.

Reference: Composer\XdebugHandler\Process::supportsColor https://github.com/composer/xdebug-handler

Return Value

bool	true if the stream supports colorization, false otherwise

ConsoleSectionOutput section()

Creates a new output section.

Return Value

ConsoleSectionOutput

OutputInterface getErrorOutput()

Gets the OutputInterface for errors.

Return Value

OutputInterface

setErrorOutput(OutputInterface $error)

Parameters

OutputInterface

$error

protected bool hasStdoutSupport()

Returns true if current environment supports writing console output to STDOUT.

Return Value

bool

protected bool hasStderrSupport()

Returns true if current environment supports writing console output to STDERR.

Return Value

bool