__construct(string $question, array $choices, mixed $default = null)

Parameters

string	$question	The question to ask to the user
array	$choices	The list of available choices
mixed	$default	The default answer to return if the user enters nothing

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

iterable|null getAutocompleterValues()

Gets values for the autocompleter.

Return Value

iterable|null

$this setAutocompleterValues(iterable|null $values)

Sets values for the autocompleter.

Parameters

iterable|null

$values

Return Value

$this

Exceptions

InvalidArgumentException
LogicException

$this setValidator(callable $validator = null)

Sets a validator for the question.

Parameters

callable

$validator

Return Value

$this

callable|null getValidator()

Gets the validator for the question.

Return Value

callable|null

$this setMaxAttempts(int|null $attempts)

Sets the maximum number of attempts.

Null means an unlimited number of attempts.

Parameters

int|null

$attempts

Return Value

$this

Exceptions

InvalidArgumentException

in case the number of attempts is invalid

int|null getMaxAttempts()

Gets the maximum number of attempts.

Null means an unlimited number of attempts.

Return Value

int|null

$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

protected isAssoc($array)

Parameters

$array

array getChoices()

Returns available choices.

Return Value

array

$this setMultiselect(bool $multiselect)

Sets multiselect option.

When multiselect is set to true, multiple choices can be answered.

Parameters

bool

$multiselect

Return Value

$this

bool isMultiselect()

Returns whether the choices are multiselect.

Return Value

bool

string getPrompt()

Gets the prompt for choices.

Return Value

string

$this setPrompt(string $prompt)

Sets the prompt for choices.

Parameters

string

$prompt

Return Value

$this

$this setErrorMessage(string $errorMessage)

Sets the error message for invalid values.

The error message has a string placeholder (%s) for the invalid value.

Parameters

string

$errorMessage

Return Value

$this