annotate vendor/symfony/console/Style/StyleInterface.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 1fec387a4317
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 /*
Chris@0 4 * This file is part of the Symfony package.
Chris@0 5 *
Chris@0 6 * (c) Fabien Potencier <fabien@symfony.com>
Chris@0 7 *
Chris@0 8 * For the full copyright and license information, please view the LICENSE
Chris@0 9 * file that was distributed with this source code.
Chris@0 10 */
Chris@0 11
Chris@0 12 namespace Symfony\Component\Console\Style;
Chris@0 13
Chris@0 14 /**
Chris@0 15 * Output style helpers.
Chris@0 16 *
Chris@0 17 * @author Kevin Bond <kevinbond@gmail.com>
Chris@0 18 */
Chris@0 19 interface StyleInterface
Chris@0 20 {
Chris@0 21 /**
Chris@0 22 * Formats a command title.
Chris@0 23 *
Chris@0 24 * @param string $message
Chris@0 25 */
Chris@0 26 public function title($message);
Chris@0 27
Chris@0 28 /**
Chris@0 29 * Formats a section title.
Chris@0 30 *
Chris@0 31 * @param string $message
Chris@0 32 */
Chris@0 33 public function section($message);
Chris@0 34
Chris@0 35 /**
Chris@0 36 * Formats a list.
Chris@0 37 */
Chris@0 38 public function listing(array $elements);
Chris@0 39
Chris@0 40 /**
Chris@0 41 * Formats informational text.
Chris@0 42 *
Chris@0 43 * @param string|array $message
Chris@0 44 */
Chris@0 45 public function text($message);
Chris@0 46
Chris@0 47 /**
Chris@0 48 * Formats a success result bar.
Chris@0 49 *
Chris@0 50 * @param string|array $message
Chris@0 51 */
Chris@0 52 public function success($message);
Chris@0 53
Chris@0 54 /**
Chris@0 55 * Formats an error result bar.
Chris@0 56 *
Chris@0 57 * @param string|array $message
Chris@0 58 */
Chris@0 59 public function error($message);
Chris@0 60
Chris@0 61 /**
Chris@0 62 * Formats an warning result bar.
Chris@0 63 *
Chris@0 64 * @param string|array $message
Chris@0 65 */
Chris@0 66 public function warning($message);
Chris@0 67
Chris@0 68 /**
Chris@0 69 * Formats a note admonition.
Chris@0 70 *
Chris@0 71 * @param string|array $message
Chris@0 72 */
Chris@0 73 public function note($message);
Chris@0 74
Chris@0 75 /**
Chris@0 76 * Formats a caution admonition.
Chris@0 77 *
Chris@0 78 * @param string|array $message
Chris@0 79 */
Chris@0 80 public function caution($message);
Chris@0 81
Chris@0 82 /**
Chris@0 83 * Formats a table.
Chris@0 84 */
Chris@0 85 public function table(array $headers, array $rows);
Chris@0 86
Chris@0 87 /**
Chris@0 88 * Asks a question.
Chris@0 89 *
Chris@0 90 * @param string $question
Chris@0 91 * @param string|null $default
Chris@0 92 * @param callable|null $validator
Chris@0 93 *
Chris@14 94 * @return mixed
Chris@0 95 */
Chris@0 96 public function ask($question, $default = null, $validator = null);
Chris@0 97
Chris@0 98 /**
Chris@0 99 * Asks a question with the user input hidden.
Chris@0 100 *
Chris@0 101 * @param string $question
Chris@0 102 * @param callable|null $validator
Chris@0 103 *
Chris@14 104 * @return mixed
Chris@0 105 */
Chris@0 106 public function askHidden($question, $validator = null);
Chris@0 107
Chris@0 108 /**
Chris@0 109 * Asks for confirmation.
Chris@0 110 *
Chris@0 111 * @param string $question
Chris@0 112 * @param bool $default
Chris@0 113 *
Chris@0 114 * @return bool
Chris@0 115 */
Chris@0 116 public function confirm($question, $default = true);
Chris@0 117
Chris@0 118 /**
Chris@0 119 * Asks a choice question.
Chris@0 120 *
Chris@0 121 * @param string $question
Chris@0 122 * @param array $choices
Chris@0 123 * @param string|int|null $default
Chris@0 124 *
Chris@14 125 * @return mixed
Chris@0 126 */
Chris@0 127 public function choice($question, array $choices, $default = null);
Chris@0 128
Chris@0 129 /**
Chris@0 130 * Add newline(s).
Chris@0 131 *
Chris@0 132 * @param int $count The number of newlines
Chris@0 133 */
Chris@0 134 public function newLine($count = 1);
Chris@0 135
Chris@0 136 /**
Chris@0 137 * Starts the progress output.
Chris@0 138 *
Chris@0 139 * @param int $max Maximum steps (0 if unknown)
Chris@0 140 */
Chris@0 141 public function progressStart($max = 0);
Chris@0 142
Chris@0 143 /**
Chris@0 144 * Advances the progress output X steps.
Chris@0 145 *
Chris@0 146 * @param int $step Number of steps to advance
Chris@0 147 */
Chris@0 148 public function progressAdvance($step = 1);
Chris@0 149
Chris@0 150 /**
Chris@0 151 * Finishes the progress output.
Chris@0 152 */
Chris@0 153 public function progressFinish();
Chris@0 154 }