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 $decorated = null, OutputFormatterInterface $formatter = null) | ||
| 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() {@inheritdoc} | from Output | |
| isVerbose() {@inheritdoc} | from Output | |
| isVeryVerbose() {@inheritdoc} | from Output | |
| isDebug() {@inheritdoc} | 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 | |
| resource | getStream() Gets the stream attached to this StreamOutput instance. |
Details
__construct(resource $stream, int $verbosity = self::VERBOSITY_NORMAL, bool $decorated = null, OutputFormatterInterface $formatter = null)
Parameters
| resource | $stream | A stream resource |
| 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) |
Exceptions
| InvalidArgumentException | When first argument is not a real stream |
setFormatter(OutputFormatterInterface $formatter)
Sets output formatter.
Parameters
| OutputFormatterInterface | $formatter |
OutputFormatterInterface getFormatter()
Returns current output formatter instance.
Return Value
| OutputFormatterInterface |
setDecorated(bool $decorated)
Sets the decorated flag.
Parameters
| bool | $decorated | Whether to decorate the messages |
bool isDecorated()
Gets the decorated flag.
Return Value
| bool | true if the output will decorate messages, false otherwise |
setVerbosity(int $level)
Sets the verbosity of the output.
Parameters
| int | $level | The level of verbosity (one of the VERBOSITY constants) |
int getVerbosity()
Gets the current verbosity of the output.
Return Value
| int | The current level of verbosity (one of the VERBOSITY constants) |
isQuiet()
{@inheritdoc}
isVerbose()
{@inheritdoc}
isVeryVerbose()
{@inheritdoc}
isDebug()
{@inheritdoc}
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 or a single string |
| int | $type | The type of output (one of the OUTPUT constants) |
Exceptions
| InvalidArgumentException | When unknown output type is given |
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 |
resource getStream()
Gets the stream attached to this StreamOutput instance.
Return Value
| resource | A stream resource |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.7/Symfony/Component/Console/Output/StreamOutput.html