W3cubDocs

/Symfony 3.0

Symfony\Component\DomCrawler\Form

class Form extends Link implements ArrayAccess

Form represents an HTML form.

Methods

__construct(DOMElement $node, string $currentUri, string $method = null, string $baseHref = null)

Constructor.
DOMElement getNode()

Gets the node associated with this link.

 from Link
string getMethod()

Gets the form method.
string getUri()

Gets the URI of the form.
DOMElement getFormNode()

Gets the form node associated with this form.
Form setValues(array $values)

Sets the value of the fields.
array getValues()

Gets the field values.
array getFiles()

Gets the file field values.
array getPhpValues()

Gets the field values as PHP.
array getPhpFiles()

Gets the file field values as PHP.
bool has(string $name)

Returns true if the named field exists.
remove(string $name)

Removes a field from the form.
FormField get(string $name)

Gets a named field.
set(FormField $field)

Sets a named field.
FormField[] all()

Gets all fields.
bool offsetExists(string $name)

Returns true if the named field exists.
FormField offsetGet(string $name)

Gets the value of a field.
offsetSet(string $name, string|array $value)

Sets the value of a field.
offsetUnset(string $name)

Removes a field from the form.
Form disableValidation()

Disables validation.

Details

public __construct(DOMElement $node, string $currentUri, string $method = null, string $baseHref = null)

Constructor.

Parameters

DOMElement $node A \DOMElement instance
string $currentUri The URI of the page where the form is embedded
string $method The method to use for the link (if null, it defaults to the method defined by the form)
string $baseHref The URI of the used for relative links, but not for empty action

Exceptions

LogicException if the node is not a button inside a form tag

public DOMElement getNode()

Gets the node associated with this link.

Return Value

DOMElement A \DOMElement instance

public string getMethod()

Gets the form method.

If no method is defined in the form, GET is returned.

Return Value

string The method

public string getUri()

Gets the URI of the form.

The returned URI is not the same as the form "action" attribute. This method merges the value if the method is GET to mimics browser behavior.

Return Value

string The URI

public DOMElement getFormNode()

Gets the form node associated with this form.

Return Value

DOMElement A \DOMElement instance

public Form setValues(array $values)

Sets the value of the fields.

Parameters

array $values An array of field values

Return Value

Form

public array getValues()

Gets the field values.

The returned array does not include file fields (see getFiles).

Return Value

array An array of field values.

public array getFiles()

Gets the file field values.

Return Value

array An array of file field values.

public array getPhpValues()

Gets the field values as PHP.

This method converts fields with the array notation (like foo[bar] to arrays) like PHP does.

Return Value

array An array of field values.

public array getPhpFiles()

Gets the file field values as PHP.

This method converts fields with the array notation (like foo[bar] to arrays) like PHP does.

Return Value

array An array of field values.

public bool has(string $name)

Returns true if the named field exists.

Parameters

string $name The field name

Return Value

bool true if the field exists, false otherwise

public remove(string $name)

Removes a field from the form.

Parameters

string $name The field name

Exceptions

InvalidArgumentException when the name is malformed

public FormField get(string $name)

Gets a named field.

Parameters

string $name The field name

Return Value

FormField The field instance

Exceptions

InvalidArgumentException When field is not present in this form

public set(FormField $field)

Sets a named field.

Parameters

FormField $field The field

public FormField[] all()

Gets all fields.

Return Value

FormField[] An array of fields

public bool offsetExists(string $name)

Returns true if the named field exists.

Parameters

string $name The field name

Return Value

bool true if the field exists, false otherwise

public FormField offsetGet(string $name)

Gets the value of a field.

Parameters

string $name The field name

Return Value

FormField The associated Field instance

Exceptions

InvalidArgumentException if the field does not exist

public offsetSet(string $name, string|array $value)

Sets the value of a field.

Parameters

string $name The field name
string|array $value The value of the field

Exceptions

InvalidArgumentException if the field does not exist

public offsetUnset(string $name)

Removes a field from the form.

Parameters

string $name The field name

public Form disableValidation()

Disables validation.

Return Value

Form

© 2004–2016 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Component/DomCrawler/Form.html