FormDataCollectorInterface
extends
DataCollectorInterface
in
Collects and structures information about forms.
Tags
Table of Contents
- associateFormWithView() : mixed
- Specifies that the given objects represent the same conceptual form.
- buildFinalFormTree() : mixed
- Assembles the data collected about the given form and its children as a tree-like data structure.
- buildPreliminaryFormTree() : mixed
- Assembles the data collected about the given form and its children as a tree-like data structure.
- collect() : mixed
- Collects data for the given Request and Response.
- collectConfiguration() : mixed
- Stores configuration data of the given form and its children.
- collectDefaultData() : mixed
- Stores the default data of the given form and its children.
- collectSubmittedData() : mixed
- Stores the submitted data of the given form and its children.
- collectViewVariables() : mixed
- Stores the view variables of the given form view and its children.
- getData() : array<string|int, mixed>|Data
- Returns all collected data.
- getName() : string
- Returns the name of the collector.
- reset() : mixed
Methods
associateFormWithView()
Specifies that the given objects represent the same conceptual form.
public
associateFormWithView(FormInterface $form, FormView $view) : mixed
Parameters
- $form : FormInterface
- $view : FormView
Return values
mixed —buildFinalFormTree()
Assembles the data collected about the given form and its children as a tree-like data structure.
public
buildFinalFormTree(FormInterface $form, FormView $view) : mixed
The result can be queried using .
Contrary to , a 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 instances are present in the view tree, for which no corresponding objects can be found in the form tree, only the view data will be included in the result. If a corresponding exists otherwise, call before calling this method.
Parameters
- $form : FormInterface
- $view : FormView
Return values
mixed —buildPreliminaryFormTree()
Assembles the data collected about the given form and its children as a tree-like data structure.
public
buildPreliminaryFormTree(FormInterface $form) : mixed
Parameters
- $form : FormInterface
Return values
mixed —collect()
Collects data for the given Request and Response.
public
collect(Request $request, Response $response) : mixed
Parameters
- $request : Request
- $response : Response
Return values
mixed —collectConfiguration()
Stores configuration data of the given form and its children.
public
collectConfiguration(FormInterface $form) : mixed
Parameters
- $form : FormInterface
Return values
mixed —collectDefaultData()
Stores the default data of the given form and its children.
public
collectDefaultData(FormInterface $form) : mixed
Parameters
- $form : FormInterface
Return values
mixed —collectSubmittedData()
Stores the submitted data of the given form and its children.
public
collectSubmittedData(FormInterface $form) : mixed
Parameters
- $form : FormInterface
Return values
mixed —collectViewVariables()
Stores the view variables of the given form view and its children.
public
collectViewVariables(FormView $view) : mixed
Parameters
- $view : FormView
Return values
mixed —getData()
Returns all collected data.
public
getData() : array<string|int, mixed>|Data
Return values
array<string|int, mixed>|Data —getName()
Returns the name of the collector.
public
getName() : string
Return values
string —The collector name
reset()
public
reset() : mixed