OutputFormatterInterface
interface OutputFormatterInterface
Formatter interface for console output.
Methods
| setDecorated(bool $decorated) Sets the decorated flag. | ||
| bool | isDecorated() Gets the decorated flag. | |
| setStyle(string $name, OutputFormatterStyleInterface $style) Sets a new style. | ||
| bool | hasStyle(string $name) Checks if output formatter has style with specified name. | |
| OutputFormatterStyleInterface | getStyle(string $name) Gets style options from style with specified name. | |
| string | format(string $message) Formats a message according to the given styles. |
Details
setDecorated(bool $decorated)
Sets the decorated flag.
Parameters
| bool | $decorated | Whether to decorate the messages or not |
bool isDecorated()
Gets the decorated flag.
Return Value
| bool | true if the output will decorate messages, false otherwise |
setStyle(string $name, OutputFormatterStyleInterface $style)
Sets a new style.
Parameters
| string | $name | The style name |
| OutputFormatterStyleInterface | $style | The style instance |
bool hasStyle(string $name)
Checks if output formatter has style with specified name.
Parameters
| string | $name |
Return Value
| bool |
OutputFormatterStyleInterface getStyle(string $name)
Gets style options from style with specified name.
Parameters
| string | $name |
Return Value
| OutputFormatterStyleInterface |
Exceptions
| InvalidArgumentException | When style isn't defined |
string format(string $message)
Formats a message according to the given styles.
Parameters
| string | $message | The message to style |
Return Value
| string | The styled message |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/Console/Formatter/OutputFormatterInterface.html