class FormDataCollector extends DataCollector implements FormDataCollectorInterface

Data collector for {@link FormInterface} instances.

Properties

protected $data from DataCollector

Methods

serialize() deprecated

No description

unserialize($data) deprecated

No description

cloneVar(mixed $var)

Converts the variable into a serializable Data instance.

callable[]
getCasters()

No description

__sleep()

No description

__wakeup()

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.

reset()

No description

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 41
serialize() deprecated

deprecated since Symfony 4.3, store all the serialized state in the data property instead

in DataCollector at line 54
unserialize($data) deprecated

deprecated since Symfony 4.3, store all the serialized state in the data property instead

Parameters

$data

in DataCollector at line 71
protected Data cloneVar(mixed $var)

Converts the variable into a serializable Data instance.

This array can be displayed in the template using the VarDumper component.

Parameters

mixed $var

Return Value

Data

at line 253
protected callable[] getCasters()

Return Value

callable[] The casters to add to the cloner

at line 237
__sleep()

in DataCollector at line 124
__wakeup()

at line 70
__construct(FormDataExtractorInterface $dataExtractor)

Parameters

FormDataExtractorInterface $dataExtractor

at line 84
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 88
reset()

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

Specifies that the given objects represent the same conceptual form.

Parameters

FormInterface $form
FormView $view

at line 108
collectConfiguration(FormInterface $form)

Stores configuration data of the given form and its children.

Parameters

FormInterface $form

at line 129
collectDefaultData(FormInterface $form)

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

Parameters

FormInterface $form

at line 150
collectSubmittedData(FormInterface $form)

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

Parameters

FormInterface $form

at line 184
collectViewVariables(FormView $view)

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

Parameters

FormView $view

at line 205
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 213
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 221
string getName()

Returns the name of the collector.

Return Value

string The collector name

at line 229
array getData()

Returns all collected data.

Return Value

array