1. interface
  2. Symfony
  3. Component
  4. Console
  5. Output
  6. OutputInterface

OutputInterface

interface OutputInterface

OutputInterface is the interface implemented by all Output classes.

Constants

VERBOSITY_QUIET

VERBOSITY_NORMAL

VERBOSITY_VERBOSE

VERBOSITY_VERY_VERBOSE

VERBOSITY_DEBUG

OUTPUT_NORMAL

OUTPUT_RAW

OUTPUT_PLAIN

Methods

write(string|array $messages, bool $newline = false, int $options)

Writes a message to the output.

writeln(string|array $messages, int $options)

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

setVerbosity(int $level)

Sets the verbosity of the output.

int
getVerbosity()

Gets the current verbosity of the output.

bool
isQuiet()

Returns whether verbosity is quiet (-q).

bool
isVerbose()

Returns whether verbosity is verbose (-v).

bool
isVeryVerbose()

Returns whether verbosity is very verbose (-vv).

bool
isDebug()

Returns whether verbosity is debug (-vvv).

setDecorated(bool $decorated)

Sets the decorated flag.

bool
isDecorated()

Gets the decorated flag.

setFormatter(OutputFormatterInterface $formatter)

Sets output formatter.

OutputFormatterInterface
getFormatter()

Returns current output formatter instance.

Details

at line line 40
write(string|array $messages, bool $newline = false, int $options)

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

at line line 48
writeln(string|array $messages, int $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
int $options A bitmask of options (one of the OUTPUT or VERBOSITY constants), 0 is considered the same as self::OUTPUTNORMAL | self::VERBOSITYNORMAL

at line line 55
setVerbosity(int $level)

Sets the verbosity of the output.

Parameters

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

at line line 62
int getVerbosity()

Gets the current verbosity of the output.

Return Value

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

at line line 69
bool isQuiet()

Returns whether verbosity is quiet (-q).

Return Value

bool true if verbosity is set to VERBOSITY_QUIET, false otherwise

at line line 76
bool isVerbose()

Returns whether verbosity is verbose (-v).

Return Value

bool true if verbosity is set to VERBOSITY_VERBOSE, false otherwise

at line line 83
bool isVeryVerbose()

Returns whether verbosity is very verbose (-vv).

Return Value

bool true if verbosity is set to VERBOSITYVERYVERBOSE, false otherwise

at line line 90
bool isDebug()

Returns whether verbosity is debug (-vvv).

Return Value

bool true if verbosity is set to VERBOSITY_DEBUG, false otherwise

at line line 97
setDecorated(bool $decorated)

Sets the decorated flag.

Parameters

bool $decorated Whether to decorate the messages

at line line 104
bool isDecorated()

Gets the decorated flag.

Return Value

bool true if the output will decorate messages, false otherwise

at line line 111
setFormatter(OutputFormatterInterface $formatter)

Sets output formatter.

Parameters

OutputFormatterInterface $formatter

at line line 118
OutputFormatterInterface getFormatter()

Returns current output formatter instance.

Return Value

OutputFormatterInterface