Spec-Zone.ru › Symfony 4.1

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
iterable|null getAutocompleterValues()

Получает значения для автозаполнения.

from Question
$this setAutocompleterValues(iterable|null $values)

Устанавливает значения для автозаполнения.

from Question
$this setValidator(callable $validator = null)

Устанавливает валидатор для вопроса.

from Question
callable|null getValidator()

Получает валидатор для вопроса.

from Question
$this setMaxAttempts(int|null $attempts)

Устанавливает максимальное количество попыток.

from Question
int|null getMaxAttempts()

Получает максимальное количество попыток.

from Question
$this setNormalizer(callable $normalizer)

Устанавливает нормализатор для ответа.

from Question
callable getNormalizer()

Получает нормализатор для ответа.

from Question
isAssoc($array) 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

iterable|null getAutocompleterValues()

Получает значения для автодополнения.

Значение результата

iterable|null

$this setAutocompleterValues(iterable|null $values)

Устанавливает значения для автодополнения.

Параметры

iterable|null $values

Значение результата

$this

Исключения

InvalidArgumentException
LogicException

$this setValidator(callable $validator = null)

Устанавливает валидатор для вопроса.

Параметры

callable $validator

Значение результата

$this

callable|null getValidator()

Получает валидатор для вопроса.

Значение результата

callable|null

$this setMaxAttempts(int|null $attempts)

Устанавливает максимальное количество попыток.

Null означает неограниченное количество попыток.

Параметры

int|null $attempts

Значение результата

$this

Исключения

InvalidArgumentException в случае неверного количества попыток

int|null getMaxAttempts()

Получает максимальное количество попыток.

Null означает неограниченное количество попыток.

Значение результата

int|null

$this setNormalizer(callable $normalizer)

Устанавливает нормализатор для ответа.

Нормализатор может быть вызываемым объектом (строкой), замыканием или классом, реализующим __invoke.

Параметры

callable $normalizer

Значение результата

$this

callable getNormalizer()

Получает нормализатор для ответа.

Нормализатор может быть вызываемым объектом (строкой), замыканием или классом, реализующим __invoke.

Значение результата

callable

protected isAssoc($array)

Параметры

$array

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.
https://api.symfony.com/4.1/Symfony/Component/Console/Question/ChoiceQuestion.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API