interface FormDataCollectorInterface implements DataCollectorInterface

Collects and structures information about forms.

Methods

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

Collects data for the given Request and Response.

string
getName()

Returns the name of the collector.

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.

associateFormWithView(FormInterface $form, FormView $view)

Specifies that the given objects represent the same conceptual form.

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.

array
getData()

Returns all collected data.

Details

in DataCollectorInterface at line line 31
collect(Request $request, Response $response, Exception $exception = null)

Collects data for the given Request and Response.

Parameters

Request $request A Request instance
Response $response A Response instance
Exception $exception An Exception instance

in DataCollectorInterface at line line 38
string getName()

Returns the name of the collector.

Return Value

string The collector name

at line line 30
collectConfiguration(FormInterface $form)

Stores configuration data of the given form and its children.

Parameters

FormInterface $form A root form

at line line 37
collectDefaultData(FormInterface $form)

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

Parameters

FormInterface $form A root form

at line line 44
collectSubmittedData(FormInterface $form)

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

Parameters

FormInterface $form A root form

at line line 51
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 59
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 69
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 92
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 99
array getData()

Returns all collected data.

Return Value

array