ConsoleOutputInterface
interface ConsoleOutputInterface implements OutputInterface
ConsoleOutputInterface is the interface implemented by ConsoleOutput class.
This adds information about stderr output stream.
Methods
write(string|array $messages, Boolean $newline = false, integer $type = self::OUTPUT_NORMAL) Writes a message to the output. | from OutputInterface | |
writeln(string|array $messages, integer $type = self::OUTPUT_NORMAL) Writes a message to the output and adds a newline at the end. | from OutputInterface | |
setVerbosity(integer $level) Sets the verbosity of the output. | from OutputInterface | |
integer | getVerbosity() Gets the current verbosity of the output. | from OutputInterface |
setDecorated(Boolean $decorated) Sets the decorated flag. | from OutputInterface | |
Boolean | isDecorated() Gets the decorated flag. | from OutputInterface |
setFormatter(OutputFormatterInterface $formatter) Sets output formatter. | from OutputInterface | |
OutputFormatterInterface | getFormatter() Returns current output formatter instance. | from OutputInterface |
OutputInterface | getErrorOutput() Gets the OutputInterface for errors. | |
setErrorOutput(OutputInterface $error) Sets the OutputInterface used for errors. |
Details
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 |
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 |
setVerbosity(integer $level)
Sets the verbosity of the output.
Parameters
integer | $level | The level of verbosity (one of the VERBOSITY constants) |
integer getVerbosity()
Gets the current verbosity of the output.
Return Value
integer | The current level of verbosity (one of the VERBOSITY constants) |
setDecorated(Boolean $decorated)
Sets the decorated flag.
Parameters
Boolean | $decorated | Whether to decorate the messages |
Boolean isDecorated()
Gets the decorated flag.
Return Value
Boolean | true if the output will decorate messages, false otherwise |
setFormatter(OutputFormatterInterface $formatter)
Sets output formatter.
Parameters
OutputFormatterInterface | $formatter |
OutputFormatterInterface getFormatter()
Returns current output formatter instance.
Return Value
OutputFormatterInterface |
OutputInterface getErrorOutput()
Gets the OutputInterface for errors.
Return Value
OutputInterface |
setErrorOutput(OutputInterface $error)
Sets the OutputInterface used for errors.
Parameters
OutputInterface | $error |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Component/Console/Output/ConsoleOutputInterface.html