FormDataCollector
class FormDataCollector extends DataCollector implements FormDataCollectorInterface
Data collector for {@link FormInterface} instances.
Properties
protected | $data | from DataCollector |
Methods
No description
Converts the variable into a serializable Data instance.
No description
No description
Specifies that the given objects represent the same conceptual form.
Stores configuration data of the given form and its children.
Stores the submitted data of the given form and its children.
Stores the view variables of the given form view and its children.
Assembles the data collected about the given form and its children as a tree-like data structure.
Assembles the data collected about the given form and its children as a tree-like data structure.
Returns the name of the collector.
Returns all collected data.
Details
protected Data
cloneVar(mixed $var)
Converts the variable into a serializable Data instance.
This array can be displayed in the template using the VarDumper component.
collect(Request $request, Response $response, Exception $exception = null)
Does nothing. The data is collected during the form event listeners.
associateFormWithView(FormInterface $form, FormView $view)
Specifies that the given objects represent the same conceptual form.
collectConfiguration(FormInterface $form)
Stores configuration data of the given form and its children.
collectSubmittedData(FormInterface $form)
Stores the submitted data of the given form and its children.
collectViewVariables(FormView $view)
Stores the view variables of the given form view and its children.
buildPreliminaryFormTree(FormInterface $form)
Assembles the data collected about the given form and its children as a tree-like data structure.
The result can be queried using {@link getData()}.
buildFinalFormTree(FormInterface $form, FormView $view)
Assembles the data collected about the given form and its children as a tree-like data structure.
The result can be queried using {@link getData()}.
Contrary to {@link buildPreliminaryFormTree()}, a {@link FormView} object has to be passed. The tree structure of this view object will be used for structuring the resulting data. That means, if a child is present in the view, but not in the form, it will be present in the final data array anyway.
When {@link FormView} instances are present in the view tree, for which no corresponding {@link FormInterface} objects can be found in the form tree, only the view data will be included in the result. If a corresponding {@link FormInterface} exists otherwise, call {@link associateFormWithView()} before calling this method.