annotate vendor/symfony/console/Helper/SymfonyQuestionHelper.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 129ea1e6d783
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\Helper;
Chris@0 13
Chris@0 14 use Symfony\Component\Console\Exception\LogicException;
Chris@17 15 use Symfony\Component\Console\Formatter\OutputFormatter;
Chris@0 16 use Symfony\Component\Console\Input\InputInterface;
Chris@0 17 use Symfony\Component\Console\Output\OutputInterface;
Chris@0 18 use Symfony\Component\Console\Question\ChoiceQuestion;
Chris@0 19 use Symfony\Component\Console\Question\ConfirmationQuestion;
Chris@0 20 use Symfony\Component\Console\Question\Question;
Chris@0 21 use Symfony\Component\Console\Style\SymfonyStyle;
Chris@0 22
Chris@0 23 /**
Chris@0 24 * Symfony Style Guide compliant question helper.
Chris@0 25 *
Chris@0 26 * @author Kevin Bond <kevinbond@gmail.com>
Chris@0 27 */
Chris@0 28 class SymfonyQuestionHelper extends QuestionHelper
Chris@0 29 {
Chris@0 30 /**
Chris@0 31 * {@inheritdoc}
Chris@14 32 *
Chris@14 33 * To be removed in 4.0
Chris@0 34 */
Chris@0 35 public function ask(InputInterface $input, OutputInterface $output, Question $question)
Chris@0 36 {
Chris@0 37 $validator = $question->getValidator();
Chris@0 38 $question->setValidator(function ($value) use ($validator) {
Chris@0 39 if (null !== $validator) {
Chris@0 40 $value = $validator($value);
Chris@0 41 } else {
Chris@0 42 // make required
Chris@17 43 if (!\is_array($value) && !\is_bool($value) && 0 === \strlen($value)) {
Chris@14 44 @trigger_error('The default question validator is deprecated since Symfony 3.3 and will not be used anymore in version 4.0. Set a custom question validator if needed.', E_USER_DEPRECATED);
Chris@14 45
Chris@0 46 throw new LogicException('A value is required.');
Chris@0 47 }
Chris@0 48 }
Chris@0 49
Chris@0 50 return $value;
Chris@0 51 });
Chris@0 52
Chris@0 53 return parent::ask($input, $output, $question);
Chris@0 54 }
Chris@0 55
Chris@0 56 /**
Chris@0 57 * {@inheritdoc}
Chris@0 58 */
Chris@0 59 protected function writePrompt(OutputInterface $output, Question $question)
Chris@0 60 {
Chris@0 61 $text = OutputFormatter::escapeTrailingBackslash($question->getQuestion());
Chris@0 62 $default = $question->getDefault();
Chris@0 63
Chris@0 64 switch (true) {
Chris@0 65 case null === $default:
Chris@0 66 $text = sprintf(' <info>%s</info>:', $text);
Chris@0 67
Chris@0 68 break;
Chris@0 69
Chris@0 70 case $question instanceof ConfirmationQuestion:
Chris@0 71 $text = sprintf(' <info>%s (yes/no)</info> [<comment>%s</comment>]:', $text, $default ? 'yes' : 'no');
Chris@0 72
Chris@0 73 break;
Chris@0 74
Chris@0 75 case $question instanceof ChoiceQuestion && $question->isMultiselect():
Chris@0 76 $choices = $question->getChoices();
Chris@0 77 $default = explode(',', $default);
Chris@0 78
Chris@0 79 foreach ($default as $key => $value) {
Chris@0 80 $default[$key] = $choices[trim($value)];
Chris@0 81 }
Chris@0 82
Chris@0 83 $text = sprintf(' <info>%s</info> [<comment>%s</comment>]:', $text, OutputFormatter::escape(implode(', ', $default)));
Chris@0 84
Chris@0 85 break;
Chris@0 86
Chris@0 87 case $question instanceof ChoiceQuestion:
Chris@0 88 $choices = $question->getChoices();
Chris@17 89 $text = sprintf(' <info>%s</info> [<comment>%s</comment>]:', $text, OutputFormatter::escape(isset($choices[$default]) ? $choices[$default] : $default));
Chris@0 90
Chris@0 91 break;
Chris@0 92
Chris@0 93 default:
Chris@0 94 $text = sprintf(' <info>%s</info> [<comment>%s</comment>]:', $text, OutputFormatter::escape($default));
Chris@0 95 }
Chris@0 96
Chris@0 97 $output->writeln($text);
Chris@0 98
Chris@0 99 if ($question instanceof ChoiceQuestion) {
Chris@0 100 $width = max(array_map('strlen', array_keys($question->getChoices())));
Chris@0 101
Chris@0 102 foreach ($question->getChoices() as $key => $value) {
Chris@0 103 $output->writeln(sprintf(" [<comment>%-${width}s</comment>] %s", $key, $value));
Chris@0 104 }
Chris@0 105 }
Chris@0 106
Chris@0 107 $output->write(' > ');
Chris@0 108 }
Chris@0 109
Chris@0 110 /**
Chris@0 111 * {@inheritdoc}
Chris@0 112 */
Chris@0 113 protected function writeError(OutputInterface $output, \Exception $error)
Chris@0 114 {
Chris@0 115 if ($output instanceof SymfonyStyle) {
Chris@0 116 $output->newLine();
Chris@0 117 $output->error($error->getMessage());
Chris@0 118
Chris@0 119 return;
Chris@0 120 }
Chris@0 121
Chris@0 122 parent::writeError($output, $error);
Chris@0 123 }
Chris@0 124 }