Form Definition Structure

TYPO3

Description

A form definition is a YAML file that describes a specific form including its pages, form elements, validators, and finishers. It is distinct from the form configuration, which defines what is available to the system. A form definition specifies what a particular form looks like and how it behaves. Form definitions are typically created via the backend form editor.

Goals

• I know the difference between form configuration and form definition: configuration defines elements available to the system and definition describes elements in a specific form instance.
• I know that the 4 main properties are identifier, label, prototype, and type.
• I know that the prototype key references the form configuration prototype (e.g. standard).
• I know that form elements are nested under “renderables” and that a specific form consists of one or more page renderables which contain the form elements in that form.
• I know that a form element has an identifier, a label, and a type as a minimum.
• I know that validators are assigned to form elements in a list under the validators key. Each item in the list has an identifier referencing a validator from the form configuration.
• I know that finishers are defined under the finishers key and that finishers run after successful form submission.
• I know that form element properties can be translated via XLIFF files, and that translation lookup follows a three-level fallback chain - formDefinitionIdentifier, elementIdentifier, and elementType.
• I know what a form definition “variant” is - a conditional override block at the form element level that overrides properties such as label, enabled, validators, and defaultValue.

Maintainer

Oliver Thiele Web Development Oliver Thiele