\app\framework\Component\Console\OutputOutputInterface

OutputInterface is the interface implemented by all Output classes.

Summary

Methods

Constants

write()
writeln()
setVerbosity()
getVerbosity()
isQuiet()
isVerbose()
isVeryVerbose()
isDebug()
setDecorated()

VERBOSITY_QUIET
VERBOSITY_NORMAL
VERBOSITY_VERBOSE
VERBOSITY_VERY_VERBOSE
VERBOSITY_DEBUG
OUTPUT_NORMAL
OUTPUT_RAW
OUTPUT_PLAIN

No protected methods found

N/A

No private methods found

N/A

Constants

VERBOSITY_QUIET

VERBOSITY_QUIET

VERBOSITY_NORMAL

VERBOSITY_NORMAL

VERBOSITY_VERBOSE

VERBOSITY_VERBOSE

VERBOSITY_VERY_VERBOSE

VERBOSITY_VERY_VERBOSE

VERBOSITY_DEBUG

VERBOSITY_DEBUG

OUTPUT_NORMAL

OUTPUT_NORMAL

OUTPUT_RAW

OUTPUT_RAW

OUTPUT_PLAIN

OUTPUT_PLAIN

Methods

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)

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(integer  $level)

Sets the verbosity of the output.

Parameters

integer

$level

The level of verbosity (one of the VERBOSITY constants)

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

setDecorated()

setDecorated(boolean  $decorated)

Sets the decorated flag.

Parameters

boolean

$decorated

Whether to decorate the messages