StyleInterface.php
116 lines
| 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\Style; |
| 12 | |
| 13 | /** |
| 14 | * Output style helpers. |
| 15 | * |
| 16 | * @author Kevin Bond <kevinbond@gmail.com> |
| 17 | * @internal |
| 18 | */ |
| 19 | interface StyleInterface |
| 20 | { |
| 21 | /** |
| 22 | * Formats a command title. |
| 23 | */ |
| 24 | public function title(string $message); |
| 25 | /** |
| 26 | * Formats a section title. |
| 27 | */ |
| 28 | public function section(string $message); |
| 29 | /** |
| 30 | * Formats a list. |
| 31 | */ |
| 32 | public function listing(array $elements); |
| 33 | /** |
| 34 | * Formats informational text. |
| 35 | * |
| 36 | * @param string|array $message |
| 37 | */ |
| 38 | public function text($message); |
| 39 | /** |
| 40 | * Formats a success result bar. |
| 41 | * |
| 42 | * @param string|array $message |
| 43 | */ |
| 44 | public function success($message); |
| 45 | /** |
| 46 | * Formats an error result bar. |
| 47 | * |
| 48 | * @param string|array $message |
| 49 | */ |
| 50 | public function error($message); |
| 51 | /** |
| 52 | * Formats an warning result bar. |
| 53 | * |
| 54 | * @param string|array $message |
| 55 | */ |
| 56 | public function warning($message); |
| 57 | /** |
| 58 | * Formats a note admonition. |
| 59 | * |
| 60 | * @param string|array $message |
| 61 | */ |
| 62 | public function note($message); |
| 63 | /** |
| 64 | * Formats a caution admonition. |
| 65 | * |
| 66 | * @param string|array $message |
| 67 | */ |
| 68 | public function caution($message); |
| 69 | /** |
| 70 | * Formats a table. |
| 71 | */ |
| 72 | public function table(array $headers, array $rows); |
| 73 | /** |
| 74 | * Asks a question. |
| 75 | * |
| 76 | * @return mixed |
| 77 | */ |
| 78 | public function ask(string $question, string $default = null, callable $validator = null); |
| 79 | /** |
| 80 | * Asks a question with the user input hidden. |
| 81 | * |
| 82 | * @return mixed |
| 83 | */ |
| 84 | public function askHidden(string $question, callable $validator = null); |
| 85 | /** |
| 86 | * Asks for confirmation. |
| 87 | * |
| 88 | * @return bool |
| 89 | */ |
| 90 | public function confirm(string $question, bool $default = \true); |
| 91 | /** |
| 92 | * Asks a choice question. |
| 93 | * |
| 94 | * @param string|int|null $default |
| 95 | * |
| 96 | * @return mixed |
| 97 | */ |
| 98 | public function choice(string $question, array $choices, $default = null); |
| 99 | /** |
| 100 | * Add newline(s). |
| 101 | */ |
| 102 | public function newLine(int $count = 1); |
| 103 | /** |
| 104 | * Starts the progress output. |
| 105 | */ |
| 106 | public function progressStart(int $max = 0); |
| 107 | /** |
| 108 | * Advances the progress output X steps. |
| 109 | */ |
| 110 | public function progressAdvance(int $step = 1); |
| 111 | /** |
| 112 | * Finishes the progress output. |
| 113 | */ |
| 114 | public function progressFinish(); |
| 115 | } |
| 116 |