[finishersDefinition]

Properties

[finishersDefinition]

Option path

prototypes.<prototypeIdentifier>.finishersDefinition

Data type

array

Needed by

Frontend/ Backend (form editor)

Mandatory

Yes

Default value

prototypes:
  <prototypeIdentifier>:
    finishersDefinition:
      [...]

Good to know

• "Custom finisher implementations"

Description

Array which defines the available finishers. Every key within this array is called the <finisherIdentifier>.

<finisherIdentifier>

Option path

prototypes.<prototypeIdentifier>.finishersdefinition.<finisherIdentifier>

Data type

string

Needed by

Frontend/ Backend (form editor)

Mandatory

Yes

Default value (for prototype 'standard')

prototypes:
  standard:
    Closure:
      [...]
    Confirmation:
      [...]
    EmailToSender:
      [...]
    EmailToReceiver:
      [...]
    DeleteUploads:
      [...]
    FlashMessage:
      [...]
    Redirect:
      [...]
    SaveToDatabase:
      [...]

Related options

• "prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.propertyCollections.finishers.[*].identifier"

• "[FinishersEditor] selectOptions.[*].value"

Good to know

• "Custom finisher implementations"

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

prototypes.<prototypeIdentifier>.finishersDefinition.<finisherIdentifier>.implementationClassName

Data type

string

Needed by

Frontend

Mandatory

Yes

Default value

Depends (see concrete finishers configuration)

Good to know

• "Custom finisher implementations"

Description

Classname which implements the finisher.

options

Option path

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

• "Custom finisher implementations"

Description

Array with finisher options.

translation.translationFiles

Option path

prototypes.<prototypeIdentifier>.finishersDefinition.<finisherIdentifier>.translation.translationFiles

Data type

string/ array

Needed by

Frontend

Mandatory

No

Default value

Depends (see concrete element configuration)

Good to know

• "Translate finisher options"

Description

Filesystem path(s) to translation files which should be searched for finisher translations. If the property is undefined, - "prototypes.<prototypeIdentifier>.formElementsDefinition.Form.renderingOptions.translation.translationFiles" will be used.

formEditor

Option path

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

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

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

• "Translate form editor settings"

Description

This label will be shown within the - "Inspector [CollectionElementHeaderEditor]" if the finisher is selected.

formeditor.predefinedDefaults

Option path

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

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

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

• "Translate form plugin settings"

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 separate tab. label is the label for such a tab.

FormEngine.elements

Option path

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

• "Translate form plugin settings"

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 prototypes.<prototypeIdentifier>.finishersDefinition.<finisherIdentifier>.FormEngine.elements. The configuration within prototypes.<prototypeIdentifier>.finishersDefinition.Redirect.FormEngine.elements.pageUid must follow the TCA syntax.

Concrete configurations

• [Closure]
  • Properties
    • implementationClassName
    • options.closure
    • formeditor.iconIdentifier
    • formeditor.label
    • formeditor.predefinedDefaults
• [Confirmation]
  • Properties
    • implementationClassName
    • options.message
    • options.contentElementUid
    • options.typoscriptObjectPath
    • options.variables
    • options.templateName
    • options.templateRootPaths
    • options.translation.translationFiles
    • formeditor.iconIdentifier
    • formeditor.label
    • formeditor.predefinedDefaults
• [EmailToReceiver]
  • Properties
    • implementationClassName
    • options.subject
    • options.recipients
    • options.senderAddress
    • options.senderName
    • options.replyToRecipients
    • options.carbonCopyRecipients
    • options.blindCarbonCopyRecipients
    • options.addHtmlPart
    • options.attachUploads
    • options.title
    • options.translation.language
    • options.translation.translationFiles
    • options.partialRootPaths
    • options.layoutRootPaths
    • options.variables
    • formeditor.iconIdentifier
    • formeditor.label
    • formeditor.predefinedDefaults
    • FormEngine.label
    • FormEngine.elements
• [EmailToSender]
  • Properties
    • implementationClassName
    • options.subject
    • options.recipients
    • options.senderAddress
    • options.senderName
    • options.replyToRecipients
    • options.carbonCopyRecipients
    • options.blindCarbonCopyRecipients
    • options.addHtmlPart
    • options.attachUploads
    • options.title
    • options.translation.language
    • options.translation.translationFiles
    • options.partialRootPaths
    • options.layoutRootPaths
    • options.variables
    • formeditor.iconIdentifier
    • formeditor.label
    • formeditor.predefinedDefaults
    • FormEngine.label
    • FormEngine.elements
• [DeleteUploads]
  • Properties
    • implementationClassName
    • formeditor.iconIdentifier
    • formeditor.label
• [FlashMessage]
  • Properties
    • implementationClassName
    • options.messageBody
    • options.messageTitle
    • options.messageArguments
    • options.messageCode
    • options.severity
    • options.translation.translationFiles
    • formeditor.iconIdentifier
    • formeditor.label
    • formeditor.predefinedDefaults
• [Redirect]
  • Properties
    • implementationClassName
    • options.pageUid
    • options.additionalParameters
    • options.fragment
    • options.delay
    • options.statusCode
    • options.translation.translationFiles
    • formeditor.iconIdentifier
    • formeditor.label
    • formeditor.predefinedDefaults
    • FormEngine.label
    • FormEngine.elements
• [SaveToDatabase]
  • Properties
    • implementationClassName
    • options.table
    • options.mode
    • options.whereClause
    • options.elements
    • options.elements.<formElementIdentifier>.mapOnDatabaseColumn
    • options.elements.<formElementIdentifier>.saveFileIdentifierInsteadOfUid
    • options.elements.<formElementIdentifier>.skipIfValueIsEmpty
    • options.elements.<formElementIdentifier>.dateFormat
    • options.databaseColumnMappings
    • options.databaseColumnMappings.<databaseColumnName>.value
    • options.databaseColumnMappings.<databaseColumnName>.skipIfValueIsEmpty
    • options.translation.translationFiles
    • formeditor.iconIdentifier
    • formeditor.label
    • formeditor.predefinedDefaults