OutputFormatterInterface.php
| 1 | <?php |
| 2 | |
| 3 | /* |
| 4 | * This file is part of the Symfony package. |
| 5 | * |
| 6 | * (c) Fabien Potencier <fabien@symfony.com> |
| 7 | * |
| 8 | * For the full copyright and license information, please view the LICENSE |
| 9 | * file that was distributed with this source code. |
| 10 | */ |
| 11 | namespace IAWP_SCOPED\Symfony\Component\Console\Formatter; |
| 12 | |
| 13 | /** |
| 14 | * Formatter interface for console output. |
| 15 | * |
| 16 | * @author Konstantin Kudryashov <ever.zet@gmail.com> |
| 17 | */ |
| 18 | interface OutputFormatterInterface |
| 19 | { |
| 20 | /** |
| 21 | * Sets the decorated flag. |
| 22 | */ |
| 23 | public function setDecorated(bool $decorated); |
| 24 | /** |
| 25 | * Whether the output will decorate messages. |
| 26 | * |
| 27 | * @return bool |
| 28 | */ |
| 29 | public function isDecorated(); |
| 30 | /** |
| 31 | * Sets a new style. |
| 32 | */ |
| 33 | public function setStyle(string $name, OutputFormatterStyleInterface $style); |
| 34 | /** |
| 35 | * Checks if output formatter has style with specified name. |
| 36 | * |
| 37 | * @return bool |
| 38 | */ |
| 39 | public function hasStyle(string $name); |
| 40 | /** |
| 41 | * Gets style options from style with specified name. |
| 42 | * |
| 43 | * @return OutputFormatterStyleInterface |
| 44 | * |
| 45 | * @throws \InvalidArgumentException When style isn't defined |
| 46 | */ |
| 47 | public function getStyle(string $name); |
| 48 | /** |
| 49 | * Formats a message according to the given styles. |
| 50 | * |
| 51 | * @return string|null |
| 52 | */ |
| 53 | public function format(?string $message); |
| 54 | } |
| 55 |