Symfony2 API
Class

Symfony\Component\Console\Output\StreamOutput

class StreamOutput extends Output

StreamOutput writes the output to a given stream.

Usage:

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

As StreamOutput can use any stream, you can also use a file:

$output = new StreamOutput(fopen('/path/to/output.log', 'a', false));

Methods

__construct(mixed $stream, integer $verbosity = self::VERBOSITY_NORMAL, Boolean|null $decorated = null, OutputFormatterInterface $formatter = null)

Constructor.
setFormatter(OutputFormatterInterface $formatter)

Sets output formatter.

 from Output
OutputFormatterInterface getFormatter()

Returns current output formatter instance.

 from Output
setDecorated(Boolean $decorated)

Sets the decorated flag.

 from Output
Boolean isDecorated()

Gets the decorated flag.

 from Output
setVerbosity(integer $level)

Sets the verbosity of the output.

 from Output
integer getVerbosity()

Gets the current verbosity of the output.

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

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

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

Writes a message to the output.

 from Output
resource getStream()

Gets the stream attached to this StreamOutput instance.

Details

at line 47
public __construct(mixed $stream, integer $verbosity = self::VERBOSITY_NORMAL, Boolean|null $decorated = null, OutputFormatterInterface $formatter = null)

Constructor.

Parameters

mixed $stream A stream resource
integer $verbosity The verbosity level (one of the VERBOSITY constants in OutputInterface)
Boolean|null $decorated Whether to decorate messages (null for auto-guessing)
OutputFormatterInterface $formatter Output formatter instance (null to use default OutputFormatter)

Exceptions

InvalidArgumentException When first argument is not a real stream

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

Sets output formatter.

Parameters

OutputFormatterInterface $formatter

in Output at line 64
public OutputFormatterInterface getFormatter()

Returns current output formatter instance.

Return Value

OutputFormatterInterface

in Output at line 72
public setDecorated(Boolean $decorated)

Sets the decorated flag.

Parameters

Boolean $decorated Whether to decorate the messages

in Output at line 80
public Boolean isDecorated()

Gets the decorated flag.

Return Value

Boolean true if the output will decorate messages, false otherwise

in Output at line 88
public setVerbosity(integer $level)

Sets the verbosity of the output.

Parameters

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

in Output at line 96
public integer getVerbosity()

Gets the current verbosity of the output.

Return Value

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

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

Exceptions

InvalidArgumentException When unknown output type is given

in Output at line 112
public write(string|array $messages, Boolean $newline = false, integer $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
Boolean $newline Whether to add a newline
integer $type The type of output (one of the OUTPUT constants)

Exceptions

InvalidArgumentException When unknown output type is given

at line 67
public resource getStream()

Gets the stream attached to this StreamOutput instance.

Return Value

resource A stream resource