FormDataCollector
class FormDataCollector extends DataCollector implements FormDataCollectorInterface
Data collector for {@link FormInterface} instances.
Methods
| serialize() | from DataCollector | |
| unserialize($data) | from DataCollector | |
| __construct(FormDataExtractorInterface $dataExtractor) | ||
|  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.  |  ||
|  collectDefaultData(FormInterface $form)  Stores the default 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.  |  ||
|  buildFinalFormTree(FormInterface $form, FormView $view)  Assembles the data collected about the given form and its children as a tree-like data structure.  |  ||
| string |  getName()  Returns the name of the collector.  |  |
| array |  getData()  Returns all collected data.  |  
Details
serialize()
unserialize($data)
Parameters
| $data | 
__construct(FormDataExtractorInterface $dataExtractor)
Parameters
| FormDataExtractorInterface | $dataExtractor | 
collect(Request $request, Response $response, Exception $exception = null)
Does nothing. The data is collected during the form event listeners.
Parameters
| Request | $request | A Request instance | 
| Response | $response | A Response instance | 
| Exception | $exception | An Exception instance | 
associateFormWithView(FormInterface $form, FormView $view)
Specifies that the given objects represent the same conceptual form.
Parameters
| FormInterface | $form | A form object | 
| FormView | $view | A view object | 
collectConfiguration(FormInterface $form)
Stores configuration data of the given form and its children.
Parameters
| FormInterface | $form | A root form | 
collectDefaultData(FormInterface $form)
Stores the default data of the given form and its children.
Parameters
| FormInterface | $form | A root form | 
collectSubmittedData(FormInterface $form)
Stores the submitted data of the given form and its children.
Parameters
| FormInterface | $form | A root form | 
collectViewVariables(FormView $view)
Stores the view variables of the given form view and its children.
Parameters
| FormView | $view | A root form view | 
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()}.
Parameters
| FormInterface | $form | A root form | 
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.
Parameters
| FormInterface | $form | A root form | 
| FormView | $view | A root view | 
string getName()
Returns the name of the collector.
Return Value
| string | The collector name | 
array getData()
Returns all collected data.
Return Value
| array | 
    © 2004–2017 Fabien Potencier
Licensed under the MIT License.
    http://api.symfony.com/3.1/Symfony/Component/Form/Extension/DataCollector/FormDataCollector.html