\app\framework\Component\Console\OutputConsoleOutput

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

This class is a convenient wrapper around StreamOutput for both STDOUT and STDERR.

$output = new ConsoleOutput();

This is equivalent to:

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

Summary

Methods
Properties
Constants
__construct()
getStream()
write()
writeln()
setVerbosity()
getVerbosity()
isQuiet()
isVerbose()
isVeryVerbose()
isDebug()
setFormatter()
getFormatter()
setDecorated()
isDecorated()
section()
getErrorOutput()
setErrorOutput()
No public properties found
No constants found
doWrite()
hasColorSupport()
hasStdoutSupport()
hasStderrSupport()
No protected properties found
N/A
isRunningOS400()
openOutputStream()
openErrorStream()
$stream
$verbosity
$formatter
$stderr
$consoleSectionOutputs
N/A

Properties

$stream

$stream : 

Type

$verbosity

$verbosity : 

Type

$formatter

$formatter : 

Type

$stderr

$stderr : 

Type

$consoleSectionOutputs

$consoleSectionOutputs : 

Type

Methods

__construct()

__construct(integer  $verbosity = self::VERBOSITY_NORMAL, boolean|null  $decorated = null, \app\framework\Component\Console\Output\Formatter\OutputFormatterInterface|null  $formatter = null) 

Parameters

integer $verbosity

The verbosity level (one of the VERBOSITY constants in OutputInterface)

boolean|null $decorated

Whether to decorate messages (null for auto-guessing)

\app\framework\Component\Console\Output\Formatter\OutputFormatterInterface|null $formatter

Output formatter instance (null to use default OutputFormatter)

getStream()

getStream() : resource

Gets the stream attached to this StreamOutput instance.

Returns

resource —

A stream resource

write()

write(string|array  $messages, boolean  $newline = false, integer  $options) 

Writes a message to the output.

Parameters

string|array $messages

The message as an array of lines or a single string

boolean $newline

Whether to add a newline

integer $options

A bitmask of options (one of the OUTPUT or VERBOSITY constants), 0 is considered the same as self::OUTPUT_NORMAL | self::VERBOSITY_NORMAL

writeln()

writeln(string|array  $messages, integer  $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

integer $options

A bitmask of options (one of the OUTPUT or VERBOSITY constants), 0 is considered the same as self::OUTPUT_NORMAL | self::VERBOSITY_NORMAL

setVerbosity()

setVerbosity(  $level) 

{@inheritdoc}

Parameters

$level

getVerbosity()

getVerbosity() : integer

Gets the current verbosity of the output.

Returns

integer —

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

isQuiet()

isQuiet() : boolean

Returns whether verbosity is quiet (-q).

Returns

boolean —

true if verbosity is set to VERBOSITY_QUIET, false otherwise

isVerbose()

isVerbose() : boolean

Returns whether verbosity is verbose (-v).

Returns

boolean —

true if verbosity is set to VERBOSITY_VERBOSE, false otherwise

isVeryVerbose()

isVeryVerbose() : boolean

Returns whether verbosity is very verbose (-vv).

Returns

boolean —

true if verbosity is set to VERBOSITY_VERY_VERBOSE, false otherwise

isDebug()

isDebug() : boolean

Returns whether verbosity is debug (-vvv).

Returns

boolean —

true if verbosity is set to VERBOSITY_DEBUG, false otherwise

getFormatter()

getFormatter() 

{@inheritdoc}

setDecorated()

setDecorated(  $decorated) 

{@inheritdoc}

Parameters

$decorated

isDecorated()

isDecorated() 

section()

section() 

Creates a new output section.

doWrite()

doWrite(string  $message, boolean  $newline) 

Writes a message to the output.

Parameters

string $message

A message to write to the output

boolean $newline

Whether to add a newline or not

hasColorSupport()

hasColorSupport() : boolean

Returns true if the stream supports colorization.

Colorization is disabled if not supported by the stream:

  • Windows != 10.0.10586 without Ansicon, ConEmu or Mintty
  • non tty consoles

Returns

boolean —

true if the stream supports colorization, false otherwise

hasStdoutSupport()

hasStdoutSupport() : boolean

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

Returns

boolean

hasStderrSupport()

hasStderrSupport() : boolean

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

Returns

boolean

isRunningOS400()

isRunningOS400() : boolean

Checks if current executing environment is IBM iSeries (OS400), which doesn't properly convert character-encodings between ASCII to EBCDIC.

Returns

boolean

openOutputStream()

openOutputStream() : resource

Returns

resource

openErrorStream()

openErrorStream() : resource

Returns

resource