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 |
| Question | setHidden(bool $hidden) Устанавливает, нужно ли скрывать ответ пользователя. | from Question |
| bool | isHiddenFallback() В случае, если ответ нельзя скрыть, нужно ли использовать вопрос без скрытия. | from Question |
| Question | setHiddenFallback(bool $fallback) Устанавливает, нужно ли использовать вопрос без скрытия, если ответ нельзя скрыть. | from Question |
| null|array|Traversable | getAutocompleterValues() Получает значения для автодополнения. | from Question |
| Question | setAutocompleterValues(null|array|Traversable $values) Устанавливает значения для автодополнения. | from Question |
| Question | setValidator(null|callable $validator) Устанавливает валидатор для вопроса. | from Question |
| null|callable | getValidator() Получает валидатор для вопроса. | from Question |
| Question | setMaxAttempts(null|int $attempts) Устанавливает максимальное количество попыток. | from Question |
| null|int | getMaxAttempts() Получает максимальное количество попыток. | from Question |
| Question | setNormalizer(callable $normalizer) Устанавливает нормализатор для ответа. | from Question |
| callable | getNormalizer() Получает нормализатор для ответа. | from Question |
| array | getChoices() Возвращает доступные варианты выбора. | |
| ChoiceQuestion | setMultiselect(bool $multiselect) Устанавливает опцию множественного выбора. | |
| string | getPrompt() Получает запрос для выбора. | |
| ChoiceQuestion | setPrompt(string $prompt) Устанавливает запрос для выбора. | |
| ChoiceQuestion | 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 |
Question setHidden(bool $hidden)
Устанавливает, нужно ли скрывать ответ пользователя или нет.
Параметры
| bool | $hidden |
Возвращаемое значение
| Question | Текущий экземпляр |
Исключения
| LogicException | В случае, если используется автодополнение |
bool isHiddenFallback()
В случае, если ответ нельзя скрыть, следует ли использовать вопрос без скрытия.
Возвращаемое значение
| bool |
Question setHiddenFallback(bool $fallback)
Устанавливает, следует ли использовать вопрос без скрытия, если ответ нельзя скрыть.
Параметры
| bool | $fallback |
Возвращаемое значение
| Question | Текущий экземпляр |
null|array|Traversable getAutocompleterValues()
Получает значения для автодополнения.
Возвращаемое значение
| null|array|Traversable |
Question setAutocompleterValues(null|array|Traversable $values)
Устанавливает значения для автодополнения.
Параметры
| null|array|Traversable | $values |
Возвращаемое значение
| Question | Текущий экземпляр |
Исключения
| InvalidArgumentException | |
| LogicException |
Question setValidator(null|callable $validator)
Устанавливает валидатор для вопроса.
Параметры
| null|callable | $validator |
Возвращаемое значение
| Question | Текущий экземпляр |
null|callable getValidator()
Получает валидатор для вопроса.
Возвращаемое значение
| null|callable |
Question setMaxAttempts(null|int $attempts)
Устанавливает максимальное количество попыток.
Null означает неограниченное количество попыток.
Параметры
| null|int | $attempts |
Возвращаемое значение
| Question | Текущий экземпляр |
Исключения
| InvalidArgumentException | В случае неверного количества попыток. |
null|int getMaxAttempts()
Получает максимальное количество попыток.
Null означает неограниченное количество попыток.
Возвращаемое значение
| null|int |
Question setNormalizer(callable $normalizer)
Устанавливает нормализатор для ответа.
Нормализатор может быть вызываемым объектом (строкой), замыканием или классом, реализующим __invoke.
Параметры
| callable | $normalizer |
Возвращаемое значение
| Question | Текущий экземпляр |
callable getNormalizer()
Получает нормализатор для ответа.
Нормализатор может быть вызываемым объектом (строкой), замыканием или классом, реализующим __invoke.
Возвращаемое значение
| callable |
array getChoices()
Возвращает доступные варианты.
Возвращаемое значение
| array |
ChoiceQuestion setMultiselect(bool $multiselect)
Устанавливает опцию многократного выбора.
Когда multiselect установлено в true, можно выбрать несколько вариантов.
Параметры
| bool | $multiselect |
Возвращаемое значение
| ChoiceQuestion | Текущий экземпляр |
string getPrompt()
Получает запрос для выбора.
Возвращаемое значение
| string |
ChoiceQuestion setPrompt(string $prompt)
Устанавливает запрос для выбора.
Параметры
| string | $prompt |
Возвращаемое значение
| ChoiceQuestion | Текущий экземпляр |
ChoiceQuestion setErrorMessage(string $errorMessage)
Устанавливает сообщение об ошибке для недопустимых значений.
Сообщение об ошибке содержит строчный маркер (%s) для недопустимого значения.
Параметры
| string | $errorMessage |
Возвращаемое значение
| ChoiceQuestion | Текущий экземпляр |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Component/Console/Question/ChoiceQuestion.html