123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306 |
- <?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\Question;
- use Symfony\Component\Console\Exception\InvalidArgumentException;
- use Symfony\Component\Console\Exception\LogicException;
- /**
- * Represents a Question.
- *
- * @author Fabien Potencier <fabien@symfony.com>
- */
- class Question
- {
- private $question;
- private $attempts;
- private $hidden = false;
- private $hiddenFallback = true;
- private $autocompleterCallback;
- private $validator;
- private $default;
- private $normalizer;
- private $trimmable = true;
- private $multiline = false;
- /**
- * @param string $question The question to ask to the user
- * @param mixed $default The default answer to return if the user enters nothing
- */
- public function __construct(string $question, $default = null)
- {
- $this->question = $question;
- $this->default = $default;
- }
- /**
- * Returns the question.
- *
- * @return string
- */
- public function getQuestion()
- {
- return $this->question;
- }
- /**
- * Returns the default answer.
- *
- * @return mixed
- */
- public function getDefault()
- {
- return $this->default;
- }
- /**
- * Returns whether the user response accepts newline characters.
- */
- public function isMultiline(): bool
- {
- return $this->multiline;
- }
- /**
- * Sets whether the user response should accept newline characters.
- *
- * @return $this
- */
- public function setMultiline(bool $multiline): self
- {
- $this->multiline = $multiline;
- return $this;
- }
- /**
- * Returns whether the user response must be hidden.
- *
- * @return bool
- */
- public function isHidden()
- {
- return $this->hidden;
- }
- /**
- * Sets whether the user response must be hidden or not.
- *
- * @param bool $hidden
- *
- * @return $this
- *
- * @throws LogicException In case the autocompleter is also used
- */
- public function setHidden($hidden)
- {
- if ($this->autocompleterCallback) {
- throw new LogicException('A hidden question cannot use the autocompleter.');
- }
- $this->hidden = (bool) $hidden;
- return $this;
- }
- /**
- * In case the response can not be hidden, whether to fallback on non-hidden question or not.
- *
- * @return bool
- */
- public function isHiddenFallback()
- {
- return $this->hiddenFallback;
- }
- /**
- * Sets whether to fallback on non-hidden question if the response can not be hidden.
- *
- * @param bool $fallback
- *
- * @return $this
- */
- public function setHiddenFallback($fallback)
- {
- $this->hiddenFallback = (bool) $fallback;
- return $this;
- }
- /**
- * Gets values for the autocompleter.
- *
- * @return iterable|null
- */
- public function getAutocompleterValues()
- {
- $callback = $this->getAutocompleterCallback();
- return $callback ? $callback('') : null;
- }
- /**
- * Sets values for the autocompleter.
- *
- * @return $this
- *
- * @throws LogicException
- */
- public function setAutocompleterValues(?iterable $values)
- {
- if (\is_array($values)) {
- $values = $this->isAssoc($values) ? array_merge(array_keys($values), array_values($values)) : array_values($values);
- $callback = static function () use ($values) {
- return $values;
- };
- } elseif ($values instanceof \Traversable) {
- $valueCache = null;
- $callback = static function () use ($values, &$valueCache) {
- return $valueCache ?? $valueCache = iterator_to_array($values, false);
- };
- } else {
- $callback = null;
- }
- return $this->setAutocompleterCallback($callback);
- }
- /**
- * Gets the callback function used for the autocompleter.
- */
- public function getAutocompleterCallback(): ?callable
- {
- return $this->autocompleterCallback;
- }
- /**
- * Sets the callback function used for the autocompleter.
- *
- * The callback is passed the user input as argument and should return an iterable of corresponding suggestions.
- *
- * @return $this
- */
- public function setAutocompleterCallback(callable $callback = null): self
- {
- if ($this->hidden && null !== $callback) {
- throw new LogicException('A hidden question cannot use the autocompleter.');
- }
- $this->autocompleterCallback = $callback;
- return $this;
- }
- /**
- * Sets a validator for the question.
- *
- * @return $this
- */
- public function setValidator(callable $validator = null)
- {
- $this->validator = $validator;
- return $this;
- }
- /**
- * Gets the validator for the question.
- *
- * @return callable|null
- */
- public function getValidator()
- {
- return $this->validator;
- }
- /**
- * Sets the maximum number of attempts.
- *
- * Null means an unlimited number of attempts.
- *
- * @return $this
- *
- * @throws InvalidArgumentException in case the number of attempts is invalid
- */
- public function setMaxAttempts(?int $attempts)
- {
- if (null !== $attempts) {
- $attempts = (int) $attempts;
- if ($attempts < 1) {
- throw new InvalidArgumentException('Maximum number of attempts must be a positive value.');
- }
- }
- $this->attempts = $attempts;
- return $this;
- }
- /**
- * Gets the maximum number of attempts.
- *
- * Null means an unlimited number of attempts.
- *
- * @return int|null
- */
- public function getMaxAttempts()
- {
- return $this->attempts;
- }
- /**
- * Sets a normalizer for the response.
- *
- * The normalizer can be a callable (a string), a closure or a class implementing __invoke.
- *
- * @return $this
- */
- public function setNormalizer(callable $normalizer)
- {
- $this->normalizer = $normalizer;
- return $this;
- }
- /**
- * Gets the normalizer for the response.
- *
- * The normalizer can ba a callable (a string), a closure or a class implementing __invoke.
- *
- * @return callable|null
- */
- public function getNormalizer()
- {
- return $this->normalizer;
- }
- protected function isAssoc(array $array)
- {
- return (bool) \count(array_filter(array_keys($array), 'is_string'));
- }
- public function isTrimmable(): bool
- {
- return $this->trimmable;
- }
- /**
- * @return $this
- */
- public function setTrimmable(bool $trimmable): self
- {
- $this->trimmable = $trimmable;
- return $this;
- }
- }
|