class Question
Represents a Question.
@author Fabien Potencier <fabien@symfony.com>
Hierarchy
- class \Symfony\Component\Console\Question\Question
Expanded class hierarchy of Question
5 files declare their use of Question
- ConsoleIO.php in vendor/
composer/ composer/ src/ Composer/ IO/ ConsoleIO.php - QuestionHelper.php in vendor/
symfony/ console/ Helper/ QuestionHelper.php - StrictConfirmationQuestion.php in vendor/
composer/ composer/ src/ Composer/ Question/ StrictConfirmationQuestion.php - SymfonyQuestionHelper.php in vendor/
symfony/ console/ Helper/ SymfonyQuestionHelper.php - SymfonyStyle.php in vendor/
symfony/ console/ Style/ SymfonyStyle.php
7 string references to 'Question'
- ConsoleIO::ask in vendor/
composer/ composer/ src/ Composer/ IO/ ConsoleIO.php - @inheritDoc
- ConsoleIO::askAndHideAnswer in vendor/
composer/ composer/ src/ Composer/ IO/ ConsoleIO.php - @inheritDoc
- ConsoleIO::askAndValidate in vendor/
composer/ composer/ src/ Composer/ IO/ ConsoleIO.php - @inheritDoc
- ConsoleIO::askConfirmation in vendor/
composer/ composer/ src/ Composer/ IO/ ConsoleIO.php - @inheritDoc
- ConsoleIO::select in vendor/
composer/ composer/ src/ Composer/ IO/ ConsoleIO.php - @inheritDoc
File
-
vendor/
symfony/ console/ Question/ Question.php, line 22
Namespace
Symfony\Component\Console\QuestionView source
class Question {
private ?int $attempts = null;
private bool $hidden = false;
private bool $hiddenFallback = true;
private ?\Closure $autocompleterCallback = null;
private ?\Closure $validator = null;
private ?\Closure $normalizer = null;
private bool $trimmable = true;
private bool $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, string|bool|int|float|null $default = null) {
}
/**
* Returns the question.
*/
public function getQuestion() : string {
return $this->question;
}
/**
* Returns the default answer.
*/
public function getDefault() : string|bool|int|float|null {
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) : static {
$this->multiline = $multiline;
return $this;
}
/**
* Returns whether the user response must be hidden.
*/
public function isHidden() : bool {
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) : static {
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.
*/
public function isHiddenFallback() : bool {
return $this->hiddenFallback;
}
/**
* Sets whether to fallback on non-hidden question if the response cannot be hidden.
*
* @return $this
*/
public function setHiddenFallback(bool $fallback) : static {
$this->hiddenFallback = $fallback;
return $this;
}
/**
* Gets values for the autocompleter.
*/
public function getAutocompleterValues() : ?iterable {
$callback = $this->getAutocompleterCallback();
return $callback ? $callback('') : null;
}
/**
* Sets values for the autocompleter.
*
* @return $this
*
* @throws LogicException
*/
public function setAutocompleterValues(?iterable $values) : static {
if (\is_array($values)) {
$values = $this->isAssoc($values) ? array_merge(array_keys($values), array_values($values)) : array_values($values);
$callback = static fn() => $values;
}
elseif ($values instanceof \Traversable) {
$callback = static function () use ($values) {
static $valueCache;
return $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) : static {
if ($this->hidden && null !== $callback) {
throw new LogicException('A hidden question cannot use the autocompleter.');
}
$this->autocompleterCallback = null === $callback ? null : $callback(...);
return $this;
}
/**
* Sets a validator for the question.
*
* @return $this
*/
public function setValidator(?callable $validator) : static {
$this->validator = null === $validator ? null : $validator(...);
return $this;
}
/**
* Gets the validator for the question.
*/
public function getValidator() : ?callable {
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) : static {
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.
*/
public function getMaxAttempts() : ?int {
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) : static {
$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.
*/
public function getNormalizer() : ?callable {
return $this->normalizer;
}
protected function isAssoc(array $array) : bool {
return (bool) \count(array_filter(array_keys($array), 'is_string'));
}
public function isTrimmable() : bool {
return $this->trimmable;
}
/**
* @return $this
*/
public function setTrimmable(bool $trimmable) : static {
$this->trimmable = $trimmable;
return $this;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overrides |
---|---|---|---|---|
Question::$attempts | private | property | ||
Question::$autocompleterCallback | private | property | ||
Question::$hidden | private | property | ||
Question::$hiddenFallback | private | property | ||
Question::$multiline | private | property | ||
Question::$normalizer | private | property | ||
Question::$trimmable | private | property | ||
Question::$validator | private | property | ||
Question::getAutocompleterCallback | public | function | Gets the callback function used for the autocompleter. | |
Question::getAutocompleterValues | public | function | Gets values for the autocompleter. | |
Question::getDefault | public | function | Returns the default answer. | |
Question::getMaxAttempts | public | function | Gets the maximum number of attempts. | |
Question::getNormalizer | public | function | Gets the normalizer for the response. | |
Question::getQuestion | public | function | Returns the question. | |
Question::getValidator | public | function | Gets the validator for the question. | |
Question::isAssoc | protected | function | ||
Question::isHidden | public | function | Returns whether the user response must be hidden. | |
Question::isHiddenFallback | public | function | In case the response cannot be hidden, whether to fallback on non-hidden question or not. | |
Question::isMultiline | public | function | Returns whether the user response accepts newline characters. | |
Question::isTrimmable | public | function | ||
Question::setAutocompleterCallback | public | function | Sets the callback function used for the autocompleter. | |
Question::setAutocompleterValues | public | function | Sets values for the autocompleter. | |
Question::setHidden | public | function | Sets whether the user response must be hidden or not. | |
Question::setHiddenFallback | public | function | Sets whether to fallback on non-hidden question if the response cannot be hidden. | |
Question::setMaxAttempts | public | function | Sets the maximum number of attempts. | |
Question::setMultiline | public | function | Sets whether the user response should accept newline characters. | |
Question::setNormalizer | public | function | Sets a normalizer for the response. | |
Question::setTrimmable | public | function | ||
Question::setValidator | public | function | Sets a validator for the question. | |
Question::__construct | public | function | 3 |