Confirmation finisher

A basic finisher that outputs a text or content element.

Table of contents

Important

Finishers are executed in the order defined in your form definition.

See Finisher execution order.

Confirmation finisher options

This finisher outputs a text or a content element after the form has been submitted.

The settings of the finisher are:

message

Type: string
Default: The form has been submitted.

Displays this text if the contentElementUid is not set.

contentElementUid

Type: int
Default: 0

Renders the content element with the supplied ID.

translation.propertiesExcludedFromTranslation

Type: array
Default: []

Defines a list of finisher option properties that should be excluded from translation.

When specified, the listed properties are not processed by the TranslationService during translation of finisher options. This prevents their values from being replaced by translated equivalents, even if translations exist for those options.

This option is usually generated automatically as soon as FlexForm overrides are in place and normally does not need to be set manually in the form definition.

See Skip translation of overridden form finisher options for an example.

Confirmation finisher in the YAML form definition

A basic finisher that outputs text or a content element.

Outputs text message:

public/fileadmin/forms/my_form.yaml

identifier: example-form
label: 'example'
type: Form

finishers:
  -
    identifier: Confirmation
    options:
      message: 'Thx for using TYPO3'
  # ...

Outputs content element with id 42:

public/fileadmin/forms/my_form.yaml

identifier: example-form
label: 'example'
type: Form

finishers:
  -
    identifier: Confirmation
    options:
      contentElementUid: 42
  #...

Skip translation of overridden form finisher options

The following is an example of the translation.propertiesExcludedFromTranslation option being used to exclude three properties (subject, recipients and format) from translation.

Using this translation option, the properties can only be overridden by a FlexForm, not by the TranslationService.

This option is automatically generated as soon as FlexForm overrides are in place.

The following syntax is only documented for completeness. Nonetheless, it can also be added to a form definition YAML file.

public/fileadmin/forms/my_form.yaml

identifier: example-form
label: 'example'
type: Form

finishers:
  -
    options:
      identifier: EmailToSender
      subject: 'Email to sender'
      recipients:
        recipient@example.org: 'Some Name'
      translation:
        propertiesExcludedFromTranslation:
          - subject
          - recipients
          - format
  # ...

Using the confirmation finisher in PHP code

Developers can use the finisher key Confirmation to create confirmation finishers in their own classes:

<?php

use TYPO3\CMS\Form\Domain\Model\FormDefinition;

class SomeClass
{
    private function addConfirmationnFinisherWithMessage(FormDefinition $formDefinition, string $message)
    {
        $formDefinition->createFinisher('Confirmation', [
            'message' => $message,
        ]);
    }
    private function addConfirmationnFinisherWithContentElement(FormDefinition $formDefinition, int $contentElementUid)
    {
        $formDefinition->createFinisher('Confirmation', [
            'contentElementUid' => $contentElementUid,
        ]);
    }
}

Th confirmation finisher is implemented in \TYPO3\CMS\Form\Domain\Finishers\ConfirmationFinisher.