Interface

Symfony\Component\Form\FormInterface

interface FormInterface implements ArrayAccess, Traversable, Countable

A form group bundling multiple forms in a hierarchical structure.

Methods

FormInterface setParent(FormInterface $parent = null)

Sets the parent form.

FormInterface|null getParent()

Returns the parent form.

FormInterface add(FormInterface|string|integer $child, string|null $type = null, array $options = array())

Adds or replaces a child to the form.

FormInterface get(string $name)

Returns the child with the given name.

Boolean has(string $name)

Returns whether a child with the given name exists.

FormInterface remove(string $name)

Removes a child from the form.

FormInterface[] all()

Returns all children in this group.

FormErrorIterator getErrors(Boolean $deep = false, Boolean $flatten = true)

Returns the errors of this form.

FormInterface setData(mixed $modelData)

Updates the form with default data.

mixed getData()

Returns the data in the format needed for the underlying object.

mixed getNormData()

Returns the normalized data of the field.

mixed getViewData()

Returns the data transformed by the value transformer.

array getExtraData()

Returns the extra data.

FormConfigInterface getConfig()

Returns the form's configuration.

Boolean isSubmitted()

Returns whether the form is submitted.

string getName()

Returns the name by which the form is identified in forms.

PropertyPathInterface getPropertyPath()

Returns the property path that the form is mapped to.

FormInterface addError(FormError $error)

Adds an error to this form.

Boolean isValid()

Returns whether the form and all children are valid.

Boolean isRequired()

Returns whether the form is required to be filled out.

Boolean isDisabled()

Returns whether this form is disabled.

Boolean isEmpty()

Returns whether the form is empty.

Boolean isSynchronized()

Returns whether the data in the different formats is synchronized.

FormInterface initialize()

Initializes the form tree.

FormInterface handleRequest(mixed $request = null)

Inspects the given request and calls {@link submit()} if the form was submitted.

FormInterface submit(null|string|array $submittedData, Boolean $clearMissing = true)

Submits data to the form, transforms and validates it.

FormInterface getRoot()

Returns the root of the form tree.

Boolean isRoot()

Returns whether the field is the root of the form tree.

FormView createView(FormView $parent = null)

Creates a view.

Details

at line 32
public FormInterface setParent(FormInterface $parent = null)

Sets the parent form.

Parameters

FormInterface $parent The parent form or null if it's the root.

Return Value

FormInterface The form instance

Exceptions

AlreadySubmittedException If the form has already been submitted.
LogicException When trying to set a parent for a form with an empty name.

at line 39
public FormInterface|null getParent()

Returns the parent form.

Return Value

FormInterface|null The parent form or null if there is none.

at line 54
public FormInterface add(FormInterface|string|integer $child, string|null $type = null, array $options = array())

Adds or replaces a child to the form.

Parameters

FormInterface|string|integer $child The FormInterface instance or the name of the child.
string|null $type The child's type, if a name was passed.
array $options The child's options, if a name was passed.

Return Value

FormInterface The form instance

Exceptions

AlreadySubmittedException If the form has already been submitted.
LogicException When trying to add a child to a non-compound form.
UnexpectedTypeException If $child or $type has an unexpected type.

at line 65
public FormInterface get(string $name)

Returns the child with the given name.

Parameters

string $name The name of the child

Return Value

FormInterface The child form

Exceptions

OutOfBoundsException If the named child does not exist.

at line 74
public Boolean has(string $name)

Returns whether a child with the given name exists.

Parameters

string $name The name of the child

Return Value

Boolean

at line 85
public FormInterface remove(string $name)

Removes a child from the form.

Parameters

string $name The name of the child to remove

Return Value

FormInterface The form instance

Exceptions

AlreadySubmittedException If the form has already been submitted.

at line 92
public FormInterface[] all()

Returns all children in this group.

Return Value

FormInterface[] An array of FormInterface instances

at line 107
public FormErrorIterator getErrors(Boolean $deep = false, Boolean $flatten = true)

