[Redirect]¶

Properties¶

implementationClassName¶

Option path

prototypes.<prototypeIdentifier>.finishersDefinition.Redirect.implementationClassName

Data type

string

Needed by

Frontend

Mandatory

Yes

Default value

Redirect:
  implementationClassName: TYPO3\CMS\Form\Domain\Finishers\RedirectFinisher

Good to know

"Custom finisher implementations"

Description

Classname which implements the finisher.

options.pageUid¶

Option path

prototypes.<prototypeIdentifier>.finishersDefinition.Redirect.options.pageUid

Data type

int

Needed by

Frontend

Mandatory

Yes

Default value

1

Good to know

Description

Redirect to this page uid.

options.additionalParameters¶

Option path

prototypes.<prototypeIdentifier>.finishersDefinition.Redirect.options.additionalParameters

Data type

string

Needed by

Frontend

Mandatory

No

Default value

empty string

Good to know

Description

Additional parameters which should be used on the target page.

options.fragment¶

Option path

prototypes.<prototypeIdentifier>.finishersDefinition.Redirect.options.fragment

Data type

string

Needed by

Frontend

Mandatory

No

Default value

empty string

Good to know

Description

Add a fragment (e.g. #c9 or #foo) to the redirect link. The # character can be omitted.

options.delay¶

Option path

prototypes.<prototypeIdentifier>.finishersDefinition.Redirect.options.delay

Data type

int

Needed by

Frontend

Mandatory

No

Default value

0

Good to know

Description

The redirect delay in seconds.

options.statusCode¶

Option path

prototypes.<prototypeIdentifier>.finishersDefinition.Redirect.options.statusCode

Data type

int

Needed by

Frontend

Mandatory

No

Default value

303

Good to know

Description

The HTTP status code for the redirect. Default is "303 See Other".

options.translation.translationFiles¶

Option path

prototypes.<prototypeIdentifier>.finishersDefinition.Redirect.options.translation.translationFiles

Data type

string/ array

Needed by

Frontend

Mandatory

No

Default value

undefined

Good to know

Description

If set, this translation file(s) will be used for finisher option translations. If not set, the translation file(s) from the 'Form' element will be used. Read Translate finisher options for more informations.

formeditor.iconIdentifier¶

Option path

prototypes.<prototypeIdentifier>.finishersDefinition.Redirect.formEditor.iconIdentifier

Data type

string

Needed by

Backend (form editor)

Mandatory

Yes

Default value

Redirect:
  formEditor:
    iconIdentifier: form-finisher
    label: formEditor.elements.Form.finisher.Redirect.editor.header.label
    predefinedDefaults:
      options:
        pageUid: ''
        additionalParameters: ''
        fragment: ''

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.Redirect.formEditor.label

Data type

string

Needed by

Backend (form editor)

Mandatory

Yes

Default value

Redirect:
  formEditor:
    iconIdentifier: form-finisher
    label: formEditor.elements.Form.finisher.Redirect.editor.header.label
    predefinedDefaults:
      options:
        pageUid: ''
        additionalParameters: ''
        fragment: ''

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.Redirect.formEditor.predefinedDefaults

Data type

array

Needed by

Backend (form editor)

Mandatory

No

Default value

Redirect:
  formEditor:
    iconIdentifier: form-finisher
    label: formEditor.elements.Form.finisher.Redirect.editor.header.label
    predefinedDefaults:
      options:
        pageUid: ''
        additionalParameters: ''
        fragment: ''

Description: Defines predefined defaults for finisher options which are prefilled, if the finisher is added to a form.

FormEngine.label¶

Option path

prototypes.<prototypeIdentifier>.finishersDefinition.Redirect.FormEngine.label

Data type

array

Needed by

Backend (plugin)

Mandatory

Yes

Default value

Redirect:
  FormEngine:
    label: tt_content.finishersDefinition.Redirect.label

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.Redirect.FormEngine.elements

Data type

array

Needed by

Backend (plugin)

Mandatory

Yes

Default value

Redirect:
  FormEngine:
    label: tt_content.finishersDefinition.Redirect.label
    elements:
      pageUid:
        label: tt_content.finishersDefinition.Redirect.pageUid.label
        config:
          type: group
          allowed: pages
          size: 1
          minitems: 1
          maxitems: 1
          fieldWizard:
            recordsOverview:
              disabled: 1
      additionalParameters:
        label: tt_content.finishersDefinition.Redirect.additionalParameters.label
        config:
          type: input
     fragment:
       label: tt_content.finishersDefinition.Redirect.fragment.label
       config:
         type: input

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.