Symfony 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(resource $stream, int $verbosity = self::VERBOSITY_NORMAL, bool|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(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()

from Output
isVerbose()

from Output
isVeryVerbose()

from Output
isDebug()

from Output
writeln(string|array $messages, int $options = 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 $options = self::OUTPUT_NORMAL)

Writes a message to the output.

from Output
resource getStream()

Gets the stream attached to this StreamOutput instance.

Details

at line 45
public __construct(resource $stream, int $verbosity = self::VERBOSITY_NORMAL, bool|null $decorated = null, OutputFormatterInterface $formatter = null)

Constructor.

Parameters

resource $stream A stream resource
int $verbosity The verbosity level (one of the VERBOSITY constants in OutputInterface)
bool|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 52
public setFormatter(OutputFormatterInterface $formatter)

Sets output formatter.

Parameters

OutputFormatterInterface $formatter

in Output at line 60
public OutputFormatterInterface getFormatter()

Returns current output formatter instance.

in Output at line 68
public setDecorated(bool $decorated)

Sets the decorated flag.

Parameters

bool $decorated Whether to decorate the messages

in Output at line 76
public bool isDecorated()

Gets the decorated flag.

Return Value

bool true if the output will decorate messages, false otherwise

in Output at line 84
public 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 92
public 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 97
public isQuiet()

in Output at line 102
public isVerbose()

in Output at line 107
public isVeryVerbose()

in Output at line 112
public isDebug()

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

in Output at line 128
public write(string|array $messages, bool $newline = false, int $options = 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 $options A bitmask of options (one of the OUTPUT or VERBOSITY constants), 0 is considered the same as self::OUTPUTNORMAL | self::VERBOSITYNORMAL

at line 65
public resource getStream()

Gets the stream attached to this StreamOutput instance.

Return Value

resource A stream resource