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 | При некорректном типе выбора (не multiple и не radio) |
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/4.0/Symfony/Component/DomCrawler/Field/ChoiceFormField.html
