ChoiceFormField
class ChoiceFormField extends FormField
ChoiceFormField представляет собой поле формы выбора.
Она создаётся из тега HTML select, или тегов HTML checkbox, или radio.
Методы
| __construct(DOMElement $node) Конструктор. | из FormField | |
| DOMElement|null | getLabel() Возвращает тег метки, связанный с полем, или null, если метка отсутствует. | из FormField |
| string | getName() Возвращает имя поля. | из FormField |
| string|array | getValue() Получает значение поля. | из FormField |
| setValue(string $value) Устанавливает значение поля. | ||
| bool | hasValue() Возвращает true, если поле должно быть включено в значения, отправляемые с формой. | |
| bool | isDisabled() Проверяет, является ли текущий выбранный параметр отключенным. | |
| select(string $value) Устанавливает значение поля. | ||
| tick() Выбирает чекбокс. | ||
| untick() Снимает выделение с чекбокса. | ||
| addChoice(DOMElement $node) Добавляет выбор в текущий список. | ||
| string | getType() Возвращает тип поля выбора (radio, select или checkbox). | |
| bool | isMultiple() Возвращает true, если поле может принимать несколько значений. | |
| bool | containsOption(string $optionValue, array $options) Проверяет, существует ли данное значение среди существующих вариантов. | |
| array | availableOptionValues() Возвращает список доступных вариантов поля. | |
| ChoiceFormField | disableValidation() Отключает внутреннюю валидацию поля. |
Подробности
__construct(DOMElement $node)
Конструктор.
Параметры
| DOMElement | $node | Элемент, связанный с этим полем |
DOMElement|null getLabel()
Возвращает тег метки, связанный с полем, или null, если метка отсутствует.
Значение результата
| DOMElement|null |
string getName()
Возвращает имя поля.
Значение результата
| string | Имя поля |
string|array getValue()
Получает значение поля.
Значение результата
| string|array | Значение поля |
setValue(string $value)
Устанавливает значение поля.
Параметры
| string | $value | Значение поля |
Исключения
| InvalidArgumentException | При неверном типе значения |
bool hasValue()
Возвращает true, если поле должно быть включено в значения, отправляемые с формой.
Значение результата
| bool | true, если поле должно быть включено в значения, отправляемые с формой, в противном случае false |
bool isDisabled()
Проверяет, является ли текущий выбранный параметр отключенным.
Значение результата
| bool |
select(string $value)
Устанавливает значение поля.
Параметры
| string | $value | Значение поля |
tick()
Выбирает чекбокс.
Исключения
| LogicException | При неверном типе |
untick()
Снимает выделение с чекбокса.
Исключения
| LogicException | При неверном типе |
addChoice(DOMElement $node)
Добавляет выбор в текущий список.
Параметры
| DOMElement | $node |
Исключения
| LogicException | Если предоставленный выбор не является множественным или радио |
string getType()
Возвращает тип поля выбора (radio, select или checkbox).
Значение результата
| string | Тип |
bool isMultiple()
Возвращает true, если поле может принимать несколько значений.
Значение результата
| bool | true, если поле может принимать несколько значений, в противном случае false |
bool containsOption(string $optionValue, array $options)
Проверяет, существует ли данное значение среди существующих вариантов.
Параметры
| string | $optionValue | |
| array | $options |
Значение результата
| bool |
array availableOptionValues()
Возвращает список доступных вариантов поля.
Значение результата
| array |
ChoiceFormField disableValidation()
Отключает внутреннюю валидацию поля.
Значение результата
| ChoiceFormField |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.2/Symfony/Component/DomCrawler/Field/ChoiceFormField.html
