.. include:: /Includes.rst.txt .. _typo3.cms.form.prototypes..finishersdefinition: ===================== [finishersDefinition] ===================== .. _typo3.cms.form.prototypes..finishersdefinition-properties: Properties ========== .. _typo3.cms.form.prototypes..finishersdefinition.*: [finishersDefinition] --------------------- :aspect:`Option path` TYPO3.CMS.Form.prototypes..finishersDefinition :aspect:`Data type` array :aspect:`Needed by` Frontend/ Backend (form editor) :aspect:`Mandatory` Yes :aspect:`Default value` .. code-block:: yaml :linenos: prototypes: : finishersDefinition: [...] :aspect:`Good to know` - :ref:`"Custom finisher implementations"` :aspect:`Description` Array which defines the available finishers. Every key within this array is called the ````. .. _typo3.cms.form.prototypes..finishersdefinition.: -------------------- :aspect:`Option path` TYPO3.CMS.Form.prototypes..finishersdefinition. :aspect:`Data type` string :aspect:`Needed by` Frontend/ Backend (form editor) :aspect:`Mandatory` Yes .. :aspect:`Related options` @ToDo :aspect:`Default value (for prototype 'standard')` .. code-block:: yaml :linenos: prototypes: standard: Closure: [...] Confirmation: [...] EmailToSender: [...] EmailToReceiver: [...] DeleteUploads: [...] FlashMessage: [...] Redirect: [...] SaveToDatabase: [...] :aspect:`Related options` - :ref:`"TYPO3.CMS.Form.prototypes.\.formElementsDefinition.\.formEditor.propertyCollections.finishers.[*].identifier".formelementsdefinition.\.formeditor.propertycollections.finishers.*.identifier>` - :ref:`"[FinishersEditor] selectOptions.[*].value".formelementsdefinition.\.formeditor.editors.*.selectoptions.*.value-finisherseditor>` :aspect:`Good to know` - :ref:`"Custom finisher implementations"` :aspect:`Description` This array key identifies a finisher. This identifier could be used to attach a finisher to a form. .. _typo3.cms.form.prototypes..finishersdefinition.-commonproperties: Common properties ============================================= .. _typo3.cms.form.prototypes..finishersdefinition..implementationClassName: implementationClassName ----------------------- :aspect:`Option path` TYPO3.CMS.Form.prototypes..finishersDefinition..implementationClassName :aspect:`Data type` string :aspect:`Needed by` Frontend :aspect:`Mandatory` Yes :aspect:`Default value` Depends (see :ref:`concrete finishers configuration .finishersdefinition.\-concreteconfigurations>`) :aspect:`Good to know` - :ref:`"Custom finisher implementations"` :aspect:`Description` .. include:: properties/implementationClassName.rst .. _typo3.cms.form.prototypes..finishersdefinition..options: options ------- :aspect:`Option path` TYPO3.CMS.Form.prototypes..finishersDefinition..options :aspect:`Data type` array :aspect:`Needed by` Frontend :aspect:`Mandatory` Depends (see :ref:`concrete finishers configuration .finishersdefinition.\-concreteconfigurations>`) :aspect:`Default value` Depends (see :ref:`concrete finishers configuration .finishersdefinition.\-concreteconfigurations>`) :aspect:`Good to know` - :ref:`"Custom finisher implementations"` :aspect:`Description` Array with finisher options. .. _typo3.cms.form.prototypes..finishersdefinition..translation.translationFiles: translation.translationFiles ---------------------------- :aspect:`Option path` TYPO3.CMS.Form.prototypes..finishersDefinition..translation.translationFiles :aspect:`Data type` string/ array :aspect:`Needed by` Frontend :aspect:`Mandatory` No :aspect:`Default value` Depends (see :ref:`concrete element configuration .formelementsdefinition.\-concreteconfigurations>`) :aspect:`Good to know` - :ref:`"Translate finisher options"` :aspect:`Description` Filesystem path(s) to translation files which should be searched for finisher translations. If the property is undefined, - :ref:`"TYPO3.CMS.Form.prototypes.\.formElementsDefinition.Form.renderingOptions.translation.translationFiles".formelementsdefinition.form.renderingoptions.translation.translationfiles>` will be used. .. _typo3.cms.form.prototypes..finishersdefinition..formeditor: formEditor ---------- :aspect:`Option path` TYPO3.CMS.Form.prototypes..finishersDefinition..formEditor :aspect:`Data type` array :aspect:`Needed by` Backend (form editor) :aspect:`Mandatory` Recommended :aspect:`Default value` Depends (see :ref:`concrete finishers configuration .finishersdefinition.\-concreteconfigurations>`) .. :aspect:`Good to know` ToDo :aspect:`Description` Array with configurations for the ``form editor`` .. _typo3.cms.form.prototypes..finishersdefinition..formeditor.iconidentifier: formeditor.iconIdentifier ------------------------- :aspect:`Option path` TYPO3.CMS.Form.prototypes..finishersDefinition..formEditor.iconIdentifier :aspect:`Data type` string :aspect:`Needed by` Backend (form editor) :aspect:`Mandatory` Yes :aspect:`Default value` Depends (see :ref:`concrete finishers configuration .finishersdefinition.\-concreteconfigurations>`) .. :aspect:`Good to know` ToDo :aspect:`Description` .. include:: properties/iconIdentifier.rst .. _typo3.cms.form.prototypes..finishersdefinition..formeditor.label: formeditor.label ---------------- :aspect:`Option path` TYPO3.CMS.Form.prototypes..finishersDefinition..formEditor.label :aspect:`Data type` string :aspect:`Needed by` Backend (form editor) :aspect:`Mandatory` Yes :aspect:`Default value` Depends (see :ref:`concrete finishers configuration .finishersdefinition.\-concreteconfigurations>`) :aspect:`Good to know` - :ref:`"Translate form editor settings"` :aspect:`Description` .. include:: properties/label.rst .. _typo3.cms.form.prototypes..finishersdefinition..formeditor.predefineddefaults: formeditor.predefinedDefaults ----------------------------- :aspect:`Option path` TYPO3.CMS.Form.prototypes..finishersDefinition..formEditor.predefinedDefaults :aspect:`Data type` array :aspect:`Needed by` Backend (form editor) :aspect:`Mandatory` No :aspect:`Default value` Depends (see :ref:`concrete finishers configuration .finishersdefinition.\-concreteconfigurations>`) .. :aspect:`Good to know` ToDo :aspect:`Description` .. include:: properties/predefinedDefaults.rst .. _typo3.cms.form.prototypes..finishersdefinition..formengine: FormEngine ---------- :aspect:`Option path` TYPO3.CMS.Form.prototypes..finishersDefinition..FormEngine :aspect:`Data type` array :aspect:`Needed by` Backend (plugin) :aspect:`Mandatory` No :aspect:`Default value` Depends (see :ref:`concrete finishers configuration .finishersdefinition.\-concreteconfigurations>`) .. :aspect:`Good to know` ToDo :aspect:`Description` Array with configurations for the ``form plugin`` .. _typo3.cms.form.prototypes..finishersdefinition..FormEngine.label: FormEngine.label ---------------- :aspect:`Option path` TYPO3.CMS.Form.prototypes..finishersDefinition..FormEngine.label :aspect:`Data type` string :aspect:`Needed by` Backend (plugin) :aspect:`Mandatory` No :aspect:`Default value` Depends (see :ref:`concrete finishers configuration .finishersdefinition.\-concreteconfigurations>`) :aspect:`Good to know` - :ref:`"Translate form plugin settings"` :aspect:`Description` .. include:: properties/formEngine/label.rst .. _typo3.cms.form.prototypes..finishersdefinition..FormEngine.elements: FormEngine.elements ------------------- :aspect:`Option path` TYPO3.CMS.Form.prototypes..finishersDefinition..FormEngine.elements :aspect:`Data type` array :aspect:`Needed by` Backend (plugin) :aspect:`Mandatory` No :aspect:`Default value` Depends (see :ref:`concrete finishers configuration .finishersdefinition.\-concreteconfigurations>`) :aspect:`Good to know` - :ref:`"Translate form plugin settings"` :aspect:`Description` .. include:: properties/formEngine/elements.rst .. _typo3.cms.form.prototypes..finishersdefinition.-concreteconfigurations: Concrete configurations ======================= .. toctree:: finishers/Closure finishers/Confirmation finishers/EmailToReceiver finishers/EmailToSender finishers/DeleteUploads finishers/FlashMessage finishers/Redirect finishers/SaveToDatabase