Spec-Zone.ru › Symfony 2.7

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(null|callable $validator)

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

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(null|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/2.7/Symfony/Component/Console/Question/ChoiceQuestion.html

Spec-Zone.ru

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