.. include:: ../../../../Includes.txt .. _typo3.cms.form.prototypes..finishersdefinition.redirect: ========== [Redirect] ========== .. _typo3.cms.form.prototypes..finishersdefinitionredirect-properties: Properties ========== .. _typo3.cms.form.prototypes..finishersdefinition.redirect.implementationclassname: implementationClassName ----------------------- :aspect:`Option path` TYPO3.CMS.Form.prototypes..finishersDefinition.Redirect.implementationClassName :aspect:`Data type` string :aspect:`Needed by` Frontend :aspect:`Mandatory` Yes :aspect:`Default value` .. code-block:: yaml :linenos: :emphasize-lines: 2 Redirect: implementationClassName: TYPO3\CMS\Form\Domain\Finishers\RedirectFinisher :aspect:`Good to know` - :ref:`"Custom finisher implementations"` :aspect:`Description` .. include:: ../properties/implementationClassName.rst .. _typo3.cms.form.prototypes..finishersdefinition.redirect.options.pageuid: options.pageUid --------------- :aspect:`Option path` TYPO3.CMS.Form.prototypes..finishersDefinition.Redirect.options.pageUid :aspect:`Data type` int :aspect:`Needed by` Frontend :aspect:`Mandatory` Yes :aspect:`Default value` 1 :aspect:`Good to know` - :ref:`"Redirect finisher"` - :ref:`"Accessing form runtime values"` :aspect:`Description` Redirect to this page uid. .. _typo3.cms.form.prototypes..finishersdefinition.redirect.options.additionalparameters: options.additionalParameters ---------------------------- :aspect:`Option path` TYPO3.CMS.Form.prototypes..finishersDefinition.Redirect.options.additionalParameters :aspect:`Data type` string :aspect:`Needed by` Frontend :aspect:`Mandatory` No :aspect:`Default value` empty string :aspect:`Good to know` - :ref:`"Redirect finisher"` - :ref:`"Accessing form runtime values"` :aspect:`Description` Additional parameters which should be used on the target page. .. _typo3.cms.form.prototypes..finishersdefinition.redirect.options.delay: options.delay ------------- :aspect:`Option path` TYPO3.CMS.Form.prototypes..finishersDefinition.Redirect.options.delay :aspect:`Data type` int :aspect:`Needed by` Frontend :aspect:`Mandatory` No :aspect:`Default value` 0 :aspect:`Good to know` - :ref:`"Redirect finisher"` - :ref:`"Accessing form runtime values"` :aspect:`Description` The redirect delay in seconds. .. _typo3.cms.form.prototypes..finishersdefinition.redirect.options.statuscode: options.statusCode ------------------ :aspect:`Option path` TYPO3.CMS.Form.prototypes..finishersDefinition.Redirect.options.statusCode :aspect:`Data type` int :aspect:`Needed by` Frontend :aspect:`Mandatory` No :aspect:`Default value` 303 :aspect:`Good to know` - :ref:`"Redirect finisher"` - :ref:`"Accessing form runtime values"` :aspect:`Description` The HTTP status code for the redirect. Default is "303 See Other". .. _typo3.cms.form.prototypes..finishersdefinition.redirect.options.translation.translationfile: options.translation.translationFile ----------------------------------- :aspect:`Option path` TYPO3.CMS.Form.prototypes..finishersDefinition.Redirect.options.translation.translationFile :aspect:`Data type` string/ array :aspect:`Needed by` Frontend :aspect:`Mandatory` No :aspect:`Default value` undefined :aspect:`Good to know` - :ref:`"Redirect finisher"` - :ref:`"Accessing form runtime values"` - :ref:`"Translate finisher options"` :aspect:`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 :ref:`Translate finisher options` for more informations. .. _typo3.cms.form.prototypes..finishersdefinition.redirect.formeditor.iconidentifier: formeditor.iconIdentifier ------------------------- :aspect:`Option path` TYPO3.CMS.Form.prototypes..finishersDefinition.Redirect.formEditor.iconIdentifier :aspect:`Data type` string :aspect:`Needed by` Backend (form editor) :aspect:`Mandatory` Yes :aspect:`Default value` .. code-block:: yaml :linenos: :emphasize-lines: 3 Redirect: formEditor: iconIdentifier: t3-form-icon-finisher label: formEditor.elements.Form.finisher.Redirect.editor.header.label predefinedDefaults: options: pageUid: '' additionalParameters: '' .. :aspect:`Good to know` ToDo :aspect:`Description` .. include:: ../properties/iconIdentifier.rst .. _typo3.cms.form.prototypes..finishersdefinition.redirect.formeditor.label: formeditor.label ---------------- :aspect:`Option path` TYPO3.CMS.Form.prototypes..finishersDefinition.Redirect.formEditor.label :aspect:`Data type` string :aspect:`Needed by` Backend (form editor) :aspect:`Mandatory` Yes :aspect:`Default value` .. code-block:: yaml :linenos: :emphasize-lines: 4 Redirect: formEditor: iconIdentifier: t3-form-icon-finisher label: formEditor.elements.Form.finisher.Redirect.editor.header.label predefinedDefaults: options: pageUid: '' additionalParameters: '' :aspect:`Good to know` - :ref:`"Translate form editor settings"` :aspect:`Description` .. include:: ../properties/label.rst .. _typo3.cms.form.prototypes..finishersdefinition.redirect.formeditor.predefineddefaults: formeditor.predefinedDefaults ----------------------------- :aspect:`Option path` TYPO3.CMS.Form.prototypes..finishersDefinition.Redirect.formEditor.predefinedDefaults :aspect:`Data type` array :aspect:`Needed by` Backend (form editor) :aspect:`Mandatory` No :aspect:`Default value` .. code-block:: yaml :linenos: :emphasize-lines: 5- Redirect: formEditor: iconIdentifier: t3-form-icon-finisher label: formEditor.elements.Form.finisher.Redirect.editor.header.label predefinedDefaults: options: pageUid: '' additionalParameters: '' .. :aspect:`Good to know` ToDo :aspect:`Description` .. include:: ../properties/predefinedDefaults.rst .. _typo3.cms.form.prototypes..finishersdefinition.redirect.formengine.label: FormEngine.label ---------------- :aspect:`Option path` TYPO3.CMS.Form.prototypes..finishersDefinition.Redirect.FormEngine.label :aspect:`Data type` array :aspect:`Needed by` Backend (plugin) :aspect:`Mandatory` Yes :aspect:`Default value` .. code-block:: yaml :linenos: :emphasize-lines: 3 Redirect: FormEngine: label: tt_content.finishersDefinition.Redirect.label :aspect:`Good to know` - :ref:`"Translate form plugin settings"` :aspect:`Description` .. include:: ../properties/formEngine/label.rst .. _typo3.cms.form.prototypes..finishersdefinition.redirect.formengine.elements: FormEngine.elements ------------------- :aspect:`Option path` TYPO3.CMS.Form.prototypes..finishersDefinition.Redirect.FormEngine.elements :aspect:`Data type` array :aspect:`Needed by` Backend (plugin) :aspect:`Mandatory` Yes :aspect:`Default value` .. code-block:: yaml :linenos: :emphasize-lines: 4- Redirect: FormEngine: label: tt_content.finishersDefinition.Redirect.label elements: pageUid: label: tt_content.finishersDefinition.Redirect.pageUid.label config: type: group internal_type: db allowed: pages size: 1 minitems: 1 maxitems: 1 fieldWizard: recordsOverview: disabled: 1 additionalParameters: label: tt_content.finishersDefinition.Redirect.additionalParameters.label config: type: input :aspect:`Good to know` - :ref:`"Translate form plugin settings"` :aspect:`Description` .. include:: ../properties/formEngine/elements.rst