| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406 | <?php/* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */namespace Symfony\Component\Console\Style;use Symfony\Component\Console\Application;use Symfony\Component\Console\Formatter\OutputFormatter;use Symfony\Component\Console\Helper\Helper;use Symfony\Component\Console\Helper\ProgressBar;use Symfony\Component\Console\Helper\SymfonyQuestionHelper;use Symfony\Component\Console\Helper\Table;use Symfony\Component\Console\Input\InputInterface;use Symfony\Component\Console\Output\BufferedOutput;use Symfony\Component\Console\Output\OutputInterface;use Symfony\Component\Console\Question\ChoiceQuestion;use Symfony\Component\Console\Question\ConfirmationQuestion;use Symfony\Component\Console\Question\Question;/** * Output decorator helpers for the Symfony Style Guide. * * @author Kevin Bond <kevinbond@gmail.com> */class SymfonyStyle extends OutputStyle{    const MAX_LINE_LENGTH = 120;    private $input;    private $questionHelper;    private $progressBar;    private $lineLength;    private $bufferedOutput;    /**     * @param InputInterface  $input     * @param OutputInterface $output     */    public function __construct(InputInterface $input, OutputInterface $output)    {        $this->input = $input;        $this->bufferedOutput = new BufferedOutput($output->getVerbosity(), false, clone $output->getFormatter());        // Windows cmd wraps lines as soon as the terminal width is reached, whether there are following chars or not.        $this->lineLength = min($this->getTerminalWidth() - (int) (DIRECTORY_SEPARATOR === '\\'), self::MAX_LINE_LENGTH);        parent::__construct($output);    }    /**     * Formats a message as a block of text.     *     * @param string|array $messages The message to write in the block     * @param string|null  $type     The block type (added in [] on first line)     * @param string|null  $style    The style to apply to the whole block     * @param string       $prefix   The prefix for the block     * @param bool         $padding  Whether to add vertical padding     */    public function block($messages, $type = null, $style = null, $prefix = ' ', $padding = false)    {        $this->autoPrependBlock();        $messages = is_array($messages) ? array_values($messages) : array($messages);        $lines = array();        // add type        if (null !== $type) {            $messages[0] = sprintf('[%s] %s', $type, $messages[0]);        }        // wrap and add newlines for each element        foreach ($messages as $key => $message) {            $message = OutputFormatter::escape($message);            $lines = array_merge($lines, explode(PHP_EOL, wordwrap($message, $this->lineLength - Helper::strlen($prefix), PHP_EOL, true)));            if (count($messages) > 1 && $key < count($messages) - 1) {                $lines[] = '';            }        }        if ($padding && $this->isDecorated()) {            array_unshift($lines, '');            $lines[] = '';        }        foreach ($lines as &$line) {            $line = sprintf('%s%s', $prefix, $line);            $line .= str_repeat(' ', $this->lineLength - Helper::strlenWithoutDecoration($this->getFormatter(), $line));            if ($style) {                $line = sprintf('<%s>%s</>', $style, $line);            }        }        $this->writeln($lines);        $this->newLine();    }    /**     * {@inheritdoc}     */    public function title($message)    {        $this->autoPrependBlock();        $this->writeln(array(            sprintf('<comment>%s</>', $message),            sprintf('<comment>%s</>', str_repeat('=', strlen($message))),        ));        $this->newLine();    }    /**     * {@inheritdoc}     */    public function section($message)    {        $this->autoPrependBlock();        $this->writeln(array(            sprintf('<comment>%s</>', $message),            sprintf('<comment>%s</>', str_repeat('-', strlen($message))),        ));        $this->newLine();    }    /**     * {@inheritdoc}     */    public function listing(array $elements)    {        $this->autoPrependText();        $elements = array_map(function ($element) {            return sprintf(' * %s', $element);        }, $elements);        $this->writeln($elements);        $this->newLine();    }    /**     * {@inheritdoc}     */    public function text($message)    {        $this->autoPrependText();        if (!is_array($message)) {            $this->writeln(sprintf(' // %s', $message));            return;        }        foreach ($message as $element) {            $this->text($element);        }    }    /**     * {@inheritdoc}     */    public function success($message)    {        $this->block($message, 'OK', 'fg=white;bg=green', ' ', true);    }    /**     * {@inheritdoc}     */    public function error($message)    {        $this->block($message, 'ERROR', 'fg=white;bg=red', ' ', true);    }    /**     * {@inheritdoc}     */    public function warning($message)    {        $this->block($message, 'WARNING', 'fg=white;bg=red', ' ', true);    }    /**     * {@inheritdoc}     */    public function note($message)    {        $this->block($message, 'NOTE', 'fg=yellow', ' ! ');    }    /**     * {@inheritdoc}     */    public function caution($message)    {        $this->block($message, 'CAUTION', 'fg=white;bg=red', ' ! ', true);    }    /**     * {@inheritdoc}     */    public function table(array $headers, array $rows)    {        $headers = array_map(function ($value) { return sprintf('<info>%s</>', $value); }, $headers);        $table = new Table($this);        $table->setHeaders($headers);        $table->setRows($rows);        $table->setStyle('symfony-style-guide');        $table->render();        $this->newLine();    }    /**     * {@inheritdoc}     */    public function ask($question, $default = null, $validator = null)    {        $question = new Question($question, $default);        $question->setValidator($validator);        return $this->askQuestion($question);    }    /**     * {@inheritdoc}     */    public function askHidden($question, $validator = null)    {        $question = new Question($question);        $question->setHidden(true);        $question->setValidator($validator);        return $this->askQuestion($question);    }    /**     * {@inheritdoc}     */    public function confirm($question, $default = true)    {        return $this->askQuestion(new ConfirmationQuestion($question, $default));    }    /**     * {@inheritdoc}     */    public function choice($question, array $choices, $default = null)    {        if (null !== $default) {            $values = array_flip($choices);            $default = $values[$default];        }        return $this->askQuestion(new ChoiceQuestion($question, $choices, $default));    }    /**     * {@inheritdoc}     */    public function progressStart($max = 0)    {        $this->progressBar = $this->createProgressBar($max);        $this->progressBar->start();    }    /**     * {@inheritdoc}     */    public function progressAdvance($step = 1)    {        $this->getProgressBar()->advance($step);    }    /**     * {@inheritdoc}     */    public function progressFinish()    {        $this->getProgressBar()->finish();        $this->newLine(2);        $this->progressBar = null;    }    /**     * {@inheritdoc}     */    public function createProgressBar($max = 0)    {        $progressBar = parent::createProgressBar($max);        if ('\\' === DIRECTORY_SEPARATOR) {            $progressBar->setEmptyBarCharacter('░'); // light shade character \u2591            $progressBar->setProgressCharacter('');            $progressBar->setBarCharacter('▓'); // dark shade character \u2593        }        return $progressBar;    }    /**     * @param Question $question     *     * @return string     */    public function askQuestion(Question $question)    {        if ($this->input->isInteractive()) {            $this->autoPrependBlock();        }        if (!$this->questionHelper) {            $this->questionHelper = new SymfonyQuestionHelper();        }        $answer = $this->questionHelper->ask($this->input, $this, $question);        if ($this->input->isInteractive()) {            $this->newLine();            $this->bufferedOutput->write("\n");        }        return $answer;    }    /**     * {@inheritdoc}     */    public function writeln($messages, $type = self::OUTPUT_NORMAL)    {        parent::writeln($messages, $type);        $this->bufferedOutput->writeln($this->reduceBuffer($messages), $type);    }    /**     * {@inheritdoc}     */    public function write($messages, $newline = false, $type = self::OUTPUT_NORMAL)    {        parent::write($messages, $newline, $type);        $this->bufferedOutput->write($this->reduceBuffer($messages), $newline, $type);    }    /**     * {@inheritdoc}     */    public function newLine($count = 1)    {        parent::newLine($count);        $this->bufferedOutput->write(str_repeat("\n", $count));    }    /**     * @return ProgressBar     */    private function getProgressBar()    {        if (!$this->progressBar) {            throw new \RuntimeException('The ProgressBar is not started.');        }        return $this->progressBar;    }    private function getTerminalWidth()    {        $application = new Application();        $dimensions = $application->getTerminalDimensions();        return $dimensions[0] ?: self::MAX_LINE_LENGTH;    }    private function autoPrependBlock()    {        $chars = substr(str_replace(PHP_EOL, "\n", $this->bufferedOutput->fetch()), -2);        if (!isset($chars[0])) {            return $this->newLine(); //empty history, so we should start with a new line.        }        //Prepend new line for each non LF chars (This means no blank line was output before)        $this->newLine(2 - substr_count($chars, "\n"));    }    private function autoPrependText()    {        $fetched = $this->bufferedOutput->fetch();        //Prepend new line if last char isn't EOL:        if ("\n" !== substr($fetched, -1)) {            $this->newLine();        }    }    private function reduceBuffer($messages)    {        // We need to know if the two last chars are PHP_EOL        // Preserve the last 4 chars inserted (PHP_EOL on windows is two chars) in the history buffer        return array_map(function ($value) {            return substr($value, -4);        }, array_merge(array($this->bufferedOutput->fetch()), (array) $messages));    }}
 |