class ChoiceQuestion extends Question
Represents a choice question.
Methods
| __construct(string $question, array $choices, mixed $default = null) Constructor. | ||
| string | getQuestion() Returns the question. | from Question |
| mixed | getDefault() Returns the default answer. | from Question |
| bool | isHidden() Returns whether the user response must be hidden. | from Question |
| Question | setHidden(bool $hidden) Sets whether the user response must be hidden or not. | from Question |
| bool | isHiddenFallback() In case the response can not be hidden, whether to fallback on non-hidden question or not. | from Question |
| Question | setHiddenFallback(bool $fallback) Sets whether to fallback on non-hidden question if the response can not be hidden. | from Question |
| null|array|Traversable | getAutocompleterValues() Gets values for the autocompleter. | from Question |
| Question | setAutocompleterValues(null|array|Traversable $values) Sets values for the autocompleter. | from Question |
| Question | setValidator(callable $validator = null) Sets a validator for the question. | from Question |
| null|callable | getValidator() Gets the validator for the question. | from Question |
| Question | setMaxAttempts(null|int $attempts) Sets the maximum number of attempts. | from Question |
| null|int | getMaxAttempts() Gets the maximum number of attempts. | from Question |
| Question | setNormalizer(callable $normalizer) Sets a normalizer for the response. | from Question |
| callable | getNormalizer() Gets the normalizer for the response. | from Question |
| array | getChoices() Returns available choices. | |
| ChoiceQuestion | setMultiselect(bool $multiselect) Sets multiselect option. | |
| bool | isMultiselect() Returns whether the choices are multiselect. | |
| string | getPrompt() Gets the prompt for choices. | |
| ChoiceQuestion | setPrompt(string $prompt) Sets the prompt for choices. | |
| ChoiceQuestion | setErrorMessage(string $errorMessage) Sets the error message for invalid values. |
Details
__construct(string $question, array $choices, mixed $default = null)
Constructor.
string getQuestion()
Returns the question.
mixed getDefault()
Returns the default answer.
bool isHidden()
Returns whether the user response must be hidden.
Question setHidden(bool $hidden)
Sets whether the user response must be hidden or not.
bool isHiddenFallback()
In case the response can not be hidden, whether to fallback on non-hidden question or not.
Question setHiddenFallback(bool $fallback)
Sets whether to fallback on non-hidden question if the response can not be hidden.
null|array|Traversable getAutocompleterValues()
Gets values for the autocompleter.
Question setAutocompleterValues(null|array|Traversable $values)
Sets values for the autocompleter.
Question setValidator(callable $validator = null)
Sets a validator for the question.
null|callable getValidator()
Gets the validator for the question.
Question setMaxAttempts(null|int $attempts)
Sets the maximum number of attempts.
Null means an unlimited number of attempts.
null|int getMaxAttempts()
Gets the maximum number of attempts.
Null means an unlimited number of attempts.
Question setNormalizer(callable $normalizer)
Sets a normalizer for the response.
The normalizer can be a callable (a string), a closure or a class implementing __invoke.
callable getNormalizer()
Gets the normalizer for the response.
The normalizer can ba a callable (a string), a closure or a class implementing __invoke.
array getChoices()
Returns available choices.
ChoiceQuestion setMultiselect(bool $multiselect)
Sets multiselect option.
When multiselect is set to true, multiple choices can be answered.
bool isMultiselect()
Returns whether the choices are multiselect.
string getPrompt()
Gets the prompt for choices.
ChoiceQuestion setPrompt(string $prompt)
Sets the prompt for choices.
ChoiceQuestion setErrorMessage(string $errorMessage)
Sets the error message for invalid values.
The error message has a string placeholder (%s) for the invalid value.
Please login to continue.