FormInterface (Component\Form)
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|int $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. | |
bool | 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(bool $deep = false, bool $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. | |
bool | 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. | |
bool | isValid() Returns whether the form and all children are valid. | |
bool | isRequired() Returns whether the form is required to be filled out. | |
bool | isDisabled() Returns whether this form is disabled. | |
bool | isEmpty() Returns whether the form is empty. | |
bool | isSynchronized() Returns whether the data in the different formats is synchronized. | |
TransformationFailedException|null | getTransformationFailure() Returns the data transformation failure, if any. | |
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, bool $clearMissing = true) Submits data to the form, transforms and validates it. | |
FormInterface | getRoot() Returns the root of the form tree. | |
bool | isRoot() Returns whether the field is the root of the form tree. | |
FormView | createView(FormView $parent = null) Creates a view. |
Details
public FormInterface setParent(FormInterface $parent = null)
Sets the parent form.
public FormInterface|null getParent()
Returns the parent form.
public FormInterface add(FormInterface|string|int $child, string|null $type = null, array $options = array())
Adds or replaces a child to the form.
public FormInterface get(string $name)
Returns the child with the given name.
public bool has(string $name)
Returns whether a child with the given name exists.
public FormInterface remove(string $name)
Removes a child from the form.
public FormInterface[] all()
Returns all children in this group.
public FormErrorIterator getErrors(bool $deep = false, bool $flatten = true)
Returns the errors of this form.
public FormInterface setData(mixed $modelData)
Updates the form with default data.
public mixed getData()
Returns the data in the format needed for the underlying object.
public mixed getNormData()
Returns the normalized data of the field.
public mixed getViewData()
Returns the data transformed by the value transformer.
public array getExtraData()
Returns the extra data.
public FormConfigInterface getConfig()
Returns the form's configuration.
public bool isSubmitted()
Returns whether the form is submitted.
public string getName()
Returns the name by which the form is identified in forms.
public PropertyPathInterface getPropertyPath()
Returns the property path that the form is mapped to.
public FormInterface addError(FormError $error)
Adds an error to this form.
public bool isValid()
Returns whether the form and all children are valid.
If the form is not submitted, this method always returns false.
public bool 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.
public bool 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.
public bool isEmpty()
Returns whether the form is empty.
public bool isSynchronized()
Returns whether the data in the different formats is synchronized.
If the data is not synchronized, you can get the transformation failure by calling {@link getTransformationFailure()}.
public TransformationFailedException|null getTransformationFailure()
Returns the data transformation failure, if any.
public FormInterface initialize()
Initializes the form tree.
Should be called on the root form after constructing the tree.
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.
public FormInterface submit(null|string|array $submittedData, bool $clearMissing = true)
Submits data to the form, transforms and validates it.
public FormInterface getRoot()
Returns the root of the form tree.
public bool isRoot()
Returns whether the field is the root of the form tree.
public FormView createView(FormView $parent = null)
Creates a view.
© 2004–2016 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Component/Form/FormInterface.html