300 lines
6.8 KiB
PHP
300 lines
6.8 KiB
PHP
<?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 string|bool|int|float|null $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 string|bool|int|float|null
|
|
*/
|
|
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.
|
|
*
|
|
* @return $this
|
|
*
|
|
* @throws LogicException In case the autocompleter is also used
|
|
*/
|
|
public function setHidden(bool $hidden)
|
|
{
|
|
if ($this->autocompleterCallback) {
|
|
throw new LogicException('A hidden question cannot use the autocompleter.');
|
|
}
|
|
|
|
$this->hidden = $hidden;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* In case the response cannot 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 cannot be hidden.
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setHiddenFallback(bool $fallback)
|
|
{
|
|
$this->hiddenFallback = $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 < 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;
|
|
}
|
|
}
|