OutputStyle
class OutputStyle implements OutputInterface, StyleInterface
Decorates output to add console style guide helpers.
Methods
| __construct(OutputInterface $output) | ||
| newLine(int $count = 1) Add newline(s). | ||
| ProgressBar | createProgressBar(int $max) | |
| write(string|array $messages, bool $newline = false, $type = self::OUTPUT_NORMAL) Writes a message to the output. | ||
| writeln(string|array $messages, $type = self::OUTPUT_NORMAL) Writes a message to the output and adds a newline at the end. | ||
| setVerbosity(int $level) Sets the verbosity of the output. | ||
| int | getVerbosity() Gets the current verbosity of the output. | |
| setDecorated(bool $decorated) Sets the decorated flag. | ||
| bool | isDecorated() Gets the decorated flag. | |
| setFormatter(OutputFormatterInterface $formatter) | ||
| OutputFormatterInterface | getFormatter() Returns current output formatter instance. | |
| bool | isQuiet() Returns whether verbosity is quiet (-q). | |
| bool | isVerbose() Returns whether verbosity is verbose (-v). | |
| bool | isVeryVerbose() Returns whether verbosity is very verbose (-vv). | |
| bool | isDebug() Returns whether verbosity is debug (-vvv). |
Details
__construct(OutputInterface $output)
Parameters
| OutputInterface | $output |
newLine(int $count = 1)
Add newline(s).
Parameters
| int | $count | The number of newlines |
ProgressBar createProgressBar(int $max)
Parameters
| int | $max |
Return Value
| ProgressBar |
write(string|array $messages, bool $newline = false, $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 |
| $type |
writeln(string|array $messages, $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 |
| $type |
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) |
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 |
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 VERBOSITYVERYVERBOSE, false otherwise |
bool isDebug()
Returns whether verbosity is debug (-vvv).
Return Value
| bool | true if verbosity is set to VERBOSITY_DEBUG, false otherwise |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/Console/Style/OutputStyle.html