ConsoleOutputInterface
interface ConsoleOutputInterface implements OutputInterface
ConsoleOutputInterface is the interface implemented by ConsoleOutput class.
This adds information about stderr and section output stream.
Methods
write(string|iterable $messages, bool $newline = false, int $options = 0) Writes a message to the output. | from OutputInterface | |
writeln(string|iterable $messages, int $options = 0) Writes a message to the output and adds a newline at the end. | from OutputInterface | |
setVerbosity(int $level) Sets the verbosity of the output. | from OutputInterface | |
int | getVerbosity() Gets the current verbosity of the output. | from OutputInterface |
bool | isQuiet() Returns whether verbosity is quiet (-q). | from OutputInterface |
bool | isVerbose() Returns whether verbosity is verbose (-v). | from OutputInterface |
bool | isVeryVerbose() Returns whether verbosity is very verbose (-vv). | from OutputInterface |
bool | isDebug() Returns whether verbosity is debug (-vvv). | from OutputInterface |
setDecorated(bool $decorated) Sets the decorated flag. | from OutputInterface | |
bool | isDecorated() Gets the decorated flag. | from OutputInterface |
setFormatter(OutputFormatterInterface $formatter) | from OutputInterface | |
OutputFormatterInterface | getFormatter() Returns current output formatter instance. | from OutputInterface |
OutputInterface | getErrorOutput() Gets the OutputInterface for errors. | |
setErrorOutput(OutputInterface $error) | ||
ConsoleSectionOutput | section() Creates a new output section |
Details
write(string|iterable $messages, bool $newline = false, int $options = 0)
Writes a message to the output.
Parameters
string|iterable | $messages | The message as an iterable of strings 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::OUTPUT_NORMAL | self::VERBOSITY_NORMAL |
writeln(string|iterable $messages, int $options = 0)
Writes a message to the output and adds a newline at the end.
Parameters
string|iterable | $messages | The message as an iterable of strings or a single string |
int | $options | A bitmask of options (one of the OUTPUT or VERBOSITY constants), 0 is considered the same as self::OUTPUT_NORMAL | self::VERBOSITY_NORMAL |
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) |
bool isQuiet()
Returns whether verbosity is quiet (-q).
Return Value
bool | true if verbosity is set to VERBOSITY_QUIET, false otherwise |
bool isVerbose()
Returns whether verbosity is verbose (-v).
Return Value
bool | true if verbosity is set to VERBOSITY_VERBOSE, false otherwise |
bool isVeryVerbose()
Returns whether verbosity is very verbose (-vv).
Return Value
bool | true if verbosity is set to VERBOSITY_VERY_VERBOSE, false otherwise |
bool isDebug()
Returns whether verbosity is debug (-vvv).
Return Value
bool | true if verbosity is set to VERBOSITY_DEBUG, false otherwise |
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 |
setFormatter(OutputFormatterInterface $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)
Parameters
OutputInterface | $error |
ConsoleSectionOutput section()
Creates a new output section
Return Value
ConsoleSectionOutput |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/Console/Output/ConsoleOutputInterface.html