Interface Symfony\Component\Console\Output\OutputInterface

Implemented bySymfony\Component\Console\Output\BufferedOutput, Symfony\Component\Console\Output\ConsoleOutput, Symfony\Component\Console\Output\ConsoleOutputInterface, Symfony\Component\Console\Output\NullOutput, Symfony\Component\Console\Output\Output, Symfony\Component\Console\Output\StreamOutput, Symfony\Component\Console\Style\OutputStyle, Symfony\Component\Console\Style\SymfonyStyle

OutputInterface is the interface implemented by all Output classes.

Public Methods

Hide inherited methods

MethodDescriptionDefined By
getFormatter() Returns current output formatter instance. Symfony\Component\Console\Output\OutputInterface
getVerbosity() Gets the current verbosity of the output. Symfony\Component\Console\Output\OutputInterface
isDebug() Returns whether verbosity is debug (-vvv). Symfony\Component\Console\Output\OutputInterface
isDecorated() Gets the decorated flag. Symfony\Component\Console\Output\OutputInterface
isQuiet() Returns whether verbosity is quiet (-q). Symfony\Component\Console\Output\OutputInterface
isVerbose() Returns whether verbosity is verbose (-v). Symfony\Component\Console\Output\OutputInterface
isVeryVerbose() Returns whether verbosity is very verbose (-vv). Symfony\Component\Console\Output\OutputInterface
setDecorated() Sets the decorated flag. Symfony\Component\Console\Output\OutputInterface
setFormatter() Sets output formatter. Symfony\Component\Console\Output\OutputInterface
setVerbosity() Sets the verbosity of the output. Symfony\Component\Console\Output\OutputInterface
write() Writes a message to the output. Symfony\Component\Console\Output\OutputInterface
writeln() Writes a message to the output and adds a newline at the end. Symfony\Component\Console\Output\OutputInterface

Method Details

getFormatter() public abstract method

Returns current output formatter instance.

public abstract Symfony\Component\Console\Formatter\OutputFormatterInterface getFormatter ( )
getVerbosity() public abstract method

Gets the current verbosity of the output.

public abstract int getVerbosity ( )
return int

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

isDebug() public abstract method

Returns whether verbosity is debug (-vvv).

public abstract bool isDebug ( )
return bool

True if verbosity is set to VERBOSITY_DEBUG, false otherwise

isDecorated() public abstract method

Gets the decorated flag.

public abstract bool isDecorated ( )
return bool

True if the output will decorate messages, false otherwise

isQuiet() public abstract method

Returns whether verbosity is quiet (-q).

public abstract bool isQuiet ( )
return bool

True if verbosity is set to VERBOSITY_QUIET, false otherwise

isVerbose() public abstract method

Returns whether verbosity is verbose (-v).

public abstract bool isVerbose ( )
return bool

True if verbosity is set to VERBOSITY_VERBOSE, false otherwise

isVeryVerbose() public abstract method

Returns whether verbosity is very verbose (-vv).

public abstract bool isVeryVerbose ( )
return bool

True if verbosity is set to VERBOSITY_VERY_VERBOSE, false otherwise

setDecorated() public abstract method

Sets the decorated flag.

public abstract void setDecorated ( $decorated )
$decorated bool

Whether to decorate the messages

setFormatter() public abstract method

Sets output formatter.

public abstract void setFormatter ( Symfony\Component\Console\Formatter\OutputFormatterInterface $formatter )
$formatter Symfony\Component\Console\Formatter\OutputFormatterInterface
setVerbosity() public abstract method

Sets the verbosity of the output.

public abstract void setVerbosity ( $level )
$level int

The level of verbosity (one of the VERBOSITY constants)

write() public abstract method

Writes a message to the output.

public abstract void write ( $messages, $newline false, $options 0 )
$messages string|array

The message as an array of lines or a single string

$newline bool

Whether to add a newline

$options int

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

writeln() public abstract method

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

public abstract void writeln ( $messages, $options 0 )
$messages string|array

The message as an array of lines of a single string

$options int

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