1. class
  2. Symfony
  3. Component
  4. Console
  5. Output
  6. BufferedOutput

BufferedOutput

class BufferedOutput extends Output

Methods

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

Constructor.

from Output
setFormatter(OutputFormatterInterface $formatter)

Sets output formatter.

from Output
OutputFormatterInterface
getFormatter()

Returns current output formatter instance.

from Output
setDecorated(bool $decorated)

Sets the decorated flag.

from Output
bool
isDecorated()

Gets the decorated flag.

from Output
setVerbosity(int $level)

Sets the verbosity of the output.

from Output
int
getVerbosity()

Gets the current verbosity of the output.

from Output
isQuiet()

No description

from Output
isVerbose()

No description

from Output
isVeryVerbose()

No description

from Output
isDebug()

No description

from Output
writeln(string|array $messages, int $type = self::OUTPUT_NORMAL)

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

from Output
write(string|array $messages, bool $newline = false, int $type = self::OUTPUT_NORMAL)

Writes a message to the output.

from Output
string
fetch()

Empties buffer and returns its content.

Details

in Output at line line 46
__construct(int $verbosity = self::VERBOSITY_NORMAL, bool $decorated = false, OutputFormatterInterface $formatter = null)

Constructor.

Parameters

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

in Output at line line 56
setFormatter(OutputFormatterInterface $formatter)

Sets output formatter.

Parameters

OutputFormatterInterface $formatter

in Output at line line 64
OutputFormatterInterface getFormatter()

Returns current output formatter instance.

Return Value

OutputFormatterInterface

in Output at line line 72
setDecorated(bool $decorated)

Sets the decorated flag.

Parameters

bool $decorated Whether to decorate the messages

in Output at line line 80
bool isDecorated()

Gets the decorated flag.

Return Value

bool true if the output will decorate messages, false otherwise

in Output at line line 88
setVerbosity(int $level)

Sets the verbosity of the output.

Parameters

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

in Output at line line 96
int getVerbosity()

Gets the current verbosity of the output.

Return Value

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

in Output at line line 101
isQuiet()

in Output at line line 106
isVerbose()

in Output at line line 111
isVeryVerbose()

in Output at line line 116
isDebug()

in Output at line line 124
writeln(string|array $messages, int $type = 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
int $type The type of output (one of the OUTPUT constants)

Exceptions

InvalidArgumentException When unknown output type is given

in Output at line line 132
write(string|array $messages, bool $newline = false, int $type = self::OUTPUT_NORMAL)

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 $type The type of output (one of the OUTPUT constants)

Exceptions

InvalidArgumentException When unknown output type is given

at line line 29
string fetch()

Empties buffer and returns its content.

Return Value

string