Output
class Output implements OutputInterface
Base class for output classes.
There are five levels of verbosity:
- normal: no option passed (normal output)
- verbose: -v (more output)
- very verbose: -vv (highly extended output)
- debug: -vvv (all debug output)
- quiet: -q (no output)
Methods
| __construct(int $verbosity = self::VERBOSITY_NORMAL, bool $decorated = false, OutputFormatterInterface $formatter = null) | ||
| setFormatter(OutputFormatterInterface $formatter) Sets output formatter. | ||
| OutputFormatterInterface | getFormatter() Returns current output formatter instance. | |
| setDecorated(bool $decorated) Sets the decorated flag. | ||
| bool | isDecorated() Gets the decorated flag. | |
| setVerbosity(int $level) Sets the verbosity of the output. | ||
| int | getVerbosity() Gets the current verbosity of the output. | |
| 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. | ||
| write(string|array $messages, bool $newline = false, int $type = self::OUTPUT_NORMAL) Writes a message to the output. |
Details
__construct(int $verbosity = self::VERBOSITY_NORMAL, bool $decorated = false, OutputFormatterInterface $formatter = null)
Parameters
| 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) |
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 |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.7/Symfony/Component/Console/Output/Output.html