class FormDataCollector extends DataCollector implements FormDataCollectorInterface

Data collector for {@link FormInterface} instances.

Methods

serialize()

No description

unserialize($data)

No description

__construct(FormDataExtractorInterface $dataExtractor)

No description

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

in DataCollector at line line 33
serialize()

in DataCollector at line line 38
unserialize($data)

Parameters

$data

at line line 68
__construct(FormDataExtractorInterface $dataExtractor)

Parameters

FormDataExtractorInterface $dataExtractor

at line line 81
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

at line line 88
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

at line line 96
collectConfiguration(FormInterface $form)

Stores configuration data of the given form and its children.

Parameters

FormInterface $form A root form

at line line 117
collectDefaultData(FormInterface $form)

Stores the default data of the given form and its children.

Parameters

FormInterface $form A root form

at line line 138
collectSubmittedData(FormInterface $form)

Stores the submitted data of the given form and its children.

Parameters

FormInterface $form A root form

at line line 166
collectViewVariables(FormView $view)

Stores the view variables of the given form view and its children.

Parameters

FormView $view A root form view

at line line 187
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

at line line 197
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

at line line 207
string getName()

Returns the name of the collector.

Return Value

string The collector name

at line line 215
array getData()

Returns all collected data.

Return Value

array