ChoiceQuestion
class ChoiceQuestion extends Question
Представляет вопрос с выбором.
Методы
| __construct(string $question, array $choices, mixed $default = null) | ||
| string | getQuestion() Возвращает вопрос. | from Question |
| mixed | getDefault() Возвращает значение по умолчанию. | from Question |
| bool | isHidden() Возвращает, должно ли быть скрыто пользовательское значение. | from Question |
| $this | setHidden(bool $hidden) Устанавливает, должно ли быть скрыто пользовательское значение. | from Question |
| bool | isHiddenFallback() Если ответ нельзя скрыть, следует ли использовать вопрос без скрытия. | from Question |
| $this | setHiddenFallback(bool $fallback) Устанавливает, следует ли использовать вопрос без скрытия, если ответ нельзя скрыть. | from Question |
| null|array|Traversable | getAutocompleterValues() Возвращает значения для автодополнения. | from Question |
| $this | setAutocompleterValues(null|array|Traversable $values) Устанавливает значения для автодополнения. | from Question |
| $this | setValidator(callable $validator = null) Устанавливает валидатор для вопроса. | from Question |
| null|callable | getValidator() Возвращает валидатор для вопроса. | from Question |
| $this | setMaxAttempts(null|int $attempts) Устанавливает максимальное количество попыток. | from Question |
| null|int | getMaxAttempts() Возвращает максимальное количество попыток. | from Question |
| $this | setNormalizer(callable $normalizer) Устанавливает нормализатор для ответа. | from Question |
| callable | getNormalizer() Возвращает нормализатор для ответа. | from Question |
| array | getChoices() Возвращает доступные варианты. | |
| $this | setMultiselect(bool $multiselect) Устанавливает возможность выбора нескольких вариантов. | |
| bool | isMultiselect() Возвращает, можно ли выбрать несколько вариантов. | |
| string | getPrompt() Возвращает подсказку для выбора. | |
| $this | setPrompt(string $prompt) Устанавливает подсказку для выбора. | |
| $this | setErrorMessage(string $errorMessage) Устанавливает сообщение об ошибке для недопустимых значений. |
Подробное описание
__construct(string $question, array $choices, mixed $default = null)
Параметры
| string | $question | Вопрос, задаваемый пользователю |
| array | $choices | Список доступных вариантов |
| mixed | $default | Значение по умолчанию, возвращаемое, если пользователь ничего не вводит |
string getQuestion()
Возвращает вопрос.
Значение возврата
| string |
mixed getDefault()
Возвращает значение по умолчанию.
Значение возврата
| mixed |
bool isHidden()
Возвращает, должно ли быть скрыто пользовательское сообщение.
Значение возврата
| bool |
$this setHidden(bool $hidden)
Устанавливает, должно ли быть скрыто пользовательское сообщение или нет.
Параметры
| bool | $hidden |
Значение возврата
| $this |
Исключения
| LogicException | В случае использования автозаполнения |
bool isHiddenFallback()
В случае, если ответ не может быть скрыт, использовать ли значение по умолчанию для нескритого вопроса.
Значение возврата
| bool |
$this setHiddenFallback(bool $fallback)
Устанавливает, следует ли переходить к нескритому вопросу, если ответ не может быть скрыт.
Параметры
| bool | $fallback |
Значение возврата
| $this |
null|array|Traversable getAutocompleterValues()
Получает значения для автозаполнения.
Значение возврата
| null|array|Traversable |
$this setAutocompleterValues(null|array|Traversable $values)
Устанавливает значения для автозаполнения.
Параметры
| null|array|Traversable | $values |
Значение возврата
| $this |
Исключения
| InvalidArgumentException | |
| LogicException |
$this setValidator(callable $validator = null)
Устанавливает валидатор для вопроса.
Параметры
| callable | $validator |
Значение возврата
| $this |
null|callable getValidator()
Получает валидатор для вопроса.
Значение возврата
| null|callable |
$this setMaxAttempts(null|int $attempts)
Устанавливает максимальное количество попыток.
Null означает неограниченное количество попыток.
Параметры
| null|int | $attempts |
Значение возврата
| $this |
Исключения
| InvalidArgumentException | в случае некорректного количества попыток |
null|int getMaxAttempts()
Получает максимальное количество попыток.
Null означает неограниченное количество попыток.
Значение возврата
| null|int |
$this setNormalizer(callable $normalizer)
Устанавливает нормализатор для ответа.
Нормализатор может быть вызываемой функцией (строкой), замыканием или классом, реализующим __invoke.
Параметры
| callable | $normalizer |
Значение возврата
| $this |
callable getNormalizer()
Получает нормализатор для ответа.
Нормализатор может быть вызываемой функцией (строкой), замыканием или классом, реализующим __invoke.
Значение возврата
| callable |
array getChoices()
Возвращает доступные варианты.
Значение возврата
| array |
$this setMultiselect(bool $multiselect)
Устанавливает опцию множественного выбора.
При установке multiselect в true можно выбрать несколько вариантов.
Параметры
| bool | $multiselect |
Значение возврата
| $this |
bool isMultiselect()
Возвращает, являются ли варианты вариантами множественного выбора.
Значение возврата
| bool |
string getPrompt()
Получает запрос для выбора.
Значение возврата
| string |
$this setPrompt(string $prompt)
Устанавливает запрос для выбора.
Параметры
| string | $prompt |
Значение возврата
| $this |
$this setErrorMessage(string $errorMessage)
Устанавливает сообщение об ошибке для недопустимых значений.
Сообщение об ошибке содержит подстановку (%s) для недопустимого значения.
Параметры
| string | $errorMessage |
Значение возврата
| $this |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.3/Symfony/Component/Console/Question/ChoiceQuestion.html
