W3cubDocs

/Symfony 4.1

InputFormField

class InputFormField extends FormField

InputFormField represents an input form field (an HTML input tag).

For inputs with type of file, checkbox, or radio, there are other more specialized classes (cf. FileFormField and ChoiceFormField).

Properties

protected DOMElement $node from FormField
protected string $name from FormField
protected string $value from FormField
protected DOMDocument $document from FormField
protected DOMXPath $xpath from FormField
protected bool $disabled from FormField

Methods

__construct(DOMElement $node) from FormField
DOMElement|null getLabel()

Returns the label tag associated to the field or null if none.

from FormField
string getName()

Returns the name of the field.

from FormField
string|array getValue()

Gets the value of the field.

from FormField
setValue(string $value)

Sets the value of the field.

from FormField
bool hasValue()

Returns true if the field should be included in the submitted values.

from FormField
bool isDisabled()

Check if the current field is disabled.

from FormField
initialize()

Initializes the form field.

Details

__construct(DOMElement $node)

Parameters

DOMElement $node The node associated with this field

DOMElement|null getLabel()

Returns the label tag associated to the field or null if none.

Return Value

DOMElement|null

string getName()

Returns the name of the field.

Return Value

string The name of the field

string|array getValue()

Gets the value of the field.

Return Value

string|array The value of the field

setValue(string $value)

Sets the value of the field.

Parameters

string $value The value of the field

bool hasValue()

Returns true if the field should be included in the submitted values.

Return Value

bool true if the field should be included in the submitted values, false otherwise

bool isDisabled()

Check if the current field is disabled.

Return Value

bool

protected initialize()

Initializes the form field.

Exceptions

LogicException When node type is incorrect

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/DomCrawler/Field/InputFormField.html