class FormDataCollector extends DataCollector implements FormDataCollectorInterface

Data collector for {@link FormInterface} instances.

Properties

protected $data from DataCollector

Methods

serialize()

No description

unserialize($data)

No description

string
varToString(mixed $var)

Converts a PHP variable to a string.

__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 33
serialize()

in DataCollector at line 38
unserialize($data)

Parameters

$data

in DataCollector at line 50
protected string varToString(mixed $var)

Converts a PHP variable to a string.

Parameters

mixed $var A PHP variable

Return Value

string The string representation of the variable

at line 63
__construct(FormDataExtractorInterface $dataExtractor)

Parameters

FormDataExtractorInterface $dataExtractor

at line 76
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 83
associateFormWithView(FormInterface $form, FormView $view)

Specifies that the given objects represent the same conceptual form.

Parameters

FormInterface $form
FormView $view

at line 91
collectConfiguration(FormInterface $form)

Stores configuration data of the given form and its children.

Parameters

FormInterface $form

at line 112
collectDefaultData(FormInterface $form)

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

Parameters

FormInterface $form

at line 133
collectSubmittedData(FormInterface $form)

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

Parameters

FormInterface $form

at line 161
collectViewVariables(FormView $view)

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

Parameters

FormView $view

at line 182
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 192
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 202
string getName()

Returns the name of the collector.

Return Value

string The collector name

at line 210
array getData()

Returns all collected data.

Return Value

array