Chris@0: <?php
Chris@0: 
Chris@0: /*
Chris@0:  * This file is part of the Symfony package.
Chris@0:  *
Chris@0:  * (c) Fabien Potencier <fabien@symfony.com>
Chris@0:  *
Chris@0:  * For the full copyright and license information, please view the LICENSE
Chris@0:  * file that was distributed with this source code.
Chris@0:  */
Chris@0: 
Chris@0: namespace Symfony\Component\Console\Style;
Chris@0: 
Chris@0: /**
Chris@0:  * Output style helpers.
Chris@0:  *
Chris@0:  * @author Kevin Bond <kevinbond@gmail.com>
Chris@0:  */
Chris@0: interface StyleInterface
Chris@0: {
Chris@0:     /**
Chris@0:      * Formats a command title.
Chris@0:      *
Chris@0:      * @param string $message
Chris@0:      */
Chris@0:     public function title($message);
Chris@0: 
Chris@0:     /**
Chris@0:      * Formats a section title.
Chris@0:      *
Chris@0:      * @param string $message
Chris@0:      */
Chris@0:     public function section($message);
Chris@0: 
Chris@0:     /**
Chris@0:      * Formats a list.
Chris@0:      */
Chris@0:     public function listing(array $elements);
Chris@0: 
Chris@0:     /**
Chris@0:      * Formats informational text.
Chris@0:      *
Chris@0:      * @param string|array $message
Chris@0:      */
Chris@0:     public function text($message);
Chris@0: 
Chris@0:     /**
Chris@0:      * Formats a success result bar.
Chris@0:      *
Chris@0:      * @param string|array $message
Chris@0:      */
Chris@0:     public function success($message);
Chris@0: 
Chris@0:     /**
Chris@0:      * Formats an error result bar.
Chris@0:      *
Chris@0:      * @param string|array $message
Chris@0:      */
Chris@0:     public function error($message);
Chris@0: 
Chris@0:     /**
Chris@0:      * Formats an warning result bar.
Chris@0:      *
Chris@0:      * @param string|array $message
Chris@0:      */
Chris@0:     public function warning($message);
Chris@0: 
Chris@0:     /**
Chris@0:      * Formats a note admonition.
Chris@0:      *
Chris@0:      * @param string|array $message
Chris@0:      */
Chris@0:     public function note($message);
Chris@0: 
Chris@0:     /**
Chris@0:      * Formats a caution admonition.
Chris@0:      *
Chris@0:      * @param string|array $message
Chris@0:      */
Chris@0:     public function caution($message);
Chris@0: 
Chris@0:     /**
Chris@0:      * Formats a table.
Chris@0:      */
Chris@0:     public function table(array $headers, array $rows);
Chris@0: 
Chris@0:     /**
Chris@0:      * Asks a question.
Chris@0:      *
Chris@0:      * @param string        $question
Chris@0:      * @param string|null   $default
Chris@0:      * @param callable|null $validator
Chris@0:      *
Chris@14:      * @return mixed
Chris@0:      */
Chris@0:     public function ask($question, $default = null, $validator = null);
Chris@0: 
Chris@0:     /**
Chris@0:      * Asks a question with the user input hidden.
Chris@0:      *
Chris@0:      * @param string        $question
Chris@0:      * @param callable|null $validator
Chris@0:      *
Chris@14:      * @return mixed
Chris@0:      */
Chris@0:     public function askHidden($question, $validator = null);
Chris@0: 
Chris@0:     /**
Chris@0:      * Asks for confirmation.
Chris@0:      *
Chris@0:      * @param string $question
Chris@0:      * @param bool   $default
Chris@0:      *
Chris@0:      * @return bool
Chris@0:      */
Chris@0:     public function confirm($question, $default = true);
Chris@0: 
Chris@0:     /**
Chris@0:      * Asks a choice question.
Chris@0:      *
Chris@0:      * @param string          $question
Chris@0:      * @param array           $choices
Chris@0:      * @param string|int|null $default
Chris@0:      *
Chris@14:      * @return mixed
Chris@0:      */
Chris@0:     public function choice($question, array $choices, $default = null);
Chris@0: 
Chris@0:     /**
Chris@0:      * Add newline(s).
Chris@0:      *
Chris@0:      * @param int $count The number of newlines
Chris@0:      */
Chris@0:     public function newLine($count = 1);
Chris@0: 
Chris@0:     /**
Chris@0:      * Starts the progress output.
Chris@0:      *
Chris@0:      * @param int $max Maximum steps (0 if unknown)
Chris@0:      */
Chris@0:     public function progressStart($max = 0);
Chris@0: 
Chris@0:     /**
Chris@0:      * Advances the progress output X steps.
Chris@0:      *
Chris@0:      * @param int $step Number of steps to advance
Chris@0:      */
Chris@0:     public function progressAdvance($step = 1);
Chris@0: 
Chris@0:     /**
Chris@0:      * Finishes the progress output.
Chris@0:      */
Chris@0:     public function progressFinish();
Chris@0: }