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

at line line 224
serialize()

in DataCollector at line line 48
unserialize($data)

Parameters

$data

at line line 69
__construct(FormDataExtractorInterface $dataExtractor)

Parameters

FormDataExtractorInterface $dataExtractor

at line line 83
collect(Request $request, Response $response, Exception $exception = null)

Does nothing. The data is collected during the form event listeners.

Parameters

Request $request
Response $response
Exception $exception

at line line 90
associateFormWithView(FormInterface $form, FormView $view)

Specifies that the given objects represent the same conceptual form.

Parameters

FormInterface $form
FormView $view

at line line 98
collectConfiguration(FormInterface $form)

Stores configuration data of the given form and its children.

Parameters

FormInterface $form

at line line 119
collectDefaultData(FormInterface $form)

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

Parameters

FormInterface $form

at line line 140
collectSubmittedData(FormInterface $form)

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

Parameters

FormInterface $form

at line line 174
collectViewVariables(FormView $view)

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

Parameters

FormView $view

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

at line line 203
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
FormView $view

at line line 211
string getName()

Returns the name of the collector.

Return Value

string The collector name

at line line 219
array getData()

Returns all collected data.

Return Value

array