class ChoiceQuestion
Represents a choice question.
@author Fabien Potencier <fabien@symfony.com>
Hierarchy
- class \Symfony\Component\Console\Question\Question
- class \Symfony\Component\Console\Question\ChoiceQuestion extends \Symfony\Component\Console\Question\Question
Expanded class hierarchy of ChoiceQuestion
4 files declare their use of ChoiceQuestion
- ConsoleIO.php in vendor/
composer/ composer/ src/ Composer/ IO/ ConsoleIO.php - QuestionHelper.php in vendor/
symfony/ console/ Helper/ QuestionHelper.php - SymfonyQuestionHelper.php in vendor/
symfony/ console/ Helper/ SymfonyQuestionHelper.php - SymfonyStyle.php in vendor/
symfony/ console/ Style/ SymfonyStyle.php
File
-
vendor/
symfony/ console/ Question/ ChoiceQuestion.php, line 21
Namespace
Symfony\Component\Console\QuestionView source
class ChoiceQuestion extends Question {
private bool $multiselect = false;
private string $prompt = ' > ';
private string $errorMessage = 'Value "%s" is invalid';
/**
* @param string $question The question to ask to the user
* @param array $choices The list of available choices
* @param string|bool|int|float|null $default The default answer to return
*/
public function __construct(string $question, array $choices, string|bool|int|float|null $default = null) {
if (!$choices) {
throw new \LogicException('Choice question must have at least 1 choice available.');
}
parent::__construct($question, $default);
$this->setValidator($this->getDefaultValidator());
$this->setAutocompleterValues($choices);
}
/**
* Returns available choices.
*/
public function getChoices() : array {
return $this->choices;
}
/**
* Sets multiselect option.
*
* When multiselect is set to true, multiple choices can be answered.
*
* @return $this
*/
public function setMultiselect(bool $multiselect) : static {
$this->multiselect = $multiselect;
$this->setValidator($this->getDefaultValidator());
return $this;
}
/**
* Returns whether the choices are multiselect.
*/
public function isMultiselect() : bool {
return $this->multiselect;
}
/**
* Gets the prompt for choices.
*/
public function getPrompt() : string {
return $this->prompt;
}
/**
* Sets the prompt for choices.
*
* @return $this
*/
public function setPrompt(string $prompt) : static {
$this->prompt = $prompt;
return $this;
}
/**
* Sets the error message for invalid values.
*
* The error message has a string placeholder (%s) for the invalid value.
*
* @return $this
*/
public function setErrorMessage(string $errorMessage) : static {
$this->errorMessage = $errorMessage;
$this->setValidator($this->getDefaultValidator());
return $this;
}
private function getDefaultValidator() : callable {
$choices = $this->choices;
$errorMessage = $this->errorMessage;
$multiselect = $this->multiselect;
$isAssoc = $this->isAssoc($choices);
return function ($selected) use ($choices, $errorMessage, $multiselect, $isAssoc) {
if ($multiselect) {
// Check for a separated comma values
if (!preg_match('/^[^,]+(?:,[^,]+)*$/', (string) $selected, $matches)) {
throw new InvalidArgumentException(\sprintf($errorMessage, $selected));
}
$selectedChoices = explode(',', (string) $selected);
}
else {
$selectedChoices = [
$selected,
];
}
if ($this->isTrimmable()) {
foreach ($selectedChoices as $k => $v) {
$selectedChoices[$k] = trim((string) $v);
}
}
$multiselectChoices = [];
foreach ($selectedChoices as $value) {
$results = [];
foreach ($choices as $key => $choice) {
if ($choice === $value) {
$results[] = $key;
}
}
if (\count($results) > 1) {
throw new InvalidArgumentException(\sprintf('The provided answer is ambiguous. Value should be one of "%s".', implode('" or "', $results)));
}
$result = array_search($value, $choices);
if (!$isAssoc) {
if (false !== $result) {
$result = $choices[$result];
}
elseif (isset($choices[$value])) {
$result = $choices[$value];
}
}
elseif (false === $result && isset($choices[$value])) {
$result = $value;
}
if (false === $result) {
throw new InvalidArgumentException(\sprintf($errorMessage, $value));
}
// For associative choices, consistently return the key as string:
$multiselectChoices[] = $isAssoc ? (string) $result : $result;
}
if ($multiselect) {
return $multiselectChoices;
}
return current($multiselectChoices);
};
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
ChoiceQuestion::$errorMessage | private | property | ||
ChoiceQuestion::$multiselect | private | property | ||
ChoiceQuestion::$prompt | private | property | ||
ChoiceQuestion::getChoices | public | function | Returns available choices. | |
ChoiceQuestion::getDefaultValidator | private | function | ||
ChoiceQuestion::getPrompt | public | function | Gets the prompt for choices. | |
ChoiceQuestion::isMultiselect | public | function | Returns whether the choices are multiselect. | |
ChoiceQuestion::setErrorMessage | public | function | Sets the error message for invalid values. | |
ChoiceQuestion::setMultiselect | public | function | Sets multiselect option. | |
ChoiceQuestion::setPrompt | public | function | Sets the prompt for choices. | |
ChoiceQuestion::__construct | public | function | Overrides Question::__construct | |
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. |