FormDataCollectorInterface
interface FormDataCollectorInterface implements DataCollectorInterface
Collects and structures information about forms.
Methods
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.
Specifies that the given objects represent the same conceptual form.
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 all collected data.
Details
in DataCollectorInterface at line line 31
collect(Request $request, Response $response, Exception $exception = null)
Collects data for the given Request and Response.
in DataCollectorInterface at line line 38
string
getName()
Returns the name of the collector.
at line line 32
collectConfiguration(FormInterface $form)
Stores configuration data of the given form and its children.
at line line 39
collectDefaultData(FormInterface $form)
Stores the default data of the given form and its children.
at line line 46
collectSubmittedData(FormInterface $form)
Stores the submitted data of the given form and its children.
at line line 53
collectViewVariables(FormView $view)
Stores the view variables of the given form view and its children.
at line line 61
associateFormWithView(FormInterface $form, FormView $view)
Specifies that the given objects represent the same conceptual form.
at line line 71
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()}.
at line line 94
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.
at line line 101
array
getData()
Returns all collected data.