[finishersDefinition]

Properties

[finishersDefinition]

Option path
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition
Data type
array
Needed by
Frontend/ Backend (form editor)
Mandatory
Yes
Default value
1
2
3
4
prototypes:
  <prototypeIdentifier>:
    finishersDefinition:
      [...]
Good to know
Description
Array which defines the available finishers. Every key within this array is called the <finisherIdentifier>.

<finisherIdentifier>

Option path
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersdefinition.<finisherIdentifier>
Data type
string
Needed by
Frontend/ Backend (form editor)
Mandatory
Yes
Default value (for prototype 'standard')
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
prototypes:
  standard:
    Closure:
      [...]
    Confirmation:
      [...]
    EmailToSender:
      [...]
    EmailToReceiver:
      [...]
    DeleteUploads:
      [...]
    FlashMessage:
      [...]
    Redirect:
      [...]
    SaveToDatabase:
      [...]
Related options
Good to know
Description
This array key identifies a finisher. This identifier could be used to attach a finisher to a form.

Common <finisherIdentifier> properties

implementationClassName

Option path
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.<finisherIdentifier>.implementationClassName
Data type
string
Needed by
Frontend
Mandatory
Yes
Default value
Depends (see concrete finishers configuration)
Good to know
Description
Classname which implements the finisher.

options

Option path
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.<finisherIdentifier>.options
Data type
array
Needed by
Frontend
Mandatory
Depends (see concrete finishers configuration)
Default value
Depends (see concrete finishers configuration)
Good to know
Description
Array with finisher options.

translation.translationFile

Option path
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.<finisherIdentifier>.translation.translationFile
Data type
string/ array
Needed by
Frontend
Mandatory
No
Default value
Depends (see concrete element configuration)
Good to know
Description
Filesystem path(s) to translation files which should be searched for finisher translations. If the property is undefined, - "TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Form.renderingOptions.translation.translationFile" will be used.

formEditor

Option path
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.<finisherIdentifier>.formEditor
Data type
array
Needed by
Backend (form editor)
Mandatory
Recommended
Default value
Depends (see concrete finishers configuration)
Description
Array with configurations for the form editor

formeditor.iconIdentifier

Option path
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.<finisherIdentifier>.formEditor.iconIdentifier
Data type
string
Needed by
Backend (form editor)
Mandatory
Yes
Default value
Depends (see concrete finishers configuration)
Description
An icon identifier which must be registered through the \TYPO3\CMS\Core\Imaging\IconRegistry. This icon will be shown within the - "Inspector [CollectionElementHeaderEditor]" if the finisher is selected.

formeditor.label

Option path
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.<finisherIdentifier>.formEditor.label
Data type
string
Needed by
Backend (form editor)
Mandatory
Yes
Default value
Depends (see concrete finishers configuration)
Good to know
Description
This label will be shown within the - "Inspector [CollectionElementHeaderEditor]" if the finisher is selected.

formeditor.predefinedDefaults

Option path
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.<finisherIdentifier>.formEditor.predefinedDefaults
Data type
array
Needed by
Backend (form editor)
Mandatory
No
Default value
Depends (see concrete finishers configuration)
Description
Defines predefined defaults for finisher options which are prefilled, if the finisher is added to a form.

FormEngine

Option path
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.<finisherIdentifier>.FormEngine
Data type
array
Needed by
Backend (plugin)
Mandatory
No
Default value
Depends (see concrete finishers configuration)
Description
Array with configurations for the form plugin

FormEngine.label

Option path
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.<finisherIdentifier>.FormEngine.label
Data type
string
Needed by
Backend (plugin)
Mandatory
No
Default value
Depends (see concrete finishers configuration)
Good to know
Description
Finisher options are overwritable within the form plugin. If the "Override finisher settings" checkbox is selected within the form plugin, every finisher who has a - "FormEngine" configuration, is shown in a seperate tab. label is the label for such a tab.

FormEngine.elements

Option path
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.<finisherIdentifier>.FormEngine.elements
Data type
array
Needed by
Backend (plugin)
Mandatory
No
Default value
Depends (see concrete finishers configuration)
Good to know
Description
Every array key must match to the related finisher option name. For example, the - "[Redirect] finisher" has the option - "pageUid". If you want to make the pageUid overwritable within the form plugin, then an array key pageUid has to exists within TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.<finisherIdentifier>.FormEngine.elements. The configuration within TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.Redirect.FormEngine.elements.pageUid must follow the TCA syntax.

Concrete configurations