ConfirmationQuestion
class ConfirmationQuestion extends Question
Represents a yes/no question.
Methods
__construct(string $question, mixed $default = true, string $trueAnswerRegex = '/^y/i') | ||
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 |
$this | 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 |
$this | setHiddenFallback(bool $fallback) Sets whether to fallback on non-hidden question if the response can not be hidden. | from Question |
null|iterable | getAutocompleterValues() Gets values for the autocompleter. | from Question |
$this | setAutocompleterValues(null|iterable $values) Sets values for the autocompleter. | from Question |
$this | setValidator(callable $validator = null) Sets a validator for the question. | from Question |
null|callable | getValidator() Gets the validator for the question. | from Question |
$this | setMaxAttempts(null|int $attempts) Sets the maximum number of attempts. | from Question |
null|int | getMaxAttempts() Gets the maximum number of attempts. | from Question |
$this | setNormalizer(callable $normalizer) Sets a normalizer for the response. | from Question |
callable | getNormalizer() Gets the normalizer for the response. | from Question |
Details
__construct(string $question, mixed $default = true, string $trueAnswerRegex = '/^y/i')
Parameters
string | $question | The question to ask to the user |
mixed | $default | The default answer to return if the user enters nothing |
string | $trueAnswerRegex | A regex to match the "yes" answer |
string getQuestion()
Returns the question.
Return Value
string |
mixed getDefault()
Returns the default answer.
Return Value
mixed |
bool isHidden()
Returns whether the user response must be hidden.
Return Value
bool |
$this setHidden(bool $hidden)
Sets whether the user response must be hidden or not.
Parameters
bool | $hidden |
Return Value
$this |
Exceptions
LogicException | In case the autocompleter is also used |
bool isHiddenFallback()
In case the response can not be hidden, whether to fallback on non-hidden question or not.
Return Value
bool |
$this setHiddenFallback(bool $fallback)
Sets whether to fallback on non-hidden question if the response can not be hidden.
Parameters
bool | $fallback |
Return Value
$this |
null|iterable getAutocompleterValues()
Gets values for the autocompleter.
Return Value
null|iterable |
$this setAutocompleterValues(null|iterable $values)
Sets values for the autocompleter.
Parameters
null|iterable | $values |
Return Value
$this |
Exceptions
InvalidArgumentException | |
LogicException |
$this setValidator(callable $validator = null)
Sets a validator for the question.
Parameters
callable | $validator |
Return Value
$this |
null|callable getValidator()
Gets the validator for the question.
Return Value
null|callable |
$this setMaxAttempts(null|int $attempts)
Sets the maximum number of attempts.
Null means an unlimited number of attempts.
Parameters
null|int | $attempts |
Return Value
$this |
Exceptions
InvalidArgumentException | in case the number of attempts is invalid |
null|int getMaxAttempts()
Gets the maximum number of attempts.
Null means an unlimited number of attempts.
Return Value
null|int |
$this setNormalizer(callable $normalizer)
Sets a normalizer for the response.
The normalizer can be a callable (a string), a closure or a class implementing __invoke.
Parameters
callable | $normalizer |
Return Value
$this |
callable getNormalizer()
Gets the normalizer for the response.
The normalizer can ba a callable (a string), a closure or a class implementing __invoke.
Return Value
callable |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/Console/Question/ConfirmationQuestion.html