Returns the errors of this form.

Parameters

Boolean $deep Whether to include errors of child forms as well
Boolean $flatten Whether to flatten the list of errors in case $deep is set to true

Return Value

FormErrorIterator An iterator over the {@link FormError} instances that where added to this form

at line 121
public FormInterface setData(mixed $modelData)

Updates the form with default data.

Parameters

mixed $modelData The data formatted as expected for the underlying object

Return Value

FormInterface The form instance

Exceptions

AlreadySubmittedException If the form has already been submitted.
LogicException If listeners try to call setData in a cycle. Or if the view data does not match the expected type according to {@link FormConfigInterface::getDataClass}.

at line 128
public mixed getData()

Returns the data in the format needed for the underlying object.

Return Value

mixed

at line 137
public mixed getNormData()

Returns the normalized data of the field.

Return Value

mixed When the field is not submitted, the default data is returned. When the field is submitted, the normalized submitted data is returned if the field is valid, null otherwise.

at line 144
public mixed getViewData()

Returns the data transformed by the value transformer.

Return Value

mixed

at line 151
public array getExtraData()

Returns the extra data.

Return Value

array The submitted data which do not belong to a child

at line 158
public FormConfigInterface getConfig()

Returns the form's configuration.

Return Value

FormConfigInterface The configuration.

at line 165
public Boolean isSubmitted()

Returns whether the form is submitted.

Return Value

Boolean true if the form is submitted, false otherwise

at line 172
public string getName()

Returns the name by which the form is identified in forms.

Return Value

string The name of the form.

at line 179
public PropertyPathInterface getPropertyPath()

Returns the property path that the form is mapped to.

Return Value

PropertyPathInterface The property path.

at line 188
public FormInterface addError(FormError $error)

Adds an error to this form.

Parameters

FormError $error

Return Value

FormInterface The form instance

at line 197
public Boolean isValid()

Returns whether the form and all children are valid.

If the form is not submitted, this method always returns false.

Return Value

Boolean

at line 208
public Boolean isRequired()

Returns whether the form is required to be filled out.

If the form has a parent and the parent is not required, this method will always return false. Otherwise the value set with setRequired() is returned.

Return Value

Boolean

at line 221
public Boolean isDisabled()

Returns whether this form is disabled.

The content of a disabled form is displayed, but not allowed to be modified. The validation of modified disabled forms should fail.

Forms whose parents are disabled are considered disabled regardless of their own state.

Return Value

Boolean

at line 228
public Boolean isEmpty()

Returns whether the form is empty.

Return Value

Boolean

at line 235
public Boolean isSynchronized()

Returns whether the data in the different formats is synchronized.

Return Value

Boolean

at line 244
public FormInterface initialize()

Initializes the form tree.

Should be called on the root form after constructing the tree.

Return Value

FormInterface The form instance.

at line 258
public FormInterface handleRequest(mixed $request = null)

Inspects the given request and calls {@link submit()} if the form was submitted.

Internally, the request is forwarded to the configured {@link RequestHandlerInterface} instance, which determines whether to submit the form or not.

Parameters

mixed $request The request to handle.

Return Value

FormInterface The form instance.

at line 272
public FormInterface submit(null|string|array $submittedData, Boolean $clearMissing = true)

Submits data to the form, transforms and validates it.

Parameters

null|string|array $submittedData The submitted data.
Boolean $clearMissing Whether to set fields to NULL when they are missing in the submitted data.

Return Value

FormInterface The form instance

Exceptions

AlreadySubmittedException If the form has already been submitted.

at line 279
public FormInterface getRoot()

Returns the root of the form tree.

Return Value

FormInterface The root of the tree

at line 286
public Boolean isRoot()

Returns whether the field is the root of the form tree.

Return Value

Boolean

at line 295
public FormView createView(FormView $parent = null)

Creates a view.

Parameters

FormView $parent The parent view

Return Value

FormView The view