123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513 |
- <?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\Exception\InvalidArgumentException;
- use Symfony\Component\Console\Exception\RuntimeException;
- 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\Helper\TableCell;
- use Symfony\Component\Console\Helper\TableSeparator;
- use Symfony\Component\Console\Input\InputInterface;
- use Symfony\Component\Console\Output\OutputInterface;
- use Symfony\Component\Console\Output\TrimmedBufferOutput;
- use Symfony\Component\Console\Question\ChoiceQuestion;
- use Symfony\Component\Console\Question\ConfirmationQuestion;
- use Symfony\Component\Console\Question\Question;
- use Symfony\Component\Console\Terminal;
- /**
- * Output decorator helpers for the Symfony Style Guide.
- *
- * @author Kevin Bond <kevinbond@gmail.com>
- */
- class SymfonyStyle extends OutputStyle
- {
- public const MAX_LINE_LENGTH = 120;
- private $input;
- private $questionHelper;
- private $progressBar;
- private $lineLength;
- private $bufferedOutput;
- public function __construct(InputInterface $input, OutputInterface $output)
- {
- $this->input = $input;
- $this->bufferedOutput = new TrimmedBufferOutput(\DIRECTORY_SEPARATOR === '\\' ? 4 : 2, $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.
- $width = (new Terminal())->getWidth() ?: self::MAX_LINE_LENGTH;
- $this->lineLength = min($width - (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
- */
- public function block($messages, ?string $type = null, ?string $style = null, string $prefix = ' ', bool $padding = false, bool $escape = true)
- {
- $messages = \is_array($messages) ? array_values($messages) : [$messages];
- $this->autoPrependBlock();
- $this->writeln($this->createBlock($messages, $type, $style, $prefix, $padding, $escape));
- $this->newLine();
- }
- /**
- * {@inheritdoc}
- */
- public function title(string $message)
- {
- $this->autoPrependBlock();
- $this->writeln([
- sprintf('<comment>%s</>', OutputFormatter::escapeTrailingBackslash($message)),
- sprintf('<comment>%s</>', str_repeat('=', Helper::strlenWithoutDecoration($this->getFormatter(), $message))),
- ]);
- $this->newLine();
- }
- /**
- * {@inheritdoc}
- */
- public function section(string $message)
- {
- $this->autoPrependBlock();
- $this->writeln([
- sprintf('<comment>%s</>', OutputFormatter::escapeTrailingBackslash($message)),
- sprintf('<comment>%s</>', str_repeat('-', Helper::strlenWithoutDecoration($this->getFormatter(), $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();
- $messages = \is_array($message) ? array_values($message) : [$message];
- foreach ($messages as $message) {
- $this->writeln(sprintf(' %s', $message));
- }
- }
- /**
- * Formats a command comment.
- *
- * @param string|array $message
- */
- public function comment($message)
- {
- $this->block($message, null, null, '<fg=default;bg=default> // </>', false, false);
- }
- /**
- * {@inheritdoc}
- */
- public function success($message)
- {
- $this->block($message, 'OK', 'fg=black;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=black;bg=yellow', ' ', true);
- }
- /**
- * {@inheritdoc}
- */
- public function note($message)
- {
- $this->block($message, 'NOTE', 'fg=yellow', ' ! ');
- }
- /**
- * Formats an info message.
- *
- * @param string|array $message
- */
- public function info($message)
- {
- $this->block($message, 'INFO', 'fg=green', ' ', true);
- }
- /**
- * {@inheritdoc}
- */
- public function caution($message)
- {
- $this->block($message, 'CAUTION', 'fg=white;bg=red', ' ! ', true);
- }
- /**
- * {@inheritdoc}
- */
- public function table(array $headers, array $rows)
- {
- $style = clone Table::getStyleDefinition('symfony-style-guide');
- $style->setCellHeaderFormat('<info>%s</info>');
- $table = new Table($this);
- $table->setHeaders($headers);
- $table->setRows($rows);
- $table->setStyle($style);
- $table->render();
- $this->newLine();
- }
- /**
- * Formats a horizontal table.
- */
- public function horizontalTable(array $headers, array $rows)
- {
- $style = clone Table::getStyleDefinition('symfony-style-guide');
- $style->setCellHeaderFormat('<info>%s</info>');
- $table = new Table($this);
- $table->setHeaders($headers);
- $table->setRows($rows);
- $table->setStyle($style);
- $table->setHorizontal(true);
- $table->render();
- $this->newLine();
- }
- /**
- * Formats a list of key/value horizontally.
- *
- * Each row can be one of:
- * * 'A title'
- * * ['key' => 'value']
- * * new TableSeparator()
- *
- * @param string|array|TableSeparator ...$list
- */
- public function definitionList(...$list)
- {
- $style = clone Table::getStyleDefinition('symfony-style-guide');
- $style->setCellHeaderFormat('<info>%s</info>');
- $table = new Table($this);
- $headers = [];
- $row = [];
- foreach ($list as $value) {
- if ($value instanceof TableSeparator) {
- $headers[] = $value;
- $row[] = $value;
- continue;
- }
- if (\is_string($value)) {
- $headers[] = new TableCell($value, ['colspan' => 2]);
- $row[] = null;
- continue;
- }
- if (!\is_array($value)) {
- throw new InvalidArgumentException('Value should be an array, string, or an instance of TableSeparator.');
- }
- $headers[] = key($value);
- $row[] = current($value);
- }
- $table->setHeaders($headers);
- $table->setRows([$row]);
- $table->setHorizontal();
- $table->setStyle($style);
- $table->render();
- $this->newLine();
- }
- /**
- * {@inheritdoc}
- */
- public function ask(string $question, ?string $default = null, $validator = null)
- {
- $question = new Question($question, $default);
- $question->setValidator($validator);
- return $this->askQuestion($question);
- }
- /**
- * {@inheritdoc}
- */
- public function askHidden(string $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(string $question, array $choices, $default = null)
- {
- if (null !== $default) {
- $values = array_flip($choices);
- $default = $values[$default] ?? $default;
- }
- return $this->askQuestion(new ChoiceQuestion($question, $choices, $default));
- }
- /**
- * {@inheritdoc}
- */
- public function progressStart(int $max = 0)
- {
- $this->progressBar = $this->createProgressBar($max);
- $this->progressBar->start();
- }
- /**
- * {@inheritdoc}
- */
- public function progressAdvance(int $step = 1)
- {
- $this->getProgressBar()->advance($step);
- }
- /**
- * {@inheritdoc}
- */
- public function progressFinish()
- {
- $this->getProgressBar()->finish();
- $this->newLine(2);
- $this->progressBar = null;
- }
- /**
- * {@inheritdoc}
- */
- public function createProgressBar(int $max = 0)
- {
- $progressBar = parent::createProgressBar($max);
- if ('\\' !== \DIRECTORY_SEPARATOR || 'Hyper' === getenv('TERM_PROGRAM')) {
- $progressBar->setEmptyBarCharacter('░'); // light shade character \u2591
- $progressBar->setProgressCharacter('');
- $progressBar->setBarCharacter('▓'); // dark shade character \u2593
- }
- return $progressBar;
- }
- /**
- * @return mixed
- */
- 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, int $type = self::OUTPUT_NORMAL)
- {
- if (!is_iterable($messages)) {
- $messages = [$messages];
- }
- foreach ($messages as $message) {
- parent::writeln($message, $type);
- $this->writeBuffer($message, true, $type);
- }
- }
- /**
- * {@inheritdoc}
- */
- public function write($messages, bool $newline = false, int $type = self::OUTPUT_NORMAL)
- {
- if (!is_iterable($messages)) {
- $messages = [$messages];
- }
- foreach ($messages as $message) {
- parent::write($message, $newline, $type);
- $this->writeBuffer($message, $newline, $type);
- }
- }
- /**
- * {@inheritdoc}
- */
- public function newLine(int $count = 1)
- {
- parent::newLine($count);
- $this->bufferedOutput->write(str_repeat("\n", $count));
- }
- /**
- * Returns a new instance which makes use of stderr if available.
- *
- * @return self
- */
- public function getErrorStyle()
- {
- return new self($this->input, $this->getErrorOutput());
- }
- private function getProgressBar(): ProgressBar
- {
- if (!$this->progressBar) {
- throw new RuntimeException('The ProgressBar is not started.');
- }
- return $this->progressBar;
- }
- private function autoPrependBlock(): void
- {
- $chars = substr(str_replace(\PHP_EOL, "\n", $this->bufferedOutput->fetch()), -2);
- if (!isset($chars[0])) {
- $this->newLine(); //empty history, so we should start with a new line.
- return;
- }
- //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(): void
- {
- $fetched = $this->bufferedOutput->fetch();
- //Prepend new line if last char isn't EOL:
- if ("\n" !== substr($fetched, -1)) {
- $this->newLine();
- }
- }
- private function writeBuffer(string $message, bool $newLine, int $type): void
- {
- // We need to know if the last chars are PHP_EOL
- $this->bufferedOutput->write($message, $newLine, $type);
- }
- private function createBlock(iterable $messages, string $type = null, string $style = null, string $prefix = ' ', bool $padding = false, bool $escape = false): array
- {
- $indentLength = 0;
- $prefixLength = Helper::strlenWithoutDecoration($this->getFormatter(), $prefix);
- $lines = [];
- if (null !== $type) {
- $type = sprintf('[%s] ', $type);
- $indentLength = \strlen($type);
- $lineIndentation = str_repeat(' ', $indentLength);
- }
- // wrap and add newlines for each element
- foreach ($messages as $key => $message) {
- if ($escape) {
- $message = OutputFormatter::escape($message);
- }
- $decorationLength = Helper::strlen($message) - Helper::strlenWithoutDecoration($this->getFormatter(), $message);
- $messageLineLength = min($this->lineLength - $prefixLength - $indentLength + $decorationLength, $this->lineLength);
- $messageLines = explode(\PHP_EOL, wordwrap($message, $messageLineLength, \PHP_EOL, true));
- foreach ($messageLines as $messageLine) {
- $lines[] = $messageLine;
- }
- if (\count($messages) > 1 && $key < \count($messages) - 1) {
- $lines[] = '';
- }
- }
- $firstLineIndex = 0;
- if ($padding && $this->isDecorated()) {
- $firstLineIndex = 1;
- array_unshift($lines, '');
- $lines[] = '';
- }
- foreach ($lines as $i => &$line) {
- if (null !== $type) {
- $line = $firstLineIndex === $i ? $type.$line : $lineIndentation.$line;
- }
- $line = $prefix.$line;
- $line .= str_repeat(' ', max($this->lineLength - Helper::strlenWithoutDecoration($this->getFormatter(), $line), 0));
- if ($style) {
- $line = sprintf('<%s>%s</>', $style, $line);
- }
- }
- return $lines;
- }
- }
|