Output\ConsoleOutput (Component\Console)
Symfony\Component\Console\Output\ConsoleOutput
class ConsoleOutput extends StreamOutput implements ConsoleOutputInterface
ConsoleOutput is the default class for all CLI output.
It uses STDOUT.
This class is a convenient wrapper around StreamOutput
.
$output = new ConsoleOutput();
This is equivalent to:
$output = new StreamOutput(fopen('php://stdout', 'w'));
Methods
__construct(int $verbosity = self::VERBOSITY_NORMAL, bool|null $decorated = null, OutputFormatterInterface $formatter = null) Constructor. | ||
setFormatter(OutputFormatterInterface $formatter) Sets output formatter. | ||
OutputFormatterInterface | getFormatter() Returns current output formatter instance. | from Output |
setDecorated(bool $decorated) Sets the decorated flag. | ||
bool | isDecorated() Gets the decorated flag. | from Output |
setVerbosity(int $level) Sets the verbosity of the 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. | from StreamOutput |
OutputInterface | getErrorOutput() Gets the OutputInterface for errors. | |
setErrorOutput(OutputInterface $error) Sets the OutputInterface used for errors. |
Details
public __construct(int $verbosity = self::VERBOSITY_NORMAL, bool|null $decorated = null, OutputFormatterInterface $formatter = null)
Constructor.
public setFormatter(OutputFormatterInterface $formatter)
Sets output formatter.
public OutputFormatterInterface getFormatter()
Returns current output formatter instance.
public setDecorated(bool $decorated)
Sets the decorated flag.
public bool isDecorated()
Gets the decorated flag.
public setVerbosity(int $level)
Sets the verbosity of the output.
public int getVerbosity()
Gets the current verbosity of the output.
public isQuiet()
public isVerbose()
public isVeryVerbose()
public isDebug()
public writeln(string|array $messages, int $options = self::OUTPUT_NORMAL)
Writes a message to the output and adds a newline at the end.
public write(string|array $messages, bool $newline = false, int $options = self::OUTPUT_NORMAL)
Writes a message to the output.
public resource getStream()
Gets the stream attached to this StreamOutput instance.
public OutputInterface getErrorOutput()
Gets the OutputInterface for errors.
public setErrorOutput(OutputInterface $error)
Sets the OutputInterface used for errors.
© 2004–2016 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Component/Console/Output/ConsoleOutput.html