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 AbstractUriElement
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

__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 link is embedded (or the base href)
string	$method	The method to use for the link (get by default)
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

DOMElement getNode()

Gets the node associated with this link.

Return Value

DOMElement

A \DOMElement instance

string getMethod()

Gets the form method.

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

Return Value

string

The method

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

DOMElement getFormNode()

Gets the form node associated with this form.

Return Value

DOMElement

A \DOMElement instance

Form setValues(array $values)

Sets the value of the fields.

Parameters

array

$values

An array of field values

Return Value

Form

array getValues()

Gets the field values.

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

Return Value

array

An array of field values

array getFiles()

Gets the file field values.

Return Value

array

An array of file field values

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

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. The returned array is consistent with the array for field values (see getPhpValues), rather than uploaded files found in $FILES. For a compound file field foo[bar] it will create foo[bar][name], instead of foo[name][bar] which would be found in $FILES.

Return Value

array

An array of file field values

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

remove(string $name)

Removes a field from the form.

Parameters

string

$name

The field name

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

set(FormField $field)

Sets a named field.

Parameters

FormField

$field

The field

FormField[] all()

Gets all fields.

Return Value

FormField[]

An array of fields

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

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

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

offsetUnset(string $name)

Removes a field from the form.

Parameters

string

$name

The field name

Form disableValidation()

Disables validation.

Return Value

Form

Links:

http://api.symfony.com/master/Symfony/Component/DomCrawler/Form.html

doc_Symfony

2016-10-28 06:17:12

Comments