‪TYPO3CMS  ‪main
TYPO3\CMS\Form\Domain\Factory\FormFactoryInterface Interface Reference
Inheritance diagram for TYPO3\CMS\Form\Domain\Factory\FormFactoryInterface:
TYPO3\CMS\Form\Domain\Factory\AbstractFormFactory TYPO3\CMS\Form\Domain\Factory\ArrayFormFactory

Public Member Functions

FormDefinition build (array $configuration, string $prototypeName=null)
 

Detailed Description

A Form Factory is responsible for building a TYPO3\CMS\Form\Domain\Model\FormDefinition. Instead of implementing this interface, subclassing AbstractFormFactory is more appropriate in most cases.

A Form Factory can be called anytime a FormDefinition should be built; in most cases it is done through an invocation of a Form Rendering ViewHelper.

Scope: frontend / backend

Definition at line 36 of file FormFactoryInterface.php.

Member Function Documentation

◆ build()

FormDefinition TYPO3\CMS\Form\Domain\Factory\FormFactoryInterface::build ( array  $configuration,
string  $prototypeName = null 
)

Build a form definition, depending on some configuration.

The configuration array is factory-specific; for example a YAML or JSON factory could retrieve the path to the YAML / JSON file via the configuration array.

Parameters
array$configuration‪factory-specific configuration array
string$prototypeName‪The name of the "PrototypeName" to use; it is factory-specific to implement this.
Returns
‪FormDefinition a newly built form definition

Implemented in TYPO3\CMS\Form\Domain\Factory\ArrayFormFactory.