ChoiceFormField
class ChoiceFormField extends FormField
ChoiceFormField представляет собой поле формы выбора.
Оно создаётся на основе тега HTML select, или тегов HTML checkbox или radio.
Свойства
| protected DOMElement | $node | из FormField | |
| protected string | $name | из FormField | |
| protected string | $value | из FormField | |
| protected DOMDocument | $document | из FormField | |
| protected DOMXPath | $xpath | из FormField | |
| protected bool | $disabled | из FormField |
Методы
| __construct(DOMElement $node) | из FormField | |
| DOMElement|null | getLabel() Возвращает тег метки, связанный с полем, или null, если метки нет. | из FormField |
| string | getName() Возвращает имя поля. | из FormField |
| string|array | getValue() Получает значение поля. | из FormField |
| setValue(string $value) Устанавливает значение поля. | ||
| bool | hasValue() Возвращает true, если поле должно быть включено в отправленные значения. | |
| bool | isDisabled() Проверяет, отключена ли текущая выбранная опция. | |
| initialize() Инициализирует поле формы. | ||
| select(string|array $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 |
protected initialize()
Инициализирует поле формы.
Исключения
| LogicException | Если тип узла неверный |
select(string|array $value)
Устанавливает значение поля.
Параметры
| string|array | $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.
https://api.symfony.com/4.1/Symfony/Component/DomCrawler/Field/ChoiceFormField.html
