first commit

This commit is contained in:
salam committed 2026-10-19 08:18:39 +02:00
commit 1218dd1517
12716 files changed
+989233

No files matched your search

@@ -0,0 +1,18 @@
.. include:: ../Includes.txt
.. _configurationreference:
=======================
Configuration Reference
=======================
This chapter is a complete reference of the possible configuration settings.
It addresses your concerns as and integrator and developer.
.. toctree::
persistenceManager/Index
proto/Index
formManager/Index
configuration/Index
File diff suppressed because it is too large. Load diff
@@ -0,0 +1,436 @@
.. include:: ../../Includes.txt
.. _typo3.cms.form.formmanager:
=============
[formManager]
=============
.. _typo3.cms.form.formmanager-properties:
Properties
==========
.. _typo3.cms.form.formmanager.dynamicrequirejsmodules.app:
dynamicRequireJsModules.app
---------------------------
:aspect:`Option path`
TYPO3.CMS.Form.formManager.dynamicRequireJsModules.app
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form manager)
:aspect:`Mandatory`
Yes
:aspect:`Default value`
.. code-block:: yaml
:linenos:
:emphasize-lines: 2
dynamicRequireJsModules:
app: TYPO3/CMS/Form/Backend/FormManager
viewModel: TYPO3/CMS/Form/Backend/FormManager/ViewModel
:aspect:`Description`
Internal setting. RequireJS path for the form manager JavaScript app.
.. _typo3.cms.form.formmanager.dynamicrequirejsmodules.viewmodel:
dynamicRequireJsModules.viewModel
---------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.formManager.dynamicRequireJsModules.viewModel
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form manager)
:aspect:`Mandatory`
Yes
:aspect:`Default value`
.. code-block:: yaml
:linenos:
:emphasize-lines: 3
dynamicRequireJsModules:
app: TYPO3/CMS/Form/Backend/FormManager
viewModel: TYPO3/CMS/Form/Backend/FormManager/ViewModel
:aspect:`Description`
Internal setting. RequireJS path for the form manager JavaScript view model.
.. _typo3.cms.form.formmanager.stylesheets:
stylesheets
-----------
:aspect:`Option path`
TYPO3.CMS.Form.formManager.stylesheets
:aspect:`Data type`
array
:aspect:`Needed by`
Backend (form manager)
:aspect:`Mandatory`
Yes
:aspect:`Default value`
.. code-block:: yaml
:linenos:
stylesheets:
100: 'EXT:form/Resources/Public/Css/form.css'
:aspect:`Description`
Internal setting. Path for the form manager CSS file.
.. _typo3.cms.form.formmanager.translationfile:
translationFile
---------------
:aspect:`Option path`
TYPO3.CMS.Form.formManager.translationFile
:aspect:`Data type`
string/ array
:aspect:`Needed by`
Backend (form manager)
:aspect:`Mandatory`
Yes
:aspect:`Default value`
.. code-block:: yaml
:linenos:
translationFile: 'EXT:form/Resources/Private/Language/Database.xlf'
:aspect:`Good to know`
:ref:`Translate "Start template" options<concepts-formmanager-translation-starttemplate>`
:aspect:`Description`
The translation file(s) which should be used to translate parts of the form manager.
.. _typo3.cms.form.formmanager.javascripttranslationfile:
javaScriptTranslationFile
-------------------------
:aspect:`Option path`
TYPO3.CMS.Form.formManager.javaScriptTranslationFile
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form manager)
:aspect:`Mandatory`
Yes
:aspect:`Default value`
.. code-block:: yaml
:linenos:
javaScriptTranslationFile: 'EXT:form/Resources/Private/Language/locallang_formManager_javascript.xlf'
:aspect:`Description`
Internal setting. Path for the inline language labels for the form manager app.
.. _typo3.cms.form.formmanager.selectableprototypesconfiguration:
selectablePrototypesConfiguration
---------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.formManager.selectablePrototypesConfiguration
:aspect:`Data type`
array
:aspect:`Needed by`
Backend (form manager)
:aspect:`Mandatory`
Yes
:aspect:`Default value`
.. code-block:: yaml
:linenos:
selectablePrototypesConfiguration:
100:
identifier: standard
label: formManager.selectablePrototypesConfiguration.standard.label
newFormTemplates:
100:
templatePath: 'EXT:form/Resources/Private/Backend/Templates/FormEditor/Yaml/NewForms/BlankForm.yaml'
label: formManager.selectablePrototypesConfiguration.standard.newFormTemplates.blankForm.label
200:
templatePath: 'EXT:form/Resources/Private/Backend/Templates/FormEditor/Yaml/NewForms/SimpleContactForm.yaml'
label: formManager.selectablePrototypesConfiguration.standard.newFormTemplates.simpleContactForm.label
:aspect:`Good to know`
- :ref:`"Start templates"<concepts-formmanager-starttemplate>`
- :ref:`Translate "Start template" options<concepts-formmanager-translation-starttemplate>`
:aspect:`Description`
Array with numerical Keys. Configure the ``Start template`` selection list within the ``form manager`` "Advanced settings" step.
.. _typo3.cms.form.formmanager.selectableprototypesconfiguration.*.identifier:
selectablePrototypesConfiguration.*.identifier
----------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.formManager.selectablePrototypesConfiguration.*.identifier
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form manager)
:aspect:`Mandatory`
Yes
:aspect:`Related options`
- :ref:`TYPO3.CMS.Form.prototypes <typo3.cms.form.prototypes>`
:aspect:`Good to know`
- :ref:`"Start templates"<concepts-formmanager-starttemplate>`
:aspect:`Description`
Reference to a ``prototype`` which should be used for the newly created form definition.
.. _typo3.cms.form.formmanager.selectableprototypesconfiguration.*.label:
selectablePrototypesConfiguration.*.label
-----------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.formManager.selectablePrototypesConfiguration.*.label
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form manager)
:aspect:`Mandatory`
Yes
:aspect:`Good to know`
- :ref:`"Start templates"<concepts-formmanager-starttemplate>`
- :ref:`Translate "Start template" options<concepts-formmanager-translation-starttemplate>`
:aspect:`Description`
The ``Form prototype`` selectlist label for this ``prototype`` within the ``form manager`` "Advanced settings" step.
.. _typo3.cms.form.formmanager.selectableprototypesconfiguration.*.newformtemplates:
selectablePrototypesConfiguration.*.newFormTemplates
----------------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.formManager.selectablePrototypesConfiguration.*.newFormTemplates
:aspect:`Data type`
array
:aspect:`Needed by`
Backend (form manager)
:aspect:`Mandatory`
Yes
:aspect:`Default value`
.. code-block:: yaml
:linenos:
:emphasize-lines: 5-
selectablePrototypesConfiguration:
100:
identifier: standard
label: formManager.selectablePrototypesConfiguration.standard.label
newFormTemplates:
100:
templatePath: 'EXT:form/Resources/Private/Backend/Templates/FormEditor/Yaml/NewForms/BlankForm.yaml'
label: formManager.selectablePrototypesConfiguration.standard.newFormTemplates.blankForm.label
200:
templatePath: 'EXT:form/Resources/Private/Backend/Templates/FormEditor/Yaml/NewForms/SimpleContactForm.yaml'
label: formManager.selectablePrototypesConfiguration.standard.newFormTemplates.simpleContactForm.label
:aspect:`Good to know`
- :ref:`"Start templates"<concepts-formmanager-starttemplate>`
- :ref:`Translate "Start template" options<concepts-formmanager-translation-starttemplate>`
:aspect:`Description`
Array with numerical Keys. Configure the ``Start templates`` selectlist for this ``prototype`` within the ``form manager`` "Advanced settings" step.
.. _typo3.cms.form.formmanager.selectableprototypesconfiguration.*.newformtemplates.*.templatepath:
selectablePrototypesConfiguration.*.newFormTemplates.*.templatePath
-------------------------------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.formManager.selectablePrototypesConfiguration.*.newFormTemplates.*.templatePath
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form manager)
:aspect:`Mandatory`
Yes
:aspect:`Good to know`
- :ref:`"Start templates"<concepts-formmanager-starttemplate>`
- :ref:`Translate "Start template" options<concepts-formmanager-translation-starttemplate>`
:aspect:`Description`
The filesystem path to the `Start template`` YAML file.
.. _typo3.cms.form.formmanager.selectableprototypesconfiguration.*.newformtemplates.*.label:
selectablePrototypesConfiguration.*.newFormTemplates.*.label
------------------------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.formManager.selectablePrototypesConfiguration.*.newFormTemplates.*.label
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form manager)
:aspect:`Mandatory`
Yes
:aspect:`Good to know`
- :ref:`"Start templates"<concepts-formmanager-starttemplate>`
- :ref:`Translate "Start template" options<concepts-formmanager-translation-starttemplate>`
:aspect:`Description`
The ``Start template`` selectlist label for this ``Start template`` within the ``form manager`` "Advanced settings" step.
.. _typo3.cms.form.formmanager.controller:
controller
----------
:aspect:`Option path`
TYPO3.CMS.Form.formManager.controller
:aspect:`Data type`
array
:aspect:`Needed by`
Backend (form manager)
:aspect:`Mandatory`
Yes
:aspect:`Default value`
.. code-block:: yaml
:linenos:
controller:
deleteAction:
errorTitle: formManagerController.deleteAction.error.title
errorMessage: formManagerController.deleteAction.error.body
:aspect:`Description`
Internal setting. Configure the ``form manager`` flash message texts.
.. _typo3.cms.form.formmanager.controller.deleteaction.errortitle:
controller.deleteAction.errorTitle
----------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.formManager.controller.deleteAction.errorTitle
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form manager)
:aspect:`Mandatory`
Yes
:aspect:`Default value`
.. code-block:: yaml
:linenos:
:emphasize-lines: 3
controller:
deleteAction:
errorTitle: formManagerController.deleteAction.error.title
errorMessage: formManagerController.deleteAction.error.body
:aspect:`Description`
Internal setting. Configure the ``form manager`` flash message texts.
.. _typo3.cms.form.formmanager.controller.deleteaction.errormessage:
controller.deleteAction.errorMessage
------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.formManager.controller.deleteAction.errorMessage
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form manager)
:aspect:`Mandatory`
Yes
:aspect:`Default value`
.. code-block:: yaml
:linenos:
:emphasize-lines: 4
controller:
deleteAction:
errorTitle: formManagerController.deleteAction.error.title
errorMessage: formManagerController.deleteAction.error.body
:aspect:`Description`
Internal setting. Configure the ``form manager`` flash message texts.
@@ -0,0 +1,146 @@
.. include:: ../../Includes.txt
.. _typo3.cms.form.persistencemanager:
====================
[persistenceManager]
====================
.. _typo3.cms.form.persistencemanager-properties:
Properties
==========
.. _typo3.cms.form.persistencemanager.allowedfilemounts:
allowedFileMounts
-----------------
:aspect:`Option path`
TYPO3.CMS.Form.persistenceManager.allowedFileMounts
:aspect:`Data type`
array
:aspect:`Needed by`
Frontend/ Backend (form manager/ form editor/ plugin)
:aspect:`Mandatory`
Yes (if :ref:`allowedExtensionPaths <TYPO3.CMS.Form.persistenceManager.allowedExtensionPaths>` is not set)
:aspect:`Default value`
.. code-block:: yaml
:linenos:
:emphasize-lines: 3
persistenceManager:
allowedFileMounts:
10: '1:/form_definitions/'
:aspect:`Good to know`
:ref:`Form/ File storages<concepts-form-file-storages>`
:aspect:`Description`
EXT:form stores the form definitions within the file system and thus needs
write access to this storage. By default, the folder ``form_definitions`` is
created and used. It is possible to configure a different and/ or an additional
filemount which is then utilized for storing and reading forms.
.. _typo3.cms.form.persistencemanager.allowSaveToExtensionPaths:
allowSaveToExtensionPaths
-------------------------
:aspect:`Option path`
TYPO3.CMS.Form.persistenceManager.allowSaveToExtensionPaths
:aspect:`Data type`
bool
:aspect:`Needed by`
Backend (form manager)
:aspect:`Mandatory`
Yes
:aspect:`Default value`
.. code-block:: yaml
:linenos:
:emphasize-lines: 2
persistenceManager:
allowSaveToExtensionPaths: false
:aspect:`Good to know`
:ref:`Form/ File storages<concepts-form-file-storages>`
:aspect:`Description`
Set this to ``true`` if you want to allow backend users to **edit** forms stored within your own extension.
.. _typo3.cms.form.persistencemanager.allowDeleteFromExtensionPaths:
allowDeleteFromExtensionPaths
-----------------------------
:aspect:`Option path`
TYPO3.CMS.Form.persistenceManager.allowDeleteFromExtensionPaths
:aspect:`Data type`
bool
:aspect:`Needed by`
Backend (form manager)
:aspect:`Mandatory`
Yes
:aspect:`Default value`
.. code-block:: yaml
:linenos:
:emphasize-lines: 2
persistenceManager:
allowDeleteFromExtensionPaths: false
:aspect:`Good to know`
:ref:`Form/ File storages<concepts-form-file-storages>`
:aspect:`Description`
Set this to ``true`` if you want to allow backend users to **delete** forms stored within your own extension.
.. _typo3.cms.form.persistencemanager.allowedExtensionPaths:
allowedExtensionPaths
---------------------
:aspect:`Option path`
TYPO3.CMS.Form.persistenceManager.allowedExtensionPaths
:aspect:`Data type`
array
:aspect:`Needed by`
Frontend/ Backend (form manager/ form editor/ plugin)
:aspect:`Mandatory`
Yes (if :ref:`allowedFileMounts <TYPO3.CMS.Form.persistenceManager.allowedFileMounts>` is not set)
:aspect:`Default value`
undefined
:aspect:`Good to know`
:ref:`Form/ File storages<concepts-form-file-storages>`
:aspect:`Description`
Define the paths to folders which contain forms within your own extension.
For example:
.. code-block:: yaml
allowedExtensionPaths:
10: EXT:my_site_package/Resources/Private/Forms/
@@ -0,0 +1,95 @@
.. include:: ../../Includes.txt
.. _typo3.cms.form.prototypes:
============
[prototypes]
============
.. _typo3.cms.form.prototypes-properties:
Properties
==========
.. _typo3.cms.form.prototypes.*:
prototypes
----------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes
:aspect:`Data type`
array
:aspect:`Needed by`
Frontend/ Backend (form manager/ form editor/ plugin)
:aspect:`Mandatory`
Yes
:aspect:`Default value`
.. code-block:: yaml
:linenos:
prototypes:
standard:
[...]
:aspect:`Good to know`
- :ref:`"Prototypes"<concepts-configuration-prototypes>`
- :ref:`"Form configuration vs. form definition"<concepts-formdefinition-vs-formconfiguration>`
:aspect:`Description`
Array which defines the available prototypes. Every key within this array is called the ``<prototypeIdentifier>``.
.. _typo3.cms.form.prototypes.<prototypeidentifier>:
<prototypeIdentifier>
---------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>
:aspect:`Data type`
array
:aspect:`Needed by`
Frontend/ Backend (form manager/ form editor/ plugin)
:aspect:`Mandatory`
Yes
:aspect:`Related options`
- :ref:`"TYPO3.CMS.Form.formManager.selectablePrototypesConfiguration.*.identifier"<typo3.cms.form.formmanager.selectableprototypesconfiguration.*.identifier>`
:aspect:`Default value`
.. code-block:: yaml
:linenos:
:emphasize-lines: 2
prototypes:
standard:
[...]
:aspect:`Good to know`
- :ref:`"Prototypes"<concepts-configuration-prototypes>`
- :ref:`"Form configuration vs. form definition"<concepts-formdefinition-vs-formconfiguration>`
:aspect:`Description`
This array key identifies the `prototype``. Every ``form definition`` references to such a ``<prototypeIdentifier>`` through the property ``prototypeName``.
Subproperties
=============
.. toctree::
formElements/Index
finishersDefinition/Index
validatorsDefinition/Index
formEditor/Index
formEngine/Index
@@ -0,0 +1,395 @@
.. include:: ../../../Includes.txt
.. _typo3.cms.form.prototypes.<prototypeidentifier>.finishersdefinition:
=====================
[finishersDefinition]
=====================
.. _typo3.cms.form.prototypes.<prototypeidentifier>.finishersdefinition-properties:
Properties
==========
.. _typo3.cms.form.prototypes.<prototypeidentifier>.finishersdefinition.*:
[finishersDefinition]
---------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition
:aspect:`Data type`
array
:aspect:`Needed by`
Frontend/ Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Default value`
.. code-block:: yaml
:linenos:
prototypes:
<prototypeIdentifier>:
finishersDefinition:
[...]
:aspect:`Good to know`
- :ref:`"Custom finisher implementations"<concepts-finishers-customfinisherimplementations>`
:aspect:`Description`
Array which defines the available finishers. Every key within this array is called the ``<finisherIdentifier>``.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.finishersdefinition.<finisheridentifier>:
<finisherIdentifier>
--------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersdefinition.<finisherIdentifier>
: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.\<prototypeIdentifier>.formElementsDefinition.\<formElementTypeIdentifier>.formEditor.propertyCollections.finishers.[*].identifier"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.propertycollections.finishers.*.identifier>`
- :ref:`"[FinishersEditor] selectOptions.[*].value"<typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.selectoptions.*.value-finisherseditor>`
:aspect:`Good to know`
- :ref:`"Custom finisher implementations"<concepts-finishers-customfinisherimplementations>`
:aspect:`Description`
This array key identifies a finisher. This identifier could be used to attach a finisher to a form.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.finishersdefinition.<finisheridentifier>-commonproperties:
Common <finisherIdentifier> properties
=============================================
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.<finisheridentifier>.implementationClassName:
implementationClassName
-----------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.<finisherIdentifier>.implementationClassName
:aspect:`Data type`
string
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
Yes
:aspect:`Default value`
Depends (see :ref:`concrete finishers configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.finishersdefinition.\<finisheridentifier>-concreteconfigurations>`)
:aspect:`Good to know`
- :ref:`"Custom finisher implementations"<concepts-finishers-customfinisherimplementations>`
:aspect:`Description`
.. include:: properties/implementationClassName.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.<finisheridentifier>.options:
options
-------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.<finisherIdentifier>.options
:aspect:`Data type`
array
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
Depends (see :ref:`concrete finishers configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.finishersdefinition.\<finisheridentifier>-concreteconfigurations>`)
:aspect:`Default value`
Depends (see :ref:`concrete finishers configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.finishersdefinition.\<finisheridentifier>-concreteconfigurations>`)
:aspect:`Good to know`
- :ref:`"Custom finisher implementations"<concepts-finishers-customfinisherimplementations>`
:aspect:`Description`
Array with finisher options.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.<finisheridentifier>.translation.translationFile:
translation.translationFile
---------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.<finisherIdentifier>.translation.translationFile
:aspect:`Data type`
string/ array
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
No
:aspect:`Default value`
Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`)
:aspect:`Good to know`
- :ref:`"Translate finisher options"<concepts-frontendrendering-translation-finishers>`
: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.\<prototypeIdentifier>.formElementsDefinition.Form.renderingOptions.translation.translationFile"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.form.renderingoptions.translation.translationfile>` will be used.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.<finisheridentifier>.formeditor:
formEditor
----------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.<finisherIdentifier>.formEditor
:aspect:`Data type`
array
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Recommended
:aspect:`Default value`
Depends (see :ref:`concrete finishers configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.finishersdefinition.\<finisheridentifier>-concreteconfigurations>`)
.. :aspect:`Good to know`
ToDo
:aspect:`Description`
Array with configurations for the ``form editor``
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.<finisheridentifier>.formeditor.iconidentifier:
formeditor.iconIdentifier
-------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.<finisherIdentifier>.formEditor.iconIdentifier
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Default value`
Depends (see :ref:`concrete finishers configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.finishersdefinition.\<finisheridentifier>-concreteconfigurations>`)
.. :aspect:`Good to know`
ToDo
:aspect:`Description`
.. include:: properties/iconIdentifier.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.<finisheridentifier>.formeditor.label:
formeditor.label
----------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.<finisherIdentifier>.formEditor.label
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Default value`
Depends (see :ref:`concrete finishers configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.finishersdefinition.\<finisheridentifier>-concreteconfigurations>`)
:aspect:`Good to know`
- :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>`
:aspect:`Description`
.. include:: properties/label.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.<finisheridentifier>.formeditor.predefineddefaults:
formeditor.predefinedDefaults
-----------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.<finisherIdentifier>.formEditor.predefinedDefaults
:aspect:`Data type`
array
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
No
:aspect:`Default value`
Depends (see :ref:`concrete finishers configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.finishersdefinition.\<finisheridentifier>-concreteconfigurations>`)
.. :aspect:`Good to know`
ToDo
:aspect:`Description`
.. include:: properties/predefinedDefaults.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.<finisheridentifier>.formengine:
FormEngine
----------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.<finisherIdentifier>.FormEngine
:aspect:`Data type`
array
:aspect:`Needed by`
Backend (plugin)
:aspect:`Mandatory`
No
:aspect:`Default value`
Depends (see :ref:`concrete finishers configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.finishersdefinition.\<finisheridentifier>-concreteconfigurations>`)
.. :aspect:`Good to know`
ToDo
:aspect:`Description`
Array with configurations for the ``form plugin``
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.<finisheridentifier>.FormEngine.label:
FormEngine.label
----------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.<finisherIdentifier>.FormEngine.label
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (plugin)
:aspect:`Mandatory`
No
:aspect:`Default value`
Depends (see :ref:`concrete finishers configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.finishersdefinition.\<finisheridentifier>-concreteconfigurations>`)
:aspect:`Good to know`
- :ref:`"Translate form plugin settings"<concepts-formplugin-translation-formengine>`
:aspect:`Description`
.. include:: properties/formEngine/label.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.<finisheridentifier>.FormEngine.elements:
FormEngine.elements
-------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.<finisherIdentifier>.FormEngine.elements
:aspect:`Data type`
array
:aspect:`Needed by`
Backend (plugin)
:aspect:`Mandatory`
No
:aspect:`Default value`
Depends (see :ref:`concrete finishers configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.finishersdefinition.\<finisheridentifier>-concreteconfigurations>`)
:aspect:`Good to know`
- :ref:`"Translate form plugin settings"<concepts-formplugin-translation-formengine>`
:aspect:`Description`
.. include:: properties/formEngine/elements.rst
.. _typo3.cms.form.prototypes.<prototypeidentifier>.finishersdefinition.<finisheridentifier>-concreteconfigurations:
Concrete configurations
=======================
.. toctree::
finishers/Closure
finishers/Confirmation
finishers/EmailToReceiver
finishers/EmailToSender
finishers/DeleteUploads
finishers/FlashMessage
finishers/Redirect
finishers/SaveToDatabase
@@ -0,0 +1,186 @@
.. include:: ../../../../Includes.txt
.. _typo3.cms.form.prototypes.<prototypeidentifier>.finishersdefinition.closure:
=========
[Closure]
=========
.. _typo3.cms.form.prototypes.<prototypeidentifier>.finishersdefinitionclosure-properties:
Properties
==========
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.closure.implementationclassname:
implementationClassName
-----------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.Closure.implementationClassName
:aspect:`Data type`
string
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
Yes
:aspect:`Default value`
.. code-block:: yaml
:linenos:
:emphasize-lines: 2
Closure:
implementationClassName: TYPO3\CMS\Form\Domain\Finishers\ClosureFinisher
:aspect:`Good to know`
- :ref:`"Custom finisher implementations"<concepts-finishers-customfinisherimplementations>`
:aspect:`Description`
.. include:: ../properties/implementationClassName.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.closure.options.closure:
options.closure
---------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.Closure.options.closure
:aspect:`Data type`
\Closure
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
Yes
:aspect:`Default value`
null
.. :aspect:`Good to know`
ToDo
- :ref:`"Closure finisher"<apireference-finisheroptions-closurefinisher>`
- :ref:`"Custom finisher implementations"<concepts-finishers-customfinisherimplementations>`
:aspect:`Description`
The closure which are invoked if the finisher is treggered.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.closure.formeditor.iconidentifier:
formeditor.iconIdentifier
-------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.Closure.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
Closure:
formEditor:
iconIdentifier: t3-form-icon-finisher
label: formEditor.elements.Form.finisher.Closure.editor.header.label
predefinedDefaults:
options:
closure: ''
.. :aspect:`Good to know`
ToDo
:aspect:`Description`
.. include:: ../properties/iconIdentifier.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.closure.formeditor.label:
formeditor.label
----------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.Closure.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
Closure:
formEditor:
iconIdentifier: t3-form-icon-finisher
label: formEditor.elements.Form.finisher.Closure.editor.header.label
predefinedDefaults:
options:
closure: ''
:aspect:`Good to know`
- :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>`
:aspect:`Description`
.. include:: ../properties/label.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.closure.formeditor.predefineddefaults:
formeditor.predefinedDefaults
-----------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.Closure.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-
Closure:
formEditor:
iconIdentifier: t3-form-icon-finisher
label: formEditor.elements.Form.finisher.Closure.editor.header.label
predefinedDefaults:
options:
closure: ''
.. :aspect:`Good to know`
ToDo
:aspect:`Description`
.. include:: ../properties/predefinedDefaults.rst
@@ -0,0 +1,344 @@
.. include:: ../../../../Includes.txt
.. _typo3.cms.form.prototypes.<prototypeidentifier>.finishersdefinition.confirmation:
==============
[Confirmation]
==============
.. _typo3.cms.form.prototypes.<prototypeidentifier>.finishersdefinitionconfirmation-properties:
Properties
==========
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.confirmation.implementationclassname:
implementationClassName
-----------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.Confirmation.implementationClassName
:aspect:`Data type`
string
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
Yes
:aspect:`Default value`
.. code-block:: yaml
:linenos:
:emphasize-lines: 2
Confirmation:
implementationClassName: TYPO3\CMS\Form\Domain\Finishers\ConfirmationFinisher
:aspect:`Good to know`
- :ref:`"Custom finisher implementations"<concepts-finishers-customfinisherimplementations>`
:aspect:`Description`
.. include:: ../properties/implementationClassName.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.confirmation.options.message:
options.message
---------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.Confirmation.options.message
:aspect:`Data type`
string
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
Yes
:aspect:`Default value`
The form has been submitted.
:aspect:`Good to know`
- :ref:`"Confirmation finisher"<apireference-finisheroptions-confirmationfinisher>`
- :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`
- :ref:`"Translate finisher options"<concepts-frontendrendering-translation-finishers>`
:aspect:`Description`
The text which is shown if the finisher is invoked.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.confirmation.options.contentelementuid:
options.contentElementUid
-------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.Confirmation.options.contentElementUid
:aspect:`Data type`
integer
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
No
:aspect:`Default value`
undefined
:aspect:`Description`
The option "contentElementUid" can be used to render a content element.
If contentElementUid is set, the option "message" will be ignored.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.confirmation.options.typoscriptobjectpath:
options.typoscriptObjectPath
----------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.Confirmation.options.typoscriptObjectPath
:aspect:`Data type`
string
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
No
:aspect:`Default value`
'lib.tx_form.contentElementRendering'
:aspect:`Description`
The option "typoscriptObjectPath" can be used to render the content element (options.contentElementUid) through a typoscript lib.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.confirmation.options.variables:
options.variables
-----------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.Confirmation.options.variables
:aspect:`Data type`
array
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
No
:aspect:`Default value`
undefined
:aspect:`Description`
Variables which should be available within the template.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.confirmation.options.templatename:
options.templateName
--------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.Confirmation.options.templateName
:aspect:`Data type`
string
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
Yes
:aspect:`Default value`
'Confirmation'
:aspect:`Description`
Define a custom template name which should be used.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.confirmation.options.templaterootpaths:
options.templateRootPaths
-------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.Confirmation.options.templateRootPaths
:aspect:`Data type`
array
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
Yes
:aspect:`Default value`
.. code-block:: yaml
:linenos:
Confirmation:
options:
templateRootPaths:
10: 'EXT:form/Resources/Private/Frontend/Templates/Finishers/Confirmation/'
:aspect:`Description`
Used to define several paths for templates, which will be tried in reversed order (the paths are searched from bottom to top).
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.confirmation.options.translation.translationfile:
options.translation.translationFile
-----------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.Confirmation.options.translation.translationFile
:aspect:`Data type`
string/ array
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
No
:aspect:`Default value`
undefined
:aspect:`Good to know`
- :ref:`"Confirmation finisher"<apireference-finisheroptions-confirmationfinisher>`
- :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`
- :ref:`"Translate finisher options"<concepts-frontendrendering-translation-finishers>`
: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<concepts-frontendrendering-translation-finishers>` for more informations.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.confirmation.formeditor.iconidentifier:
formeditor.iconIdentifier
-------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.Confirmation.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
Confirmation:
formEditor:
iconIdentifier: t3-form-icon-finisher
label: formEditor.elements.Form.finisher.Confirmation.editor.header.label
predefinedDefaults:
options:
message: ''
.. :aspect:`Good to know`
ToDo
:aspect:`Description`
.. include:: ../properties/iconIdentifier.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.confirmation.formeditor.label:
formeditor.label
----------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.Confirmation.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
Confirmation:
formEditor:
iconIdentifier: t3-form-icon-finisher
label: formEditor.elements.Form.finisher.Confirmation.editor.header.label
predefinedDefaults:
options:
message: ''
:aspect:`Good to know`
- :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>`
:aspect:`Description`
.. include:: ../properties/label.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.confirmation.formeditor.predefineddefaults:
formeditor.predefinedDefaults
-----------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.Confirmation.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-
Confirmation:
formEditor:
iconIdentifier: t3-form-icon-finisher
label: formEditor.elements.Form.finisher.Confirmation.editor.header.label
predefinedDefaults:
options:
message: ''
.. :aspect:`Good to know`
ToDo
:aspect:`Description`
.. include:: ../properties/predefinedDefaults.rst
@@ -0,0 +1,114 @@
.. include:: ../../../../Includes.txt
.. _typo3.cms.form.prototypes.<prototypeidentifier>.finishersdefinition.deleteuploads:
===============
[DeleteUploads]
===============
.. _typo3.cms.form.prototypes.<prototypeidentifier>.finishersdefinitiondeleteuploads-properties:
Properties
==========
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.deleteuploads.implementationclassname:
implementationClassName
-----------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.DeleteUploads.implementationClassName
:aspect:`Data type`
string
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
Yes
:aspect:`Default value`
.. code-block:: yaml
:linenos:
:emphasize-lines: 2
DeleteUploads:
implementationClassName: TYPO3\CMS\Form\Domain\Finishers\DeleteUploadsFinisher
:aspect:`Good to know`
- :ref:`"Custom finisher implementations"<concepts-finishers-customfinisherimplementations>`
:aspect:`Description`
Array which defines the available finishers. Every key within this array is called the ``<finisherIdentifier>``
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.deleteuploads.formeditor.iconidentifier:
formeditor.iconIdentifier
-------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.DeleteUploads.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
DeleteUploads:
formEditor:
iconIdentifier: t3-form-icon-finisher
label: formEditor.elements.Form.finisher.DeleteUploads.editor.header.label
.. :aspect:`Good to know`
ToDo
:aspect:`Description`
.. include:: ../properties/iconIdentifier.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.deleteuploads.formeditor.label:
formeditor.label
----------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.DeleteUploads.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
DeleteUploads:
formEditor:
iconIdentifier: t3-form-icon-finisher
label: formEditor.elements.Form.finisher.DeleteUploads.editor.header.label
:aspect:`Good to know`
- :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>`
:aspect:`Description`
.. include:: ../properties/label.rst
@@ -0,0 +1,791 @@
.. include:: ../../../../Includes.txt
.. _typo3.cms.form.prototypes.<prototypeidentifier>.finishersdefinition.emailtoreceiver:
=================
[EmailToReceiver]
=================
.. _typo3.cms.form.prototypes.<prototypeidentifier>.finishersdefinitionemailtoreceiver-properties:
Properties
==========
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtoreceiver.implementationclassname:
implementationClassName
-----------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.implementationClassName
:aspect:`Data type`
string
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
Yes
:aspect:`Default value`
.. code-block:: yaml
:linenos:
:emphasize-lines: 2
EmailToReceiver:
implementationClassName: TYPO3\CMS\Form\Domain\Finishers\EmailFinisher
:aspect:`Good to know`
- :ref:`"Custom finisher implementations"<concepts-finishers-customfinisherimplementations>`
:aspect:`Description`
.. include:: ../properties/implementationClassName.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtoreceiver.options.subject:
options.subject
---------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.subject
:aspect:`Data type`
string
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
Yes
:aspect:`Default value`
undefined
:aspect:`Good to know`
- :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>`
- :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`
- :ref:`"Translate finisher options"<concepts-frontendrendering-translation-finishers>`
:aspect:`Description`
Subject of the email.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtoreceiver.options.recipientaddress:
options.recipientAddress
------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.recipientAddress
:aspect:`Data type`
string
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
Yes
:aspect:`Default value`
undefined
:aspect:`Good to know`
- :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>`
- :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`
:aspect:`Description`
Email address of the recipient (To).
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtoreceiver.options.recipientname:
options.recipientName
---------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.recipientName
:aspect:`Data type`
string
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
No
:aspect:`Default value`
empty string
:aspect:`Good to know`
- :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>`
- :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`
:aspect:`Description`
Human-readable name of the recipient.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtoreceiver.options.senderaddress:
options.senderAddress
---------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.senderAddress
:aspect:`Data type`
string
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
Yes
:aspect:`Default value`
undefined
:aspect:`Good to know`
- :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>`
- :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`
:aspect:`Description`
Email address of the sender/ visitor (From).
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtoreceiver.options.sendername:
options.senderName
------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.senderName
:aspect:`Data type`
string
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
No
:aspect:`Default value`
empty string
:aspect:`Good to know`
- :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>`
- :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`
:aspect:`Description`
Human-readable name of the sender.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtoreceiver.options.replytoaddress:
options.replyToAddress
----------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.replyToAddress
:aspect:`Data type`
string/ array
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
No
:aspect:`Default value`
undefined
:aspect:`Good to know`
- :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>`
- :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`
:aspect:`Description`
Email address of to be used as reply-to email (use multiple addresses with an array).
.. note::
For the moment, the ``form editor`` cannot deal with multiple reply-to addresses (use multiple addresses with an array)
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtoreceiver.options.carboncopyaddress:
options.carbonCopyAddress
-------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.carbonCopyAddress
:aspect:`Data type`
string/ array
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
No
:aspect:`Default value`
undefined
:aspect:`Good to know`
- :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>`
- :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`
:aspect:`Description`
Email address of the copy recipient (use multiple addresses with an array)
.. note::
For the moment, the ``form editor`` cannot deal with multiple copy recipient addresses (use multiple addresses with an array)
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtoreceiver.options.blindcarboncopyaddress:
options.blindCarbonCopyAddress
------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.blindCarbonCopyAddress
:aspect:`Data type`
string
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
No
:aspect:`Default value`
undefined
:aspect:`Good to know`
- :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>`
- :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`
:aspect:`Description`
Email address of the blind copy recipient (use multiple addresses with an array)
.. note::
For the moment, the ``form editor`` cannot deal with multiple blind copy recipient addresses (use multiple addresses with an array)
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtoreceiver.options.format:
options.format
--------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.format
:aspect:`Data type`
string
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
No
:aspect:`Default value`
html
:aspect:`Possible values`
html/ plaintext
:aspect:`Good to know`
- :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>`
- :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`
:aspect:`Description`
The format of the email. By default mails are sent as HTML.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtoreceiver.options.attachuploads:
options.attachUploads
---------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.attachUploads
:aspect:`Data type`
bool
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
No
:aspect:`Default value`
true
:aspect:`Good to know`
- :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>`
- :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`
:aspect:`Description`
If set, all uploaded items are attached to the email.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtoreceiver.options.translation.language:
options.translation.language
----------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.translation.language
:aspect:`Data type`
string
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
No
:aspect:`Default value`
undefined
:aspect:`Good to know`
- :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>`
- :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`
- :ref:`"Translate finisher options"<concepts-frontendrendering-translation-finishers>`
:aspect:`Description`
If not set, the finisher options are translated depending on the current frontend language (if translations exists).
This option allows you to force translations for a given sys_language isocode, e.g 'dk' or 'de'.
Read :ref:`Translate finisher options<concepts-frontendrendering-translation-finishers>` for more informations.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtoreceiver.options.translation.translationfile:
options.translation.translationFile
-----------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.translation.translationFile
:aspect:`Data type`
string/ array
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
No
:aspect:`Default value`
undefined
:aspect:`Good to know`
- :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>`
- :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`
- :ref:`"Translate finisher options"<concepts-frontendrendering-translation-finishers>`
: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<concepts-frontendrendering-translation-finishers>` for more informations.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtoreceiver.options.templatepathandfilename:
options.templatePathAndFilename
-------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.templatePathAndFilename
:aspect:`Data type`
string
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
Yes
:aspect:`Default value`
.. code-block:: yaml
:linenos:
:emphasize-lines: 2
EmailToReceiver:
options:
templatePathAndFilename: 'EXT:form/Resources/Private/Frontend/Templates/Finishers/Email/{@format}.html'
:aspect:`Good to know`
- :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>`
:aspect:`Description`
Template path and filename for the mail body.
The placeholder {\@format} will be replaced with the value from option ``format``.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtoreceiver.options.partialrootpaths:
options.partialRootPaths
------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.partialRootPaths
:aspect:`Data type`
array
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
No
:aspect:`Default value`
undefined
:aspect:`Good to know`
- :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>`
:aspect:`Description`
Fluid layout paths.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtoreceiver.options.layoutrootpaths:
options.layoutRootPaths
-----------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.layoutRootPaths
:aspect:`Data type`
array
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
No
:aspect:`Default value`
undefined
:aspect:`Good to know`
- :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>`
:aspect:`Description`
Fluid partial paths.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtoreceiver.options.variables:
options.variables
-----------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.options.variables
:aspect:`Data type`
array
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
No
:aspect:`Default value`
undefined
:aspect:`Good to know`
- :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>`
:aspect:`Description`
Associative array of variables which are available inside the Fluid template.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtoreceiver.formeditor.iconidentifier:
formeditor.iconIdentifier
-------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.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
EmailToReceiver:
formEditor:
iconIdentifier: t3-form-icon-finisher
label: formEditor.elements.Form.finisher.EmailToReceiver.editor.header.label
predefinedDefaults:
options:
subject: ''
recipientAddress: ''
recipientName: ''
senderAddress: ''
senderName: ''
replyToAddress: ''
carbonCopyAddress: ''
blindCarbonCopyAddress: ''
format: html
attachUploads: true
translation:
language: ''
.. :aspect:`Good to know`
ToDo
:aspect:`Description`
.. include:: ../properties/iconIdentifier.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtoreceiver.formeditor.label:
formeditor.label
----------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.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
EmailToReceiver:
formEditor:
iconIdentifier: t3-form-icon-finisher
label: formEditor.elements.Form.finisher.EmailToReceiver.editor.header.label
predefinedDefaults:
options:
subject: ''
recipientAddress: ''
recipientName: ''
senderAddress: ''
senderName: ''
replyToAddress: ''
carbonCopyAddress: ''
blindCarbonCopyAddress: ''
format: html
attachUploads: true
translation:
language: ''
:aspect:`Good to know`
- :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>`
:aspect:`Description`
.. include:: ../properties/label.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtoreceiver.formeditor.predefineddefaults:
formeditor.predefinedDefaults
-----------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.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-
EmailToReceiver:
formEditor:
iconIdentifier: t3-form-icon-finisher
label: formEditor.elements.Form.finisher.EmailToReceiver.editor.header.label
predefinedDefaults:
options:
subject: ''
recipientAddress: ''
recipientName: ''
senderAddress: ''
senderName: ''
replyToAddress: ''
carbonCopyAddress: ''
blindCarbonCopyAddress: ''
format: html
attachUploads: true
translation:
language: ''
.. :aspect:`Good to know`
ToDo
:aspect:`Description`
.. include:: ../properties/predefinedDefaults.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtoreceiver.formengine.label:
FormEngine.label
----------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.FormEngine.label
:aspect:`Data type`
array
:aspect:`Needed by`
Backend (plugin)
:aspect:`Mandatory`
Yes
:aspect:`Default value`
.. code-block:: yaml
:linenos:
:emphasize-lines: 3
EmailToReceiver:
FormEngine:
label: tt_content.finishersDefinition.EmailToReceiver.label
:aspect:`Good to know`
- :ref:`"Translate form plugin settings"<concepts-formplugin-translation-formengine>`
:aspect:`Description`
.. include:: ../properties/formEngine/label.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtoreceiver.formengine.elements:
FormEngine.elements
-------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToReceiver.FormEngine.elements
:aspect:`Data type`
array
:aspect:`Needed by`
Backend (plugin)
:aspect:`Mandatory`
Yes
:aspect:`Default value`
.. code-block:: yaml
:linenos:
:emphasize-lines: 4-
EmailToReceiver:
FormEngine:
label: tt_content.finishersDefinition.EmailToReceiver.label
elements:
subject:
label: tt_content.finishersDefinition.EmailToReceiver.subject.label
config:
type: input
recipientAddress:
label: tt_content.finishersDefinition.EmailToReceiver.recipientAddress.label
config:
type: input
eval: required
recipientName:
label: tt_content.finishersDefinition.EmailToReceiver.recipientName.label
config:
type: input
senderAddress:
label: tt_content.finishersDefinition.EmailToReceiver.senderAddress.label
config:
type: input
eval: required
senderName:
label: tt_content.finishersDefinition.EmailToReceiver.senderName.label
config:
type: input
replyToAddress:
label: tt_content.finishersDefinition.EmailToReceiver.replyToAddress.label
config:
type: input
carbonCopyAddress:
label: tt_content.finishersDefinition.EmailToReceiver.carbonCopyAddress.label
config:
type: input
blindCarbonCopyAddress:
label: tt_content.finishersDefinition.EmailToReceiver.blindCarbonCopyAddress.label
config:
type: input
format:
label: tt_content.finishersDefinition.EmailToReceiver.format.label
config:
type: select
renderType: selectSingle
minitems: 1
maxitems: 1
size: 1
items:
10:
- tt_content.finishersDefinition.EmailToSender.format.1
- html
20:
- tt_content.finishersDefinition.EmailToSender.format.2
- plaintext
translation:
language:
label: tt_content.finishersDefinition.EmailToReceiver.language.label
config:
type: select
renderType: selectSingle
minitems: 1
maxitems: 1
size: 1
items:
10:
- tt_content.finishersDefinition.EmailToReceiver.language.1
- default
:aspect:`Good to know`
- :ref:`"Translate form plugin settings"<concepts-formplugin-translation-formengine>`
:aspect:`Description`
.. include:: ../properties/formEngine/elements.rst
@@ -0,0 +1,791 @@
.. include:: ../../../../Includes.txt
.. _typo3.cms.form.prototypes.<prototypeidentifier>.finishersdefinition.emailtosender:
=================
[EmailToSender]
=================
.. _typo3.cms.form.prototypes.<prototypeidentifier>.finishersdefinitionemailtosender-properties:
Properties
==========
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtosender.implementationclassname:
implementationClassName
-----------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.implementationClassName
:aspect:`Data type`
string
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
Yes
:aspect:`Default value`
.. code-block:: yaml
:linenos:
:emphasize-lines: 2
EmailToSender:
implementationClassName: TYPO3\CMS\Form\Domain\Finishers\EmailFinisher
:aspect:`Good to know`
- :ref:`"Custom finisher implementations"<concepts-finishers-customfinisherimplementations>`
:aspect:`Description`
.. include:: ../properties/implementationClassName.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtosender.options.subject:
options.subject
---------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.options.subject
:aspect:`Data type`
string
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
Yes
:aspect:`Default value`
undefined
:aspect:`Good to know`
- :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>`
- :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`
- :ref:`"Translate finisher options"<concepts-frontendrendering-translation-finishers>`
:aspect:`Description`
Subject of the email.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtosender.options.recipientaddress:
options.recipientAddress
------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.options.recipientAddress
:aspect:`Data type`
string
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
Yes
:aspect:`Default value`
undefined
:aspect:`Good to know`
- :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>`
- :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`
:aspect:`Description`
Email address of the recipient (To).
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtosender.options.recipientname:
options.recipientName
---------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.options.recipientName
:aspect:`Data type`
string
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
No
:aspect:`Default value`
empty string
:aspect:`Good to know`
- :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>`
- :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`
:aspect:`Description`
Human-readable name of the recipient.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtosender.options.senderaddress:
options.senderAddress
---------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.options.senderAddress
:aspect:`Data type`
string
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
Yes
:aspect:`Default value`
undefined
:aspect:`Good to know`
- :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>`
- :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`
:aspect:`Description`
Email address of the sender/ visitor (From).
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtosender.options.sendername:
options.senderName
------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.options.senderName
:aspect:`Data type`
string
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
No
:aspect:`Default value`
empty string
:aspect:`Good to know`
- :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>`
- :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`
:aspect:`Description`
Human-readable name of the sender.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtosender.options.replytoaddress:
options.replyToAddress
----------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.options.replyToAddress
:aspect:`Data type`
string/ array
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
No
:aspect:`Default value`
undefined
:aspect:`Good to know`
- :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>`
- :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`
:aspect:`Description`
Email address of to be used as reply-to email (use multiple addresses with an array).
.. note::
For the moment, the ``form editor`` cannot deal with multiple reply-to addresses (use multiple addresses with an array)
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtosender.options.carboncopyaddress:
options.carbonCopyAddress
-------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.options.carbonCopyAddress
:aspect:`Data type`
string/ array
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
No
:aspect:`Default value`
undefined
:aspect:`Good to know`
- :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>`
- :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`
:aspect:`Description`
Email address of the copy recipient (use multiple addresses with an array)
.. note::
For the moment, the ``form editor`` cannot deal with multiple copy recipient addresses (use multiple addresses with an array)
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtosender.options.blindcarboncopyaddress:
options.blindCarbonCopyAddress
------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.options.blindCarbonCopyAddress
:aspect:`Data type`
string
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
No
:aspect:`Default value`
undefined
:aspect:`Good to know`
- :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>`
- :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`
:aspect:`Description`
Email address of the blind copy recipient (use multiple addresses with an array)
.. note::
For the moment, the ``form editor`` cannot deal with multiple blind copy recipient addresses (use multiple addresses with an array)
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtosender.options.format:
options.format
--------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.options.format
:aspect:`Data type`
string
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
No
:aspect:`Default value`
html
:aspect:`Possible values`
html/ plaintext
:aspect:`Good to know`
- :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>`
- :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`
:aspect:`Description`
The format of the email. By default mails are sent as HTML.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtosender.options.attachuploads:
options.attachUploads
---------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.options.attachUploads
:aspect:`Data type`
bool
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
No
:aspect:`Default value`
true
:aspect:`Good to know`
- :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>`
- :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`
:aspect:`Description`
If set, all uploaded items are attached to the email.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtosender.options.translation.language:
options.translation.language
----------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.options.translation.language
:aspect:`Data type`
string
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
No
:aspect:`Default value`
undefined
:aspect:`Good to know`
- :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>`
- :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`
- :ref:`"Translate finisher options"<concepts-frontendrendering-translation-finishers>`
:aspect:`Description`
If not set, the finisher options are translated depending on the current frontend language (if translations exists).
This option allows you to force translations for a given sys_language isocode, e.g 'dk' or 'de'.
Read :ref:`Translate finisher options<concepts-frontendrendering-translation-finishers>` for more informations.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtosender.options.translation.translationfile:
options.translation.translationFile
-----------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.options.translation.translationFile
:aspect:`Data type`
string/ array
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
No
:aspect:`Default value`
undefined
:aspect:`Good to know`
- :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>`
- :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`
- :ref:`"Translate finisher options"<concepts-frontendrendering-translation-finishers>`
: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<concepts-frontendrendering-translation-finishers>` for more informations.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtosender.options.templatepathandfilename:
options.templatePathAndFilename
-------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.options.templatePathAndFilename
:aspect:`Data type`
string
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
Yes
:aspect:`Default value`
.. code-block:: yaml
:linenos:
:emphasize-lines: 2
EmailToSender:
options:
templatePathAndFilename: 'EXT:form/Resources/Private/Frontend/Templates/Finishers/Email/{@format}.html'
:aspect:`Good to know`
- :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>`
:aspect:`Description`
Template path and filename for the mail body.
The placeholder {\@format} will be replaced with the value from option ``format``.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtosender.options.partialrootpaths:
options.partialRootPaths
------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.options.partialRootPaths
:aspect:`Data type`
array
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
No
:aspect:`Default value`
undefined
:aspect:`Good to know`
- :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>`
:aspect:`Description`
Fluid layout paths.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtosender.options.layoutrootpaths:
options.layoutRootPaths
-----------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.options.layoutRootPaths
:aspect:`Data type`
array
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
No
:aspect:`Default value`
undefined
:aspect:`Good to know`
- :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>`
:aspect:`Description`
Fluid partial paths.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtosender.options.variables:
options.variables
-----------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.options.variables
:aspect:`Data type`
array
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
No
:aspect:`Default value`
undefined
:aspect:`Good to know`
- :ref:`"Email finisher"<apireference-finisheroptions-emailfinisher>`
:aspect:`Description`
Associative array of variables which are available inside the Fluid template.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtosender.formeditor.iconidentifier:
formeditor.iconIdentifier
-------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.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
EmailToSender:
formEditor:
iconIdentifier: t3-form-icon-finisher
label: formEditor.elements.Form.finisher.EmailToSender.editor.header.label
predefinedDefaults:
options:
subject: ''
recipientAddress: ''
recipientName: ''
senderAddress: ''
senderName: ''
replyToAddress: ''
carbonCopyAddress: ''
blindCarbonCopyAddress: ''
format: html
attachUploads: true
translation:
language: ''
.. :aspect:`Good to know`
ToDo
:aspect:`Description`
.. include:: ../properties/iconIdentifier.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtosender.formeditor.label:
formeditor.label
----------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.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
EmailToSender:
formEditor:
iconIdentifier: t3-form-icon-finisher
label: formEditor.elements.Form.finisher.EmailToSender.editor.header.label
predefinedDefaults:
options:
subject: ''
recipientAddress: ''
recipientName: ''
senderAddress: ''
senderName: ''
replyToAddress: ''
carbonCopyAddress: ''
blindCarbonCopyAddress: ''
format: html
attachUploads: true
translation:
language: ''
:aspect:`Good to know`
- :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>`
:aspect:`Description`
.. include:: ../properties/label.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtosender.formeditor.predefineddefaults:
formeditor.predefinedDefaults
-----------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.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-
EmailToSender:
formEditor:
iconIdentifier: t3-form-icon-finisher
label: formEditor.elements.Form.finisher.EmailToSender.editor.header.label
predefinedDefaults:
options:
subject: ''
recipientAddress: ''
recipientName: ''
senderAddress: ''
senderName: ''
replyToAddress: ''
carbonCopyAddress: ''
blindCarbonCopyAddress: ''
format: html
attachUploads: true
translation:
language: ''
.. :aspect:`Good to know`
ToDo
:aspect:`Description`
.. include:: ../properties/predefinedDefaults.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtosender.formengine.label:
FormEngine.label
----------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.FormEngine.label
:aspect:`Data type`
array
:aspect:`Needed by`
Backend (plugin)
:aspect:`Mandatory`
Yes
:aspect:`Default value`
.. code-block:: yaml
:linenos:
:emphasize-lines: 3
EmailToSender:
FormEngine:
label: tt_content.finishersDefinition.EmailToSender.label
:aspect:`Good to know`
- :ref:`"Translate form plugin settings"<concepts-formplugin-translation-formengine>`
:aspect:`Description`
.. include:: ../properties/formEngine/label.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.emailtosender.formengine.elements:
FormEngine.elements
-------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.EmailToSender.FormEngine.elements
:aspect:`Data type`
array
:aspect:`Needed by`
Backend (plugin)
:aspect:`Mandatory`
Yes
:aspect:`Default value`
.. code-block:: yaml
:linenos:
:emphasize-lines: 4-
EmailToSender:
FormEngine:
label: tt_content.finishersDefinition.EmailToSender.label
elements:
subject:
label: tt_content.finishersDefinition.EmailToSender.subject.label
config:
type: input
recipientAddress:
label: tt_content.finishersDefinition.EmailToSender.recipientAddress.label
config:
type: input
eval: required
recipientName:
label: tt_content.finishersDefinition.EmailToSender.recipientName.label
config:
type: input
senderAddress:
label: tt_content.finishersDefinition.EmailToSender.senderAddress.label
config:
type: input
eval: required
senderName:
label: tt_content.finishersDefinition.EmailToSender.senderName.label
config:
type: input
replyToAddress:
label: tt_content.finishersDefinition.EmailToSender.replyToAddress.label
config:
type: input
carbonCopyAddress:
label: tt_content.finishersDefinition.EmailToSender.carbonCopyAddress.label
config:
type: input
blindCarbonCopyAddress:
label: tt_content.finishersDefinition.EmailToSender.blindCarbonCopyAddress.label
config:
type: input
format:
label: tt_content.finishersDefinition.EmailToSender.format.label
config:
type: select
renderType: selectSingle
minitems: 1
maxitems: 1
size: 1
items:
10:
- tt_content.finishersDefinition.EmailToSender.format.1
- html
20:
- tt_content.finishersDefinition.EmailToSender.format.2
- plaintext
translation:
language:
label: tt_content.finishersDefinition.EmailToSender.language.label
config:
type: select
renderType: selectSingle
minitems: 1
maxitems: 1
size: 1
items:
10:
- tt_content.finishersDefinition.EmailToSender.language.1
- default
:aspect:`Good to know`
- :ref:`"Translate form plugin settings"<concepts-formplugin-translation-formengine>`
:aspect:`Description`
.. include:: ../properties/formEngine/elements.rst
@@ -0,0 +1,341 @@
.. include:: ../../../../Includes.txt
.. _typo3.cms.form.prototypes.<prototypeidentifier>.finishersdefinition.flashmessage:
==============
[FlashMessage]
==============
.. _typo3.cms.form.prototypes.<prototypeidentifier>.finishersdefinitionflashmessage-properties:
Properties
==========
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.flashmessage.implementationclassname:
implementationClassName
-----------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.FlashMessage.implementationClassName
:aspect:`Data type`
string
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
Yes
:aspect:`Default value`
.. code-block:: yaml
:linenos:
:emphasize-lines: 2
FlashMessage:
implementationClassName: TYPO3\CMS\Form\Domain\Finishers\FlashMessageFinisher
:aspect:`Good to know`
- :ref:`"Custom finisher implementations"<concepts-finishers-customfinisherimplementations>`
:aspect:`Description`
.. include:: ../properties/implementationClassName.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.flashmessage.options.messagebody:
options.messageBody
-------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.FlashMessage.options.messageBody
:aspect:`Data type`
string
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
Yes
:aspect:`Default value`
null
:aspect:`Good to know`
- :ref:`"FlashMessage finisher"<apireference-finisheroptions-flashmessagefinisher>`
- :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`
- :ref:`"Translate finisher options"<concepts-frontendrendering-translation-finishers>`
:aspect:`Description`
The flash message body TEXT.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.flashmessage.options.messagetitle:
options.messageTitle
--------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.FlashMessage.options.messageTitle
:aspect:`Data type`
string
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
No
:aspect:`Default value`
empty string
:aspect:`Good to know`
- :ref:`"FlashMessage finisher"<apireference-finisheroptions-flashmessagefinisher>`
- :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`
- :ref:`"Translate finisher options"<concepts-frontendrendering-translation-finishers>`
:aspect:`Description`
The flash message title.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.flashmessage.options.messagearguments:
options.messageArguments
------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.FlashMessage.options.messageArguments
:aspect:`Data type`
array
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
No
:aspect:`Default value`
empty array
:aspect:`Good to know`
- :ref:`"FlashMessage finisher"<apireference-finisheroptions-flashmessagefinisher>`
- :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`
- :ref:`"Translate finisher options"<concepts-frontendrendering-translation-finishers>`
:aspect:`Description`
The flash message arguments, if needed.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.flashmessage.options.messagecode:
options.messageCode
-------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.FlashMessage.options.messageCode
:aspect:`Data type`
int
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
Yes
:aspect:`Default value`
null
:aspect:`Good to know`
- :ref:`"FlashMessage finisher"<apireference-finisheroptions-flashmessagefinisher>`
:aspect:`Description`
The flash message code, if needed.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.flashmessage.options.severity:
options.severity
----------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.FlashMessage.options.severity
:aspect:`Data type`
int
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
No
:aspect:`Default value`
\TYPO3\CMS\Core\Messaging\AbstractMessage::OK (0)
:aspect:`Good to know`
- :ref:`"FlashMessage finisher"<apireference-finisheroptions-flashmessagefinisher>`
:aspect:`Description`
The flash message severity code.
See \TYPO3\CMS\Core\Messaging\AbstractMessage constants for the codes.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.flashmessage.options.translation.translationfile:
options.translation.translationFile
-----------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.FlashMessage.options.translation.translationFile
:aspect:`Data type`
string/ array
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
No
:aspect:`Default value`
undefined
:aspect:`Good to know`
- :ref:`"FlashMessage finisher"<apireference-finisheroptions-flashmessagefinisher>`
- :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`
- :ref:`"Translate finisher options"<concepts-frontendrendering-translation-finishers>`
: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<concepts-frontendrendering-translation-finishers>` for more informations.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.flashmessage.formeditor.iconidentifier:
formeditor.iconIdentifier
-------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.FlashMessage.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
FlashMessage:
formEditor:
iconIdentifier: t3-form-icon-finisher
label: formEditor.elements.Form.finisher.FlashMessage.editor.header.label
predefinedDefaults:
options:
messageBody: ''
messageTitle: ''
messageArguments: ''
messageCode: 0
severity: 0
.. :aspect:`Good to know`
ToDo
:aspect:`Description`
.. include:: ../properties/iconIdentifier.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.flashmessage.formeditor.label:
formeditor.label
----------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.FlashMessage.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
FlashMessage:
formEditor:
iconIdentifier: t3-form-icon-finisher
label: formEditor.elements.Form.finisher.FlashMessage.editor.header.label
predefinedDefaults:
options:
messageBody: ''
messageTitle: ''
messageArguments: ''
messageCode: 0
severity: 0
:aspect:`Good to know`
- :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>`
:aspect:`Description`
.. include:: ../properties/label.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.flashmessage.formeditor.predefineddefaults:
formeditor.predefinedDefaults
-----------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.FlashMessage.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-
FlashMessage:
formEditor:
iconIdentifier: t3-form-icon-finisher
label: formEditor.elements.Form.finisher.FlashMessage.editor.header.label
predefinedDefaults:
options:
messageBody: ''
messageTitle: ''
messageArguments: ''
messageCode: 0
severity: 0
.. :aspect:`Good to know`
ToDo
:aspect:`Description`
.. include:: ../properties/predefinedDefaults.rst
@@ -0,0 +1,386 @@
.. include:: ../../../../Includes.txt
.. _typo3.cms.form.prototypes.<prototypeidentifier>.finishersdefinition.redirect:
==========
[Redirect]
==========
.. _typo3.cms.form.prototypes.<prototypeidentifier>.finishersdefinitionredirect-properties:
Properties
==========
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.redirect.implementationclassname:
implementationClassName
-----------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.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"<concepts-finishers-customfinisherimplementations>`
:aspect:`Description`
.. include:: ../properties/implementationClassName.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.redirect.options.pageuid:
options.pageUid
---------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.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"<apireference-finisheroptions-redirectfinisher>`
- :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`
:aspect:`Description`
Redirect to this page uid.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.redirect.options.additionalparameters:
options.additionalParameters
----------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.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"<apireference-finisheroptions-redirectfinisher>`
- :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`
:aspect:`Description`
Additional parameters which should be used on the target page.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.redirect.options.delay:
options.delay
-------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.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"<apireference-finisheroptions-redirectfinisher>`
- :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`
:aspect:`Description`
The redirect delay in seconds.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.redirect.options.statuscode:
options.statusCode
------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.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"<apireference-finisheroptions-redirectfinisher>`
- :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`
:aspect:`Description`
The HTTP status code for the redirect. Default is "303 See Other".
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.redirect.options.translation.translationfile:
options.translation.translationFile
-----------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.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"<apireference-finisheroptions-redirectfinisher>`
- :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`
- :ref:`"Translate finisher options"<concepts-frontendrendering-translation-finishers>`
: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<concepts-frontendrendering-translation-finishers>` for more informations.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.redirect.formeditor.iconidentifier:
formeditor.iconIdentifier
-------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.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.<prototypeIdentifier>.finishersdefinition.redirect.formeditor.label:
formeditor.label
----------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.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"<concepts-formeditor-translation-formeditor>`
:aspect:`Description`
.. include:: ../properties/label.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.redirect.formeditor.predefineddefaults:
formeditor.predefinedDefaults
-----------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.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.<prototypeIdentifier>.finishersdefinition.redirect.formengine.label:
FormEngine.label
----------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.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"<concepts-formplugin-translation-formengine>`
:aspect:`Description`
.. include:: ../properties/formEngine/label.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.redirect.formengine.elements:
FormEngine.elements
-------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.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"<concepts-formplugin-translation-formengine>`
:aspect:`Description`
.. include:: ../properties/formEngine/elements.rst
@@ -0,0 +1,523 @@
.. include:: ../../../../Includes.txt
.. _typo3.cms.form.prototypes.<prototypeidentifier>.finishersdefinition.savetodatabase:
================
[SaveToDatabase]
================
.. _typo3.cms.form.prototypes.<prototypeidentifier>.finishersdefinitionsavetodatabase-properties:
Properties
==========
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.savetodatabase.implementationclassname:
implementationClassName
-----------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.SaveToDatabase.implementationClassName
:aspect:`Data type`
string
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
Yes
:aspect:`Default value`
.. code-block:: yaml
:linenos:
:emphasize-lines: 2
SaveToDatabase:
implementationClassName: TYPO3\CMS\Form\Domain\Finishers\SaveToDatabaseFinisher
:aspect:`Good to know`
- :ref:`"Custom finisher implementations"<concepts-finishers-customfinisherimplementations>`
:aspect:`Description`
.. include:: ../properties/implementationClassName.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.savetodatabase.options.table:
options.table
-------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.SaveToDatabase.options.table
:aspect:`Data type`
string
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
Yes
:aspect:`Default value`
null
:aspect:`Good to know`
- :ref:`"SaveToDatabase finisher"<apireference-finisheroptions-savetodatabasefinisher>`
- :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`
:aspect:`Description`
Insert or update values into this table.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.savetodatabase.options.mode:
options.mode
------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.SaveToDatabase.options.mode
:aspect:`Data type`
string
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
No
:aspect:`Default value`
'insert'
:aspect:`Possible values`
insert/ update
:aspect:`Good to know`
- :ref:`"SaveToDatabase finisher"<apireference-finisheroptions-savetodatabasefinisher>`
- :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`
:aspect:`Description`
``insert`` will create a new database row with the values from the submitted form and/or some predefined values. @see options.elements and options.databaseFieldMappings
``update`` will update a given database row with the values from the submitted form and/or some predefined values. 'options.whereClause' is then required.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.savetodatabase.options.whereclause:
options.whereClause
-------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.SaveToDatabase.options.whereClause
:aspect:`Data type`
array
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
Yes, if mode = update
:aspect:`Default value`
empty array
:aspect:`Good to know`
- :ref:`"SaveToDatabase finisher"<apireference-finisheroptions-savetodatabasefinisher>`
- :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`
:aspect:`Description`
This where clause will be used for a database update action.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.savetodatabase.options.elements:
options.elements
----------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.SaveToDatabase.options.elements
:aspect:`Data type`
array
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
Yes
:aspect:`Default value`
empty array
:aspect:`Good to know`
- :ref:`"SaveToDatabase finisher"<apireference-finisheroptions-savetodatabasefinisher>`
- :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`
:aspect:`Description`
Use ``options.elements`` to map form element values to existing database columns.
Each key within ``options.elements`` has to match with a form element identifier.
The value for each key within ``options.elements`` is an array with additional informations.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.savetodatabase.options.elements.<formelementidentifier>.mapondatabasecolumn:
options.elements.<formElementIdentifier>.mapOnDatabaseColumn
------------------------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.SaveToDatabase.options.elements.<formElementIdentifier>.mapOnDatabaseColumn
:aspect:`Data type`
string
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
Yes
:aspect:`Default value`
undefined
:aspect:`Good to know`
- :ref:`"SaveToDatabase finisher"<apireference-finisheroptions-savetodatabasefinisher>`
- :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`
:aspect:`Description`
The value from the submitted form element with the identifier ``<formElementIdentifier>`` will be written into this database column.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.savetodatabase.options.elements.<formelementidentifier>.savefileidentifierinsteadofuid:
options.elements.<formElementIdentifier>.saveFileIdentifierInsteadOfUid
-------------------------------------------------------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.SaveToDatabase.options.elements.<formElementIdentifier>.saveFileIdentifierInsteadOfUid
:aspect:`Data type`
bool
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
No
:aspect:`Default value`
false
:aspect:`Good to know`
- :ref:`"SaveToDatabase finisher"<apireference-finisheroptions-savetodatabasefinisher>`
- :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`
:aspect:`Description`
Set this to true if the database column should not be written if the value from the submitted form element with the identifier
``<formElementIdentifier>`` is empty (think about password fields etc.).
This setting only rules for form elements which creates a FAL object like ``FileUpload`` or ``ImageUpload``.
By default, the uid of the FAL object will be written into the database column. Set this to true if you want to store the
FAL identifier (1:/user_uploads/some_uploaded_pic.jpg) instead.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.savetodatabase.options.elements.<formelementidentifier>.skipifvalueisempty:
options.elements.<formElementIdentifier>.skipIfValueIsEmpty
-------------------------------------------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.SaveToDatabase.options.elements.<formElementIdentifier>.skipIfValueIsEmpty
:aspect:`Data type`
bool
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
No
:aspect:`Default value`
false
:aspect:`Good to know`
- :ref:`"SaveToDatabase finisher"<apireference-finisheroptions-savetodatabasefinisher>`
- :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`
:aspect:`Description`
Set this to true if the database column should not be written if the value from the submitted form element with the identifier
``<formElementIdentifier>`` is empty (think about password fields etc.). Empty means strings without content, whitespace
is valid content.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.savetodatabase.options.elements.<formelementidentifier>.dateformat:
options.elements.<formElementIdentifier>.dateFormat
---------------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.SaveToDatabase.options.elements.<formElementIdentifier>.dateFormat
:aspect:`Data type`
string
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
No
:aspect:`Default value`
'U'
:aspect:`Good to know`
- :ref:`"SaveToDatabase finisher"<apireference-finisheroptions-savetodatabasefinisher>`
- :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`
:aspect:`Description`
If the internal Datatype is \DateTime which is true for the form element types "DatePicker" and "Date",
the object needs to be converted into a string value.
This option allows you to define the format of the date.
You can use every format accepted by PHP's date() function (http://php.net/manual/en/function.date.php#refsect1-function.date-parameters).
The default value is "U" which means a Unix timestamp.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.savetodatabase.options.databasecolumnmappings:
options.databaseColumnMappings
------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.SaveToDatabase.options.databaseColumnMappings
:aspect:`Data type`
array
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
No
:aspect:`Default value`
empty array
:aspect:`Good to know`
- :ref:`"SaveToDatabase finisher"<apireference-finisheroptions-savetodatabasefinisher>`
- :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`
:aspect:`Description`
Use this to map database columns to static values.
Each key within ``options.databaseColumnMappings`` has to match with an existing database column.
The value for each key within ``options.databaseColumnMappings`` is an array with additional informations.
This mapping is done *before* the ``options.element`` mapping.
This means if you map a database column to a value through ``options.databaseColumnMappings`` and map a submitted
form element value to the same database column through ``options.element``, the submitted form element value
will override the value you set within ``options.databaseColumnMappings``.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.savetodatabase.options.databasecolumnmappings.<databasecolumnname>.value:
options.databaseColumnMappings.<databaseColumnName>.value
---------------------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.SaveToDatabase.options.databaseColumnMappings.<databaseColumnName>.value
:aspect:`Data type`
string
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
Yes
:aspect:`Default value`
undefined
:aspect:`Good to know`
- :ref:`"SaveToDatabase finisher"<apireference-finisheroptions-savetodatabasefinisher>`
- :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`
:aspect:`Description`
The value which will be written to the database column.
You can also use the :ref:`FormRuntime accessor feature<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>` to access every getable property from the ``FormRuntime``
In short: use something like ``{<formElementIdentifier>}`` to get the value from the submitted form element with the identifier ``<formElementIdentifier>``.
If you use the FormRuntime accessor feature within ``options.databaseColumnMappings`` the functionality is nearly equal
to the ``options.elements`` configuration variant.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.savetodatabase.options.databasecolumnmappings.<databasecolumnname>.skipifvalueisempty:
options.databaseColumnMappings.<databaseColumnName>.skipIfValueIsEmpty
----------------------------------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.SaveToDatabase.options.databaseColumnMappings.<databaseColumnName>.skipIfValueIsEmpty
:aspect:`Data type`
bool
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
No
:aspect:`Default value`
undefined
:aspect:`Good to know`
- :ref:`"SaveToDatabase finisher"<apireference-finisheroptions-savetodatabasefinisher>`
- :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`
:aspect:`Description`
Set this to true if the database column should not be written if the value from `options.databaseColumnMappings.
<databaseColumnName>.value` is empty. Empty means strings without content, whitespace is valid content.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.savetodatabase.options.translation.translationfile:
options.translation.translationFile
-----------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.SaveToDatabase.options.translation.translationFile
:aspect:`Data type`
string/ array
:aspect:`Needed by`
Frontend
:aspect:`Mandatory`
No
:aspect:`Default value`
undefined
:aspect:`Good to know`
- :ref:`"SaveToDatabase finisher"<apireference-finisheroptions-savetodatabasefinisher>`
- :ref:`"Accessing form runtime values"<concepts-finishers-customfinisherimplementations-accessingoptions-formruntimeaccessor>`
- :ref:`"Translate finisher options"<concepts-frontendrendering-translation-finishers>`
: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<concepts-frontendrendering-translation-finishers>` for more informations.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.savetodatabase.formeditor.iconidentifier:
formeditor.iconIdentifier
-------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.SaveToDatabase.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
SaveToDatabase:
formEditor:
iconIdentifier: t3-form-icon-finisher
label: formEditor.elements.Form.finisher.SaveToDatabase.editor.header.label
predefinedDefaults:
options: { }
.. :aspect:`Good to know`
ToDo
:aspect:`Description`
.. include:: ../properties/iconIdentifier.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.savetodatabase.formeditor.label:
formeditor.label
----------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.SaveToDatabase.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
SaveToDatabase:
formEditor:
iconIdentifier: t3-form-icon-finisher
label: formEditor.elements.Form.finisher.SaveToDatabase.editor.header.label
predefinedDefaults:
options: { }
:aspect:`Good to know`
- :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>`
:aspect:`Description`
.. include:: ../properties/label.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.finishersdefinition.savetodatabase.formeditor.predefineddefaults:
formeditor.predefinedDefaults
-----------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.SaveToDatabase.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-
SaveToDatabase:
formEditor:
iconIdentifier: t3-form-icon-finisher
label: formEditor.elements.Form.finisher.SaveToDatabase.editor.header.label
predefinedDefaults:
options: { }
.. :aspect:`Good to know`
ToDo
:aspect:`Description`
.. include:: ../properties/predefinedDefaults.rst
@@ -0,0 +1,4 @@
Every array key must match to the related finisher option name.
For example, the - :ref:`"[Redirect] finisher"<typo3.cms.form.prototypes.\<prototypeidentifier>.finishersdefinition.redirect>` has the option - :ref:`"pageUid"<typo3.cms.form.prototypes.\<prototypeIdentifier>.finishersdefinition.redirect.options.pageuid>`.
If you want to make the ``pageUid`` overwritable within the ``form plugin``, then an array key ``pageUid`` has to exists within ``TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.<finisherIdentifier>.FormEngine.elements``.
The configuration within ``TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersDefinition.Redirect.FormEngine.elements.pageUid`` must follow the TCA syntax.
@@ -0,0 +1,3 @@
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 - :ref:`"FormEngine"<typo3.cms.form.prototypes.\<prototypeIdentifier>.finishersdefinition.\<finisheridentifier>.formengine>` configuration, is shown in a seperate tab.
``label`` is the label for such a tab.
@@ -0,0 +1,2 @@
An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``.
This icon will be shown within the - :ref:`"Inspector [CollectionElementHeaderEditor]"<typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` if the finisher is selected.
@@ -0,0 +1 @@
Classname which implements the finisher.
@@ -0,0 +1 @@
This label will be shown within the - :ref:`"Inspector [CollectionElementHeaderEditor]"<typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` if the finisher is selected.
@@ -0,0 +1 @@
Defines predefined defaults for finisher options which are prefilled, if the finisher is added to a form.
@@ -0,0 +1,725 @@
.. include:: ../../../Includes.txt
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formeditor:
============
[formEditor]
============
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formeditor-properties:
Properties
==========
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formeditor.translationfile:
translationFile
---------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formeditor.translationFile
:aspect:`Data type`
string/ array
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Default value (prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 2
formEditor:
translationFile: 'EXT:form/Resources/Private/Language/Database.xlf'
:aspect:`Good to know`
- :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>`
:aspect:`Description`
Filesystem path(s) to translation files which should be searched for form editor translations.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formeditor.dynamicrequirejsmodules.app:
dynamicRequireJsModules.app
---------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formeditor.dynamicRequireJsModules.app
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Default value (prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 3
formEditor:
dynamicRequireJsModules:
app: TYPO3/CMS/Form/Backend/FormEditor
mediator: TYPO3/CMS/Form/Backend/FormEditor/Mediator
viewModel: TYPO3/CMS/Form/Backend/FormEditor/ViewModel
:aspect:`Good to know`
- :ref:`"Form editor"<concepts-formeditor>`
:aspect:`Description`
RequireJS path for the form editor JavaScript app.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formeditor.dynamicrequirejsmodules.mediator:
dynamicRequireJsModules.mediator
--------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formeditor.dynamicRequireJsModules.mediator
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Default value (prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 4
formEditor:
dynamicRequireJsModules:
app: TYPO3/CMS/Form/Backend/FormEditor
mediator: TYPO3/CMS/Form/Backend/FormEditor/Mediator
viewModel: TYPO3/CMS/Form/Backend/FormEditor/ViewModel
:aspect:`Good to know`
- :ref:`"Form editor"<concepts-formeditor>`
:aspect:`Description`
RequireJS path for the form editor JavaScript mediator.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formeditor.dynamicrequirejsmodules.viewmodel:
dynamicRequireJsModules.viewModel
---------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formeditor.dynamicRequireJsModules.viewModel
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Default value (prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 5
formEditor:
dynamicRequireJsModules:
app: TYPO3/CMS/Form/Backend/FormEditor
mediator: TYPO3/CMS/Form/Backend/FormEditor/Mediator
viewModel: TYPO3/CMS/Form/Backend/FormEditor/ViewModel
:aspect:`Good to know`
- :ref:`"Form editor"<concepts-formeditor>`
:aspect:`Description`
RequireJS path for the form editor JavaScript view model.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formeditor.dynamicrequirejsmodules.additionalviewmodelmodules:
dynamicRequireJsModules.additionalViewModelModules
--------------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formeditor.dynamicRequireJsModules.additionalViewModelModules
:aspect:`Data type`
array
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
No
:aspect:`Default value (prototype 'standard')`
undefined
:aspect:`Good to know`
- :ref:`"Form editor"<concepts-formeditor>`
- :ref:`"Register custom JavaScript modules"<concepts-formeditor-basicjavascriptconcepts-registercustomjavascriptmodules>`
:aspect:`Description`
Array with RequireJS paths for custom JavaScript modules.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formeditor.addinlinesettings:
addInlineSettings
-----------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formeditor.addInlineSettings
:aspect:`Data type`
array
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
No
:aspect:`Default value (prototype 'standard')`
undefined
:aspect:`Good to know`
- :ref:`"Form editor"<concepts-formeditor>`
:aspect:`Description`
Adds Javascript Inline Setting. This will occur in TYPO3.settings - object.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formeditor.maximumundosteps:
maximumUndoSteps
----------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formeditor.maximumUndoSteps
:aspect:`Data type`
int
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Default value (prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 5
formEditor:
maximumUndoSteps: 10
:aspect:`Good to know`
- :ref:`"Form editor"<concepts-formeditor>`
:aspect:`Description`
Define the maximum possible undo steps within the form editor.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formeditor.stylesheets:
stylesheets
-----------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formeditor.stylesheets
:aspect:`Data type`
array
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Default value (prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 2-
formEditor:
stylesheets:
200: 'EXT:form/Resources/Public/Css/form.css'
:aspect:`Good to know`
- :ref:`"Form editor"<concepts-formeditor>`
:aspect:`Description`
The CSS files to be used by the ``form editor``.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formeditor.formeditorfluidconfiguration:
formEditorFluidConfiguration
----------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formeditor.formEditorFluidConfiguration
:aspect:`Data type`
array
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Default value (prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 2-
formEditor:
formEditorFluidConfiguration:
templatePathAndFilename: 'EXT:form/Resources/Private/Backend/Templates/FormEditor/InlineTemplates.html'
partialRootPaths:
10: 'EXT:form/Resources/Private/Backend/Partials/FormEditor/'
layoutRootPaths:
10: 'EXT:form/Resources/Private/Backend/Layouts/FormEditor/'
:aspect:`Good to know`
- :ref:`"Form editor"<concepts-formeditor>`
- :ref:`"view/inspector/editor/insert/perform"<apireference-formeditor-basicjavascriptconcepts-events-view-inspector-editor-insert-perform>`
:aspect:`Description`
Basic fluid template search path configurations.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formeditor.formeditorfluidconfiguration.templatepathandfilename:
formEditorFluidConfiguration.templatePathAndFilename
----------------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formeditor.formEditorFluidConfiguration.templatePathAndFilename
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Default value (prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 3
formEditor:
formEditorFluidConfiguration:
templatePathAndFilename: 'EXT:form/Resources/Private/Backend/Templates/FormEditor/InlineTemplates.html'
partialRootPaths:
10: 'EXT:form/Resources/Private/Backend/Partials/FormEditor/'
layoutRootPaths:
10: 'EXT:form/Resources/Private/Backend/Layouts/FormEditor/'
:aspect:`Good to know`
- :ref:`"Form editor"<concepts-formeditor>`
:aspect:`Description`
Internal setting. Template which render the inline HTML templates which are used by the form editor JavaScript.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formeditor.formeditorfluidconfiguration.partialrootpaths:
formEditorFluidConfiguration.partialRootPaths
---------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formeditor.formEditorFluidConfiguration.partialRootPaths
:aspect:`Data type`
array
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Default value (prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 4-5
formEditor:
formEditorFluidConfiguration:
templatePathAndFilename: 'EXT:form/Resources/Private/Backend/Templates/FormEditor/InlineTemplates.html'
partialRootPaths:
10: 'EXT:form/Resources/Private/Backend/Partials/FormEditor/'
layoutRootPaths:
10: 'EXT:form/Resources/Private/Backend/Layouts/FormEditor/'
:aspect:`Good to know`
- :ref:`"Form editor"<concepts-formeditor>`
- :ref:`"view/inspector/editor/insert/perform"<apireference-formeditor-basicjavascriptconcepts-events-view-inspector-editor-insert-perform>`
:aspect:`Description`
Array with fluid partial search paths for the inline HTML templates which are used by the form editor JavaScript.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formeditor.formeditorfluidconfiguration.layoutrootpaths:
formEditorFluidConfiguration.layoutRootPaths
--------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formeditor.formEditorFluidConfiguration.layoutRootPaths
:aspect:`Data type`
array
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Default value (prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 6-7
formEditor:
formEditorFluidConfiguration:
templatePathAndFilename: 'EXT:form/Resources/Private/Backend/Templates/FormEditor/InlineTemplates.html'
partialRootPaths:
10: 'EXT:form/Resources/Private/Backend/Partials/FormEditor/'
layoutRootPaths:
10: 'EXT:form/Resources/Private/Backend/Layouts/FormEditor/'
:aspect:`Good to know`
- :ref:`"Form editor"<concepts-formeditor>`
- :ref:`"view/inspector/editor/insert/perform"<apireference-formeditor-basicjavascriptconcepts-events-view-inspector-editor-insert-perform>`
:aspect:`Description`
Internal setting. Array with fluid layout search paths.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formeditor.formeditorpartials:
formEditorPartials
------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formeditor.formEditorPartials
:aspect:`Data type`
array
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Default value (prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 2-
formEditor:
formEditorPartials:
FormElement-_ElementToolbar: Stage/_ElementToolbar
FormElement-_UnknownElement: Stage/_UnknownElement
FormElement-Page: Stage/Page
FormElement-SummaryPage: Stage/SummaryPage
FormElement-Fieldset: Stage/Fieldset
FormElement-GridContainer: Stage/Fieldset
FormElement-GridRow: Stage/Fieldset
FormElement-Text: Stage/SimpleTemplate
FormElement-Password: Stage/SimpleTemplate
FormElement-AdvancedPassword: Stage/SimpleTemplate
FormElement-Textarea: Stage/SimpleTemplate
FormElement-Checkbox: Stage/SimpleTemplate
FormElement-MultiCheckbox: Stage/SelectTemplate
FormElement-MultiSelect: Stage/SelectTemplate
FormElement-RadioButton: Stage/SelectTemplate
FormElement-SingleSelect: Stage/SelectTemplate
FormElement-DatePicker: Stage/SimpleTemplate
FormElement-StaticText: Stage/StaticText
FormElement-Hidden: Stage/SimpleTemplate
FormElement-ContentElement: Stage/ContentElement
FormElement-FileUpload: Stage/FileUploadTemplate
FormElement-ImageUpload: Stage/FileUploadTemplate
FormElement-Email: 'Stage/SimpleTemplate'
FormElement-Telephone: 'Stage/SimpleTemplate'
FormElement-Url: 'Stage/SimpleTemplate'
FormElement-Number: 'Stage/SimpleTemplate'
FormElement-Date: 'Stage/SimpleTemplate'
Modal-InsertElements: Modals/InsertElements
Modal-InsertPages: Modals/InsertPages
Modal-ValidationErrors: Modals/ValidationErrors
Inspector-FormElementHeaderEditor: Inspector/FormElementHeaderEditor
Inspector-CollectionElementHeaderEditor: Inspector/CollectionElementHeaderEditor
Inspector-TextEditor: Inspector/TextEditor
Inspector-PropertyGridEditor: Inspector/PropertyGridEditor
Inspector-SingleSelectEditor: Inspector/SingleSelectEditor
Inspector-MultiSelectEditor: Inspector/MultiSelectEditor
Inspector-GridColumnViewPortConfigurationEditor: Inspector/GridColumnViewPortConfigurationEditor
Inspector-TextareaEditor: Inspector/TextareaEditor
Inspector-RemoveElementEditor: Inspector/RemoveElementEditor
Inspector-FinishersEditor: Inspector/FinishersEditor
Inspector-ValidatorsEditor: Inspector/ValidatorsEditor
Inspector-RequiredValidatorEditor: Inspector/RequiredValidatorEditor
Inspector-CheckboxEditor: Inspector/CheckboxEditor
Inspector-ValidationErrorMessageEditor: Inspector/ValidationErrorMessageEditor
Inspector-Typo3WinBrowserEditor: Inspector/Typo3WinBrowserEditor
:aspect:`Good to know`
- :ref:`"Form editor"<concepts-formeditor>`
- :ref:`"Common Abstract view formelement templates"<apireference-formeditor-stage-commonabstractformelementtemplates>`
- :ref:`"available inspector editors"<typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formEditor.editors-availableinspectoreditors>`
- :ref:`"view/inspector/editor/insert/perform"<apireference-formeditor-basicjavascriptconcepts-events-view-inspector-editor-insert-perform>`
:aspect:`Description`
Array with mappings for the inline HTML templates. The keys are identifierts which could be used within the JavaScript code. The values are partial paths, relative to :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formeditor.formEditorFluidConfiguration.partialRootPaths"<typo3.cms.form.prototypes.\<prototypeidentifier>.formeditor.formeditorfluidconfiguration.partialrootpaths>`.
The partials content will be rendered as inline HTML. This inline HTML templates can be identified and used by such a key (e.g. "Inspector-TextEditor") within the JavaScript code.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formeditor.formelementpropertyvalidatorsdefinition:
formElementPropertyValidatorsDefinition
---------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formeditor.formElementPropertyValidatorsDefinition
:aspect:`Data type`
array
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Default value (prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 2-
formEditor:
formElementPropertyValidatorsDefinition:
NotEmpty:
errorMessage: formEditor.formElementPropertyValidatorsDefinition.NotEmpty.label
Integer:
errorMessage: formEditor.formElementPropertyValidatorsDefinition.Integer.label
NaiveEmail:
errorMessage: formEditor.formElementPropertyValidatorsDefinition.NaiveEmail.label
NaiveEmailOrEmpty:
errorMessage: formEditor.formElementPropertyValidatorsDefinition.NaiveEmail.label
FormElementIdentifierWithinCurlyBracesInclusive:
errorMessage: formEditor.formElementPropertyValidatorsDefinition.FormElementIdentifierWithinCurlyBraces.label
FormElementIdentifierWithinCurlyBracesExclusive:
errorMessage: formEditor.formElementPropertyValidatorsDefinition.FormElementIdentifierWithinCurlyBraces.label
FileSize:
errorMessage: formEditor.formElementPropertyValidatorsDefinition.FileSize.label
RFC3339FullDate:
errorMessage: formEditor.formElementPropertyValidatorsDefinition.RFC3339FullDate.label
:aspect:`Related options`
- :ref:`"[TextEditor] propertyValidators"<typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.propertyvalidators-texteditor>`
- :ref:`"[Typo3WinBrowserEditor] propertyValidators"<typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.propertyvalidators-typo3winbrowsereditor>`
:aspect:`Good to know`
- :ref:`"Form editor"<concepts-formeditor>`
:aspect:`Description`
Some inspector editors are able to validate it's values through a JavaScript methods.
``formElementPropertyValidatorsDefinition`` define basic configurations for such JavaScript validators.
This JavaScript validators can be registered through ``getFormEditorApp().addPropertyValidationValidator()``. The first method argument is the identifier
for this validator. Every array key within ``formElementPropertyValidatorsDefinition`` must be equal to such a identifier.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formeditor.formelementpropertyvalidatorsdefinition.<formelementpropertyvalidatoridentifier>.errormessage:
formElementPropertyValidatorsDefinition.<formElementPropertyValidatorIdentifier>.errorMessage
---------------------------------------------------------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formeditor.formElementPropertyValidatorsDefinition.<formElementPropertyValidatorIdentifier>.errorMessage
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Default value (prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 4, 6, 8, 10, 12, 14
formEditor:
formElementPropertyValidatorsDefinition:
NotEmpty:
errorMessage: formEditor.formElementPropertyValidatorsDefinition.NotEmpty.label
Integer:
errorMessage: formEditor.formElementPropertyValidatorsDefinition.Integer.label
NaiveEmail:
errorMessage: formEditor.formElementPropertyValidatorsDefinition.NaiveEmail.label
NaiveEmailOrEmpty:
errorMessage: formEditor.formElementPropertyValidatorsDefinition.NaiveEmail.label
FormElementIdentifierWithinCurlyBracesInclusive:
errorMessage: formEditor.formElementPropertyValidatorsDefinition.FormElementIdentifierWithinCurlyBraces.label
FormElementIdentifierWithinCurlyBracesExclusive:
errorMessage: formEditor.formElementPropertyValidatorsDefinition.FormElementIdentifierWithinCurlyBraces.label
FileSize:
errorMessage: formEditor.formElementPropertyValidatorsDefinition.FileSize.label
RFC3339FullDate:
errorMessage: formEditor.formElementPropertyValidatorsDefinition.RFC3339FullDate.label
:aspect:`Related options`
- :ref:`"[TextEditor] propertyValidators"<typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.propertyvalidators-texteditor>`
- :ref:`"[Typo3WinBrowserEditor] propertyValidators"<typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.propertyvalidators-typo3winbrowsereditor>`
:aspect:`Good to know`
- :ref:`"Form editor"<concepts-formeditor>`
:aspect:`Description`
The error message for a inspector editor property validator which is shown if the validation fails.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formeditor.formelementgroups:
formElementGroups
-----------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formeditor.formElementGroups
:aspect:`Data type`
array
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Default value (prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 2-
formEditor:
formElementGroups:
input:
label: formEditor.formElementGroups.input.label
html5:
label: 'formEditor.formElementGroups.html5.label'
select:
label: formEditor.formElementGroups.select.label
custom:
label: formEditor.formElementGroups.custom.label
container:
label: formEditor.formElementGroups.container.label
page:
label: formEditor.formElementGroups.page.label
:aspect:`Related options`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.Checkbox.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.checkbox.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.ContentElement.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.contentelement.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.Date.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.date.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.DatePicker.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.datepicker.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.Email.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.email.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.Fieldset.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.fieldset.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.FileUpload.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.fileupload.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.GridRow.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.gridrow.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.Hidden.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.hidden.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.ImageUpload.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.imageupload.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.multicheckbox.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.MultiSelect.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.multiselect.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.Number.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.number.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.Page.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.page.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.Password.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.password.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.RadioButton.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.radiobutton.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.SingleSelect.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.singleselect.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.StaticText.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.statictext.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.SummaryPage.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.summarypage.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.Telephone.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.telephone.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.Text.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.text.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.Url.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.url.formeditor.group>`
:aspect:`Good to know`
- :ref:`"Form editor"<concepts-formeditor>`
:aspect:`Description`
Every form element can be placed within a group within the ``form editor`` "new Element" modal.
Every form element which should be shown within such a group, must have a ``group`` property. The form element ``group`` property value
must be equal to an array key within ``formElementGroups``.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formeditor.formelementgroups.<formelementgroupidentifier>.label:
formElementGroups.<formElementGroupIdentifier>.label
----------------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formeditor.formElementGroups.<formElementGroupIdentifier>.label
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Default value (prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 4, 6, 8, 10, 12
formEditor:
formElementGroups:
input:
label: formEditor.formElementGroups.input.label
select:
label: formEditor.formElementGroups.select.label
custom:
label: formEditor.formElementGroups.custom.label
container:
label: formEditor.formElementGroups.container.label
page:
label: formEditor.formElementGroups.page.label
:aspect:`Good to know`
- :ref:`"Form editor"<concepts-formeditor>`
:aspect:`Description`
The label for a group within the ``form editor`` "new Element" modal.
@@ -0,0 +1,835 @@
.. include:: ../../../Includes.txt
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition:
========================
[formElementsDefinition]
========================
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition-properties:
Properties
==========
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.*:
[formElementsDefinition]
------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition
:aspect:`Data type`
array
:aspect:`Needed by`
Frontend/ Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Default value`
.. code-block:: yaml
:linenos:
prototypes:
<prototypeIdentifier>:
formElementsDefinition:
[...]
:aspect:`Good to know`
- :ref:`"Custom form element implementations"<concepts-frontendrendering-codecomponents-customformelementimplementations>`
:aspect:`Description`
Array which defines the available form elements. Every key within this array is called the ``<formElementTypeIdentifier>``.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>:
<formElementTypeIdentifier>
---------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>
:aspect:`Data type`
string
:aspect:`Needed by`
Frontend/ Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
prototypes:
standard:
Form:
[...]
Page:
[...]
SummaryPage:
[...]
Fieldset:
[...]
GridContainer:
[...]
GridRow:
[...]
Text:
[...]
Password:
[...]
AdvancedPassword:
[...]
Textarea:
[...]
Honeypot:
[...]
Hidden:
[...]
Email:
[...]
Telephone:
[...]
Url:
[...]
Number:
[...]
Date:
[...]
Checkbox:
[...]
MultiCheckbox:
[...]
MultiSelect:
[...]
RadioButton:
[...]
SingleSelect:
[...]
DatePicker:
[...]
StaticText:
[...]
ContentElement:
[...]
FileUpload:
[...]
ImageUpload:
[...]
:aspect:`Good to know`
- :ref:`"Custom form element implementations"<concepts-frontendrendering-codecomponents-customformelementimplementations>`
:aspect:`Description`
This array key identifies a form element. This identifier could be used to attach a form element to a form.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>-commonproperties:
Common <formElementTypeIdentifier> properties
=============================================
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.defaultValue:
defaultValue
------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.defaultValue
:aspect:`Data type`
string/ array
:aspect:`Needed by`
Frontend/ Backend (form editor)
:aspect:`Mandatory`
No
:aspect:`Default value`
undefined
:aspect:`Description`
If set this string/ array will be used as default value of the form
element. Array is in place for multi value elements (e.g. the
``MultiSelect`` form element).
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.implementationclassname:
implementationClassName
-----------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.implementationClassName
:aspect:`Data type`
string
:aspect:`Needed by`
Frontend/ Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Default value`
Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`)
:aspect:`Good to know`
- :ref:`"Custom form element implementations"<concepts-frontendrendering-codecomponents-customformelementimplementations>`
:aspect:`Description`
Classname which implements the form element.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.renderingoptions.translation.translationfile:
renderingOptions.translation.translationFile
--------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.renderingOptions.translation.translationFile
:aspect:`Data type`
string/ array
:aspect:`Needed by`
Frontend/ Backend (form editor)
:aspect:`Mandatory`
No
:aspect:`Default value`
Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`)
:aspect:`Good to know`
- :ref:`"Custom form element implementations"<concepts-frontendrendering-codecomponents-customformelementimplementations>`
- :ref:`"Translate form definition"<concepts-frontendrendering-translation-formdefinition>`
:aspect:`Description`
Filesystem path(s) to translation files which should be searched for form element property translations.
If ``translationFile`` is undefined, - :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.Form.renderingOptions.translation.translationFile"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.form.renderingoptions.translation.translationfile>` will be used.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.renderingOptions.translation.translatePropertyValueIfEmpty:
renderingOptions.translation.translatePropertyValueIfEmpty
----------------------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.renderingoptions.translation.translatepropertyvalueifempty
:aspect:`Data type`
bool
:aspect:`Needed by`
Frontend/ Backend (form editor)
:aspect:`Mandatory`
No
:aspect:`Default value`
true
:aspect:`Good to know`
- :ref:`"Custom form element implementations"<concepts-frontendrendering-codecomponents-customformelementimplementations>`
- :ref:`"Translate form definition"<concepts-frontendrendering-translation-formdefinition>`
:aspect:`Description`
If set to ``false``, the form element property translation will be skipped if the form element property value is empty.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.renderingoptions.templatename:
renderingOptions.templateName
-----------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.renderingOptions.templateName
:aspect:`Data type`
string
:aspect:`Needed by`
Frontend/ Backend (form editor)
:aspect:`Mandatory`
(see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`)
:aspect:`Default value`
undefined
:aspect:`Good to know`
- :ref:`"Custom form element implementations"<concepts-frontendrendering-codecomponents-customformelementimplementations>`
- :ref:`"templateName"<apireference-frontendrendering-fluidformrenderer-options-templatename>`
:aspect:`Description`
Set ``templateName`` to define a custom template name which should be used instead of the ``<formElementTypeIdentifier>``.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.properties:
properties
----------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.properties
:aspect:`Data type`
array
:aspect:`Needed by`
Frontend/ Backend (form editor)
:aspect:`Mandatory`
No
:aspect:`Default value`
Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`)
:aspect:`Good to know`
- :ref:`"Custom form element implementations"<concepts-frontendrendering-codecomponents-customformelementimplementations>`
- :ref:`"Translate form definition"<concepts-frontendrendering-translation-formdefinition>`
:aspect:`Description`
Array with form element specific properties.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.properties.elementDescription:
properties.elementDescription
-----------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.properties.elementDescription
:aspect:`Data type`
string
:aspect:`Needed by`
Frontend/ Backend (form editor)
:aspect:`Mandatory`
No
:aspect:`Default value`
Undefined
:aspect:`Good to know`
- :ref:`"Custom form element implementations"<concepts-frontendrendering-codecomponents-customformelementimplementations>`
- :ref:`"Translate form definition"<concepts-frontendrendering-translation-formdefinition>`
:aspect:`Description`
Set a description of the form element. By default, it is displayed
below the form element.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.properties.fluidadditionalattributes:
properties.fluidAdditionalAttributes
------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.properties.fluidAdditionalAttributes
:aspect:`Data type`
array
:aspect:`Needed by`
Frontend/ Backend (form editor)
:aspect:`Mandatory`
No
:aspect:`Default value`
Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`)
:aspect:`Good to know`
- :ref:`"Custom form element implementations"<concepts-frontendrendering-codecomponents-customformelementimplementations>`
- :ref:`"Translate form definition"<concepts-frontendrendering-translation-formdefinition>`
:aspect:`Description`
The values within this array goes directely into the fluid form element viewhelpers property ``additionalAttributes``.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.properties.gridcolumnclassautoconfiguration:
properties.gridColumnClassAutoConfiguration
-------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.properties.gridColumnClassAutoConfiguration
:aspect:`Data type`
array
:aspect:`Needed by`
Frontend/ Backend (form editor)
:aspect:`Mandatory`
No
:aspect:`Default value`
Undefined
:aspect:`Related options`
- :ref:`"GridRow viewPorts"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.gridrow.properties.gridcolumnclassautoconfiguration.viewports>`
:aspect:`Description`
If the form element lies within a GridRow you can define the number of columns which the form element should occupy.
Each ``viewPorts`` configuration key has to match with on ofe the defined viewports within ``TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.GridRow.properties.gridColumnClassAutoConfiguration.viewPorts``
.. code-block:: yaml
:linenos:
gridColumnClassAutoConfiguration:
viewPorts:
lg:
numbersOfColumnsToUse: '2'
md:
numbersOfColumnsToUse: '3'
sm:
numbersOfColumnsToUse: '4'
xs:
numbersOfColumnsToUse: '5'
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.label:
label
-----
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.label
:aspect:`Data type`
string
:aspect:`Needed by`
Frontend/ Backend (form editor)
:aspect:`Mandatory`
No
:aspect:`Default value`
Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`)
:aspect:`Good to know`
- :ref:`"Custom form element implementations"<concepts-frontendrendering-codecomponents-customformelementimplementations>`
- :ref:`"Translate form definition"<concepts-frontendrendering-translation-formdefinition>`
:aspect:`Description`
The label of the form element.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor:
formEditor
----------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor
:aspect:`Data type`
array
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
No (but recommended)
:aspect:`Default value`
Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`)
.. :aspect:`Good to know`
ToDo
:aspect:`Description`
Array with configurations for the ``form editor``
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.predefineddefaults:
formEditor.predefinedDefaults
-----------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.predefinedDefaults
:aspect:`Data type`
array
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Default value`
Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`)
:aspect:`Good to know`
- :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>`
:aspect:`Description`
Defines predefined defaults for form element properties which are prefilled, if the form element is added to a form.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.propertycollections:
formEditor.propertyCollections
------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.propertyCollections
:aspect:`Data type`
array
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
No
:aspect:`Default value`
Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`)
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
:aspect:`Description`
Array with configurations for ``property collections`` for the form element.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.propertycollections.validators:
formEditor.propertyCollections.validators
-----------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.propertyCollections.validators
:aspect:`Data type`
array
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
No
:aspect:`Default value`
Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`)
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
:aspect:`Description`
Array with configurations for available validators for a form element.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.propertycollections.validators.*.identifier:
formEditor.propertyCollections.validators.[*].identifier
--------------------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.propertyCollections.validators.[*].identifier
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Default value`
Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`)
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
- :ref:`"\<validatorIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>>`
:aspect:`Description`
Identifies the validator which should be attached to the form element. Must be equal to a existing ``<validatorIdentifier>``.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.propertycollections.validators.*.editors:
formEditor.propertyCollections.validators.[*].editors
-----------------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.propertyCollections.validators.[*].editors
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Default value`
Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`)
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
:aspect:`Description`
Array with available ``inspector editors`` for this validator.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.propertycollections.finishers:
formEditor.propertyCollections.finishers
----------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.propertyCollections.finishers
:aspect:`Data type`
array
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
No
:aspect:`Default value`
Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`)
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
:aspect:`Description`
Array with configurations for available finisher for a form definition.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.propertycollections.finishers.*.identifier:
formEditor.propertyCollections.finishers.[*].identifier
-------------------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.propertyCollections.finishers.[*].identifier
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
No
:aspect:`Default value`
Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`)
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
- :ref:`"\<finisherIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.finishersdefinition.\<finisheridentifier>>`
:aspect:`Description`
Identifies the finisher which should be attached to the form definition. Must be equal to a existing ``<finisherIdentifier>``.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.propertycollections.finishers.*.editors:
formEditor.propertyCollections.finishers.[*].editors
----------------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.propertyCollections.finishers.[*].editors
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
No
:aspect:`Default value`
Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`)
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
:aspect:`Description`
Array with available ``inspector editors`` for this finisher.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.label:
formEditor.label
----------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.label
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Default value`
Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`)
:aspect:`Good to know`
- :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>`
:aspect:`Description`
This label will be shown within the "new element" Modal.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.group:
formEditor.group
----------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.group
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
No
:aspect:`Related options`
- :ref:`TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formEditor.formElementGroups <typo3.cms.form.prototypes.\<prototypeidentifier>.formeditor.formelementgroups>`
:aspect:`Default value`
Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`)
:aspect:`Description`
Define within which group within the ``form editor`` "new Element" modal the form element should be shown.
The ``group`` value must be equal to an array key within ``formElementGroups``.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.groupsorting:
formEditor.groupSorting
-----------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.groupSorting
:aspect:`Data type`
int
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
No
:aspect:`Default value`
Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`)
.. :aspect:`Good to know`
ToDo
:aspect:`Description`
The position within the ``formEditor.group`` for this form element.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.iconidentifier:
formEditor.iconIdentifier
-------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.iconIdentifier
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Default value`
Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`)
.. :aspect:`Good to know`
ToDo
:aspect:`Description`
An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``.
This icon will be shown within
- :ref:`"Inspector [FormElementHeaderEditor]"<typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>`.
- :ref:`"Abstract view formelement templates"<apireference-formeditor-stage-commonabstractformelementtemplates>`.
- ``Tree`` component.
- "new element" Modal
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formEditor.editors-tree:
formEditor.editors
------------------
.. toctree::
formEditor/Index
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>-concreteconfigurations:
Concrete configurations
=======================
.. toctree::
formElementTypes/AdvancedPassword
formElementTypes/Checkbox
formElementTypes/Date
formElementTypes/ContentElement
formElementTypes/DatePicker
formElementTypes/Email
formElementTypes/Fieldset
formElementTypes/FileUpload
formElementTypes/Form
formElementTypes/GridContainer
formElementTypes/GridRow
formElementTypes/Hidden
formElementTypes/Honeypot
formElementTypes/ImageUpload
formElementTypes/MultiCheckbox
formElementTypes/MultiSelect
formElementTypes/Number
formElementTypes/Page
formElementTypes/Password
formElementTypes/RadioButton
formElementTypes/SingleSelect
formElementTypes/StaticText
formElementTypes/SummaryPage
formElementTypes/Telephone
formElementTypes/Text
formElementTypes/Textarea
formElementTypes/Url
@@ -0,0 +1,111 @@
.. include:: ../../../../Includes.txt
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*:
==================================================
[<formElementTypeIdentifier>][formEditor][editors]
==================================================
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors-properties:
Properties
==========
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors:
<formElementTypeIdentifier>.formEditor.editors
----------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeidentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.editors
:aspect:`Data type`
array
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`)
:aspect:`Default value`
Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`)
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
:aspect:`Description`
Array with numerical keys. Each arrayitem describes an ``inspector editor`` which is used to write values into a form element property.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*-commonproperties:
Common [<formElementTypeIdentifier>][formEditor][editors][*] properties
=======================================================================
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.identifier:
.. include:: inspectorEditors/properties/Identifier.rst
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.templatename:
templateName
------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.editors.*.templateName
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Related options`
- :ref:`TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formEditor.formEditorPartials <typo3.cms.form.prototypes.\<prototypeidentifier>.formeditor.formeditorpartials>`
:aspect:`Default value`
Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`)
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
:aspect:`Description`
.. include:: inspectorEditors/properties/TemplateName.rst
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.label:
.. include:: inspectorEditors/properties/Label.rst
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.propertypath:
.. include:: inspectorEditors/properties/PropertyPath.rst
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formEditor.editors-availableinspectoreditors:
available inspector editors
---------------------------
.. toctree::
inspectorEditors/CheckboxEditor
inspectorEditors/CollectionElementHeaderEditor
inspectorEditors/FinishersEditor
inspectorEditors/FormElementHeaderEditor
inspectorEditors/GridColumnViewPortConfigurationEditor
inspectorEditors/MultiSelectEditor
inspectorEditors/PropertyGridEditor
inspectorEditors/RemoveElementEditor
inspectorEditors/RequiredValidatorEditor
inspectorEditors/SingleSelectEditor
inspectorEditors/TextareaEditor
inspectorEditors/TextEditor
inspectorEditors/Typo3WinBrowserEditor
inspectorEditors/ValidatorsEditor
inspectorEditors/ValidationErrorMessageEditor
@@ -0,0 +1,60 @@
.. include:: ../../../../../Includes.txt
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.checkboxeditor:
================
[CheckboxEditor]
================
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.checkboxeditor-introduction:
Introduction
============
Shows a checkbox which write 'true' or 'false' within the form definition for a form element property.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.checkboxeditor-properties:
Properties
==========
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.templatename-checkboxeditor:
templateName
------------
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Related options`
- :ref:`TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formEditor.formEditorPartials <typo3.cms.form.prototypes.\<prototypeidentifier>.formeditor.formeditorpartials>`
:aspect:`value`
Inspector-CheckboxEditor
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
:aspect:`Description`
.. include:: properties/TemplateName.rst
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.identifier-checkboxeditor:
.. include:: properties/Identifier.rst
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.label-checkboxeditor:
.. include:: properties/Label.rst
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.propertypath-checkboxeditor:
.. include:: properties/PropertyPath.rst
@@ -0,0 +1,57 @@
.. include:: ../../../../../Includes.txt
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor:
===============================
[CollectionElementHeaderEditor]
===============================
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor-introduction:
Introduction
============
This is not really an editor because this editor don't write values into the form definition.
This editor show the header area for collection elements (finishers/ validators) with it's icon and label.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor-properties:
Properties
==========
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.templateName-collectionelementheadereditor:
templateName
------------
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Related options`
- :ref:`TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formEditor.formEditorPartials <typo3.cms.form.prototypes.\<prototypeidentifier>.formeditor.formeditorpartials>`
:aspect:`value`
Inspector-CollectionElementHeaderEditor
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
:aspect:`Description`
.. include:: properties/TemplateName.rst
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.identifier-collectionelementheadereditor:
.. include:: properties/Identifier.rst
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.label-collectionelementheadereditor:
.. include:: properties/Label.rst
@@ -0,0 +1,105 @@
.. include:: ../../../../../Includes.txt
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.finisherseditor:
=================
[FinishersEditor]
=================
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.finisherseditor-introduction:
Introduction
============
Shows a select list with finishers. If a finisher is already added to the form definition, then this finisher will be removed from the select list.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.finisherseditor-properties:
Properties
==========
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.templatename-finisherseditor:
templateName
------------
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Related options`
- :ref:`TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formEditor.formEditorPartials <typo3.cms.form.prototypes.\<prototypeidentifier>.formeditor.formeditorpartials>`
:aspect:`value`
Inspector-FinishersEditor
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
:aspect:`Description`
.. include:: properties/TemplateName.rst
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.identifier-finisherseditor:
.. include:: properties/Identifier.rst
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.label-finisherseditor:
.. include:: properties/Label.rst
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.selectoptions.*.value-finisherseditor:
selectOptions.[*].value
-----------------------
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Related options`
- :ref:`"[finishersDefinition]"<typo3.cms.form.prototypes.\<prototypeidentifier>.finishersdefinition.*>`
.. :aspect:`Good to know`
ToDo
:aspect:`Description`
Has to match with a ``TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.finishersdefinition`` configuration key.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.selectoptions.*.label-finisherseditor:
selectOptions.[*].label
-----------------------
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
.. :aspect:`Related options`
@ToDo
.. :aspect:`Good to know`
ToDo
:aspect:`Description`
The label which is shown within the select field.
@@ -0,0 +1,53 @@
.. include:: ../../../../../Includes.txt
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor:
=========================
[FormElementHeaderEditor]
=========================
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor-introduction:
Introduction
============
This is not really an editor because this editor don't write values into the form definition.
This editor show the header area for the form element with it's icon and label.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor-properties:
Properties
==========
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.templatename-formelementheadereditor:
templateName
------------
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Related options`
- :ref:`TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formEditor.formEditorPartials <typo3.cms.form.prototypes.\<prototypeidentifier>.formeditor.formeditorpartials>`
:aspect:`value`
Inspector-FormElementHeaderEditor
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
:aspect:`Description`
.. include:: properties/TemplateName.rst
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.identifier-formelementheadereditor:
.. include:: properties/Identifier.rst
@@ -0,0 +1,175 @@
.. include:: ../../../../../Includes.txt
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.gridcolumnviewportconfigurationeditor:
=======================================
[GridColumnViewPortConfigurationEditor]
=======================================
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.gridcolumnviewportconfigurationeditor-introduction:
Introduction
============
Shows a viewport selector as buttons and an input field. With this editor, you can define how many columns per viewPort an form element should occupy.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.gridcolumnviewportconfigurationeditor-properties:
Properties
==========
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.templateName-gridcolumnviewportconfigurationeditor:
templateName
------------
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Related options`
- :ref:`TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formEditor.formEditorPartials <typo3.cms.form.prototypes.\<prototypeidentifier>.formeditor.formeditorpartials>`
:aspect:`value`
Inspector-GridColumnViewPortConfigurationEditor
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
:aspect:`Description`
.. include:: properties/TemplateName.rst
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.identifier-gridcolumnviewportconfigurationeditor:
.. include:: properties/Identifier.rst
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.label-gridcolumnviewportconfigurationeditor:
.. include:: properties/Label.rst
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.configurationOptions.viewPorts.*.viewPortIdentifier-gridcolumnviewportconfigurationeditor:
configurationOptions.viewPorts.[*].viewPortIdentifier
-----------------------------------------------------
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Related options`
- :ref:`"properties.gridColumnClassAutoConfiguration"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.\<formelementtypeidentifier>.properties.gridcolumnclassautoconfiguration>`
.. :aspect:`Good to know`
ToDo
:aspect:`Description`
Has to match with a ``TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.properties.gridColumnClassAutoConfiguration.viewPorts`` configuration key.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.configurationOptions.viewPorts.*.label-gridcolumnviewportconfigurationeditor:
configurationOptions.viewPorts.[*].label
----------------------------------------
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
.. :aspect:`Related options`
@ToDo
.. :aspect:`Good to know`
ToDo
:aspect:`Description`
The label for the viewport button.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.configurationOptions.numbersOfColumnsToUse.label-gridcolumnviewportconfigurationeditor:
configurationOptions.numbersOfColumnsToUse.label
------------------------------------------------
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
.. :aspect:`Related options`
@ToDo
.. :aspect:`Good to know`
ToDo
:aspect:`Description`
The label for the "Numbers of columns" input field.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.configurationOptions.numbersOfColumnsToUse.propertyPath-gridcolumnviewportconfigurationeditor:
configurationOptions.numbersOfColumnsToUse.propertyPath
-------------------------------------------------------
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
.. :aspect:`Related options`
@ToDo
.. :aspect:`Good to know`
ToDo
:aspect:`Description`
The path to the property of the form element which should be written.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.configurationOptions.numbersOfColumnsToUse.fieldExplanationText-gridcolumnviewportconfigurationeditor:
configurationOptions.numbersOfColumnsToUse.fieldExplanationText
---------------------------------------------------------------
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
.. :aspect:`Related options`
@ToDo
.. :aspect:`Good to know`
ToDo
:aspect:`Description`
A text which is shown at the bottom of the "Numbers of columns" input field.
@@ -0,0 +1,108 @@
.. include:: ../../../../../Includes.txt
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.multiselecteditor:
===================
[MultiSelectEditor]
===================
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.multiselecteditor-introduction:
Introduction
============
Shows a multiselect list with values. If one or more selectoptions are selected, then the option value will be written within a form element property which is defined by the "propertyPath" option.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.multiselecteditor-properties:
Properties
==========
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.templatename-multiselecteditor:
templateName
------------
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Related options`
- :ref:`TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formEditor.formEditorPartials <typo3.cms.form.prototypes.\<prototypeidentifier>.formeditor.formeditorpartials>`
:aspect:`value`
Inspector-MultiSelectEditor
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
:aspect:`Description`
.. include:: properties/TemplateName.rst
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.identifier-multiselecteditor:
.. include:: properties/Identifier.rst
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.label-multiselecteditor:
.. include:: properties/Label.rst
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.propertypath-multiselecteditor:
.. include:: properties/PropertyPath.rst
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.selectoptions.*.value-multiselecteditor:
selectOptions.[*].value
-----------------------
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
.. :aspect:`Related options`
@ToDo
.. :aspect:`Good to know`
ToDo
:aspect:`Description`
The value which should be written into the corresponding form elements property.
The corresponding form elements property is identified by the ``propertyPath`` option.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.selectoptions.*.label-multiselecteditor:
selectOptions.[*].label
-----------------------
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
.. :aspect:`Related options`
@ToDo
.. :aspect:`Good to know`
ToDo
:aspect:`Description`
The label which is shown within the select field.
@@ -0,0 +1,232 @@
.. include:: ../../../../../Includes.txt
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.propertygrideditor:
====================
[PropertyGridEditor]
====================
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.propertygrideditor-introduction:
Introduction
============
Shows a grid which allows you to add (and remove) multiple rows and fill values for each row.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.propertygrideditor-properties:
Properties
==========
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.templatename-propertygrideditor:
templateName
------------
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Related options`
- :ref:`TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formEditor.formEditorPartials <typo3.cms.form.prototypes.\<prototypeidentifier>.formeditor.formeditorpartials>`
:aspect:`value`
Inspector-PropertyGridEditor
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
:aspect:`Description`
.. include:: properties/TemplateName.rst
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.identifier-propertygrideditor:
.. include:: properties/Identifier.rst
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.label-propertygrideditor:
.. include:: properties/Label.rst
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.propertypath-propertygrideditor:
.. include:: properties/PropertyPath.rst
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.issortable-propertygrideditor:
isSortable
----------
:aspect:`Data type`
bool
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
.. :aspect:`Related options`
@ToDo
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
:aspect:`Description`
If set to 'false' the rows are not sortable.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.enableaddrow-propertygrideditor:
enableAddRow
------------
:aspect:`Data type`
bool
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
.. :aspect:`Related options`
@ToDo
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
:aspect:`Description`
If set to 'false' the "add new row" button is disabled.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.enabledeleterow-propertygrideditor:
enableDeleteRow
---------------
:aspect:`Data type`
bool
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
.. :aspect:`Related options`
@ToDo
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
:aspect:`Description`
If set to 'false' the "delete row" button is disabled.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.multiselection-propertygrideditor:
multiSelection
--------------
:aspect:`Data type`
bool
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
.. :aspect:`Related options`
@ToDo
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
:aspect:`Description`
If set to 'false' only one row can be marked as preselected.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.removelastavailablerowflashmessagetitle-propertygrideditor:
removeLastAvailableRowFlashMessageTitle
---------------------------------------
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
.. :aspect:`Related options`
@ToDo
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
- :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>`
:aspect:`Description`
There must be at least one existing row within this ``inspector editor``. If the last existing row is tried to be removed a flash message is shown.
This property define the title for the flash message.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.removelastavailablerowflashmessagemessage-propertygrideditor:
removeLastAvailableRowFlashMessageMessage
-----------------------------------------
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
.. :aspect:`Related options`
@ToDo
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
- :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>`
:aspect:`Description`
There must be at least one existing row within this ``inspector editor``. If the last existing row is tried to be removed a flash message is shown.
This property define the text for the flash message.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.shouldshowpreselectedvaluecolumn-propertygrideditor:
shouldShowPreselectedValueColumn
--------------------------------
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
.. :aspect:`Related options`
@ToDo
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
:aspect:`Description`
If set to 'false' the column which is used to mark a row as preselected will be disabled.
@@ -0,0 +1,52 @@
.. include:: ../../../../../Includes.txt
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor:
=====================
[RemoveElementEditor]
=====================
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor-introduction:
Introduction
============
This editor show a button which allows you to remove the form element or the collection element (finishers/ validators).
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor-properties:
Properties
==========
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.templatename-removeelementeditor:
templateName
------------
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Related options`
- :ref:`TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formEditor.formEditorPartials <typo3.cms.form.prototypes.\<prototypeidentifier>.formeditor.formeditorpartials>`
:aspect:`value`
Inspector-RemoveElementEditor
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
:aspect:`Description`
.. include:: properties/TemplateName.rst
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.identifier-removeelementeditor:
.. include:: properties/Identifier.rst
@@ -0,0 +1,127 @@
.. include:: ../../../../../Includes.txt
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.requiredvalidatoreditor:
=========================
[RequiredValidatorEditor]
=========================
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.requiredvalidatoreditor-introduction:
Introduction
============
Shows a checkbox. If set, a validator ('NotEmpty' by default) will be written into the ``form definition``. In addition another property could be written into the ``form definition``.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.requiredvalidatoreditor-properties:
Properties
==========
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.templatename-requiredvalidatoreditor:
templateName
------------
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Related options`
- :ref:`TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formEditor.formEditorPartials <typo3.cms.form.prototypes.\<prototypeidentifier>.formeditor.formeditorpartials>`
:aspect:`value`
Inspector-RequiredValidatorEditor
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
:aspect:`Description`
.. include:: properties/TemplateName.rst
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.identifier-requiredvalidatoreditor:
.. include:: properties/Identifier.rst
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.label-requiredvalidatoreditor:
.. include:: properties/Label.rst
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.validatoridentifier-requiredvalidatoreditor:
validatorIdentifier
-------------------
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
.. :aspect:`Related options`
@ToDo
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
:aspect:`Description`
The ``<validatorIdentifier>`` which should be used.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.propertypath-requiredvalidatoreditor:
propertyPath
------------
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
No
.. :aspect:`Related options`
@ToDo
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
:aspect:`Description`
An property path which should be written into the `form definition`` if the checkbox is set.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.propertyvalue-requiredvalidatoreditor:
propertyValue
-------------
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
No
.. :aspect:`Related options`
@ToDo
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
:aspect:`Description`
The value for the property path which should be written into the `form definition`` if the checkbox is set.
@@ -0,0 +1,110 @@
.. include:: ../../../../../Includes.txt
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.singleselecteditor:
====================
[SingleSelectEditor]
====================
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.singleselecteditor-introduction:
Introduction
============
Shows a single select list with values. If a selectoption is selected, then the option value will be written within a form element property which is defined by the "propertyPath" option.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.singleselecteditor-properties:
Properties
==========
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.templatename-singleselecteditor:
templateName
------------
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Related options`
- :ref:`TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formEditor.formEditorPartials <typo3.cms.form.prototypes.\<prototypeidentifier>.formeditor.formeditorpartials>`
:aspect:`value`
Inspector-SingleSelectEditor
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
:aspect:`Description`
.. include:: properties/TemplateName.rst
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.identifier-singleselecteditor:
.. include:: properties/Identifier.rst
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.label-singleselecteditor:
.. include:: properties/Label.rst
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.propertypath-singleselecteditor:
.. include:: properties/PropertyPath.rst
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.selectoptions.*.value-singleselecteditor:
selectOptions.[*].value
-----------------------
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
.. :aspect:`Related options`
@ToDo
.. :aspect:`Good to know`
ToDo
:aspect:`Description`
The value which should be written into the corresponding form elements property.
The corresponding form elements property is identified by the ``propertyPath`` option.
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.selectoptions.*.label-singleselecteditor:
selectOptions.[*].label
-----------------------
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
.. :aspect:`Related options`
@ToDo
.. :aspect:`Good to know`
ToDo
:aspect:`Description`
The label which is shown within the select field.
@@ -0,0 +1,205 @@
.. include:: ../../../../../Includes.txt
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.texteditor:
============
[TextEditor]
============
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.texteditor-introduction:
Introduction
============
Shows a single line textfield.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.texteditor-properties:
Properties
==========
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.templatename-texteditor:
templateName
------------
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Related options`
- :ref:`TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formEditor.formEditorPartials <typo3.cms.form.prototypes.\<prototypeidentifier>.formeditor.formeditorpartials>`
:aspect:`value`
Inspector-TextEditor
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
:aspect:`Description`
.. include:: properties/TemplateName.rst
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.identifier-texteditor:
.. include:: properties/Identifier.rst
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.label-texteditor:
.. include:: properties/Label.rst
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.propertypath-texteditor:
.. include:: properties/PropertyPath.rst
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.donotsetifpropertyvalueisempty-texteditor:
doNotSetIfPropertyValueIsEmpty
------------------------------
:aspect:`Data type`
bool
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
No
.. :aspect:`Related options`
@ToDo
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
:aspect:`Description`
If set to true then the property which should be written through this ``inspector editor`` will be removed within the ``form definition`` if the
value from the ``inspector editor`` is empty instead of writing an empty value ('') for this property.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.propertyvalidators-texteditor:
propertyValidators
------------------
:aspect:`Data type`
array
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
No
:aspect:`Related options`
- :ref:`"formElementPropertyValidatorsDefinition"<typo3.cms.form.prototypes.\<prototypeidentifier>.formeditor.formelementpropertyvalidatorsdefinition>`
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
:aspect:`Description`
This ``inspector editors`` is able to validate it's value through JavaScript methods.
This JavaScript validators can be registered through ``getFormEditorApp().addPropertyValidationValidator()``.
The first method argument is the identifier for such a validator.
Every array value within ``propertyValidators`` must be equal to such a identifier.
For example:
.. code-block:: yaml
propertyValidators:
10: 'Integer'
20: 'FormElementIdentifierWithinCurlyBracesExclusive'
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.propertyvalidatorsmode-texteditor:
propertyValidatorsMode
----------------------
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
No
.. :aspect:`Related options`
@ToDo
:aspect:`Default value`
AND
:aspect:`possible values`
OR/ AND
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
:aspect:`Description`
If set to 'OR' then at least one validator must be valid to accept the ``inspector editor`` value. If set to 'AND' then all validators must be valid.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.fieldexplanationtext-texteditor:
fieldExplanationText
--------------------
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
No
.. :aspect:`Related options`
@ToDo
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
- :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>`
:aspect:`Description`
A text which is shown at the bottom of the ``inspector editor``.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.additionalelementpropertypaths-texteditor:
additionalElementPropertyPaths
------------------------------
:aspect:`Data type`
array
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
No
.. :aspect:`Related options`
@ToDo
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
:aspect:`Description`
An array which holds property paths which should be written in addition to the propertyPath option.
For example:
.. code-block:: yaml
additionalElementPropertyPaths:
10: 'properties.fluidAdditionalAttributes.maxlength'
@@ -0,0 +1,59 @@
.. include:: ../../../../../Includes.txt
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.textareaeditor:
================
[TextareaEditor]
================
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.textareaeditor-introduction:
Introduction
============
Shows a textarea.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.textareaeditor-properties:
Properties
==========
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.templatename-textareaeditor:
templateName
------------
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Related options`
- :ref:`TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formEditor.formEditorPartials <typo3.cms.form.prototypes.\<prototypeidentifier>.formeditor.formeditorpartials>`
:aspect:`value`
Inspector-TextareaEditor
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
:aspect:`Description`
.. include:: properties/TemplateName.rst
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.identifier-textareaeditor:
.. include:: properties/Identifier.rst
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.label-textareaeditor:
.. include:: properties/Label.rst
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.propertypath-textareaeditor:
.. include:: properties/PropertyPath.rst
@@ -0,0 +1,199 @@
.. include:: ../../../../../Includes.txt
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.typo3winbrowsereditor:
=======================
[Typo3WinBrowserEditor]
=======================
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.typo3winbrowsereditor-introduction:
Introduction
============
Shows a popup window to select a record (e.g. pages or tt_content records) as you know it from within the form engine.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.typo3winbrowsereditor-properties:
Properties
==========
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.templatename-typo3winbrowsereditor:
templateName
------------
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Related options`
- :ref:`TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formEditor.formEditorPartials <typo3.cms.form.prototypes.\<prototypeidentifier>.formeditor.formeditorpartials>`
:aspect:`value`
Inspector-Typo3WinBrowserEditor
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
:aspect:`Description`
.. include:: properties/TemplateName.rst
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.identifier-typo3winbrowsereditor:
.. include:: properties/Identifier.rst
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.label-typo3winbrowsereditor:
.. include:: properties/Label.rst
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.propertypath-typo3winbrowsereditor:
.. include:: properties/PropertyPath.rst
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.buttonlabel-typo3winbrowsereditor:
buttonLabel
-----------
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
.. :aspect:`Related options`
@ToDo
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
- :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>`
:aspect:`Description`
The label for the button which opens the popup window.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.browsabletype-typo3winbrowsereditor:
browsableType
-------------
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
.. :aspect:`Related options`
@ToDo
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
:aspect:`Description`
The allowed selectable record types e.g 'pages' or 'tt_content'.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.propertyvalidators-typo3winbrowsereditor:
propertyValidators
------------------
:aspect:`Data type`
array
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
No
:aspect:`Related options`
- :ref:`"formElementPropertyValidatorsDefinition"<typo3.cms.form.prototypes.\<prototypeidentifier>.formeditor.formelementpropertyvalidatorsdefinition>`
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
:aspect:`Description`
This ``inspector editors`` is able to validate it's value through JavaScript methods.
This JavaScript validators can be registered through ``getFormEditorApp().addPropertyValidationValidator()``.
The first method argument is the identifier for such a validator.
Every array value within ``propertyValidators`` must be equal to such a identifier.
For example:
.. code-block:: yaml
propertyValidators:
10: 'Integer'
20: 'FormElementIdentifierWithinCurlyBracesExclusive'
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.propertyvalidatorsmode-typo3winbrowsereditor:
propertyValidatorsMode
----------------------
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
No
.. :aspect:`Related options`
@ToDo
:aspect:`Default value`
AND
:aspect:`possible values`
OR/ AND
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
:aspect:`Description`
If set to 'OR' then at least one validator must be valid to accept the ``inspector editor`` value. If set to 'AND' then all validators must be valid.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.fieldexplanationtext-typo3winbrowsereditor:
fieldExplanationText
--------------------
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
No
.. :aspect:`Related options`
@ToDo
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
- :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>`
:aspect:`Description`
A text which is shown at the bottom of the ``inspector editor``.
@@ -0,0 +1,84 @@
.. include:: ../../../../../../Includes.txt
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.validationerrormessageeditor:
==============================
[ValidationErrorMessageEditor]
==============================
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.validationerrormessageeditor-introduction:
Introduction
============
Shows a textarea. It allows the definition of custom validation error messages. Within the form editor, one can set
those error messages for all existing validators.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.validationerrormessageeditor-properties:
Properties
==========
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.templatename-validationerrormessageeditor:
templateName
------------
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Related options`
- :ref:`TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formEditor.formEditorPartials <typo3.cms.form.prototypes.\<prototypeidentifier>.formeditor.formeditorpartials>`
:aspect:`value`
Inspector-ValidationErrorMessageEditor
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
:aspect:`Description`
.. include:: properties/TemplateName.rst
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.identifier-validationerrormessageeditor:
.. include:: properties/Identifier.rst
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.label-validationerrormessageeditor:
.. include:: properties/Label.rst
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.propertypath-validationerrormessageeditor:
.. include:: properties/PropertyPath.rst
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.fieldexplanationtext-validationerrormessageeditor:
fieldExplanationText
--------------------
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
No
.. :aspect:`Related options`
@ToDo
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
- :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>`
:aspect:`Description`
A text which is shown at the bottom of the ``inspector editor``.
@@ -0,0 +1,104 @@
.. include:: ../../../../../Includes.txt
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.validatorseditor:
==================
[ValidatorsEditor]
==================
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.validatorseditor-introduction:
Introduction
============
Shows a select list with validators. If a validator is already added to the form element, then this validator will be removed from the select list.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.validatorseditor-properties:
Properties
==========
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.templatename-validatorseditor:
templateName
------------
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Related options`
- :ref:`TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formEditor.formEditorPartials <typo3.cms.form.prototypes.\<prototypeidentifier>.formeditor.formeditorpartials>`
:aspect:`value`
Inspector-FinishersEditor
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
:aspect:`Description`
.. include:: properties/TemplateName.rst
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.identifier-validatorseditor:
.. include:: properties/Identifier.rst
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.label-validatorseditor:
.. include:: properties/Label.rst
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.selectoptions.*.value-validatorseditor:
selectOptions.[*].value
-----------------------
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Related options`
- :ref:`"[validatorsDefinition]"<typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.*>`
.. :aspect:`Good to know`
ToDo
:aspect:`Description`
Has to match with a ``TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.validatorsDefinition`` configuration key.
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.selectoptions.*.label-validatorseditor:
selectOptions.[*].label
-----------------------
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
.. :aspect:`Related options`
@ToDo
.. :aspect:`Good to know`
ToDo
:aspect:`Description`
The label which is shown within the select field.
@@ -0,0 +1,24 @@
identifier
----------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.editors.*.identifier
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Default value`
Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`)
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
:aspect:`Description`
Identifies the current ``inspector editor`` within the current form element.
The identifier is a text of your choice but must be unique within the optionpath ``TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.editors``.
@@ -0,0 +1,24 @@
label
-----
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.editors.*.label
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Default value`
Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`)
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
- :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>`
:aspect:`Description`
The label for this ``inspector editor`` which is shown within the ``inspector component``.
@@ -0,0 +1,25 @@
propertyPath
------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.formEditor.editors.*.propertyPath
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Default value`
Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`)
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
- :ref:`"JavaScript FormElement model"<apireference-formeditor-basicjavascriptconcepts-formelementmodel>`
:aspect:`Description`
The path to the property of the form element which should be written by this ``inspector editor``.
@@ -0,0 +1,2 @@
The inline HTML template which is used for this inspector editor.
Must be equal to an existing array key within ``TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formEditor.formEditorPartials`` and must be started with 'Inspector-' by convention.
@@ -0,0 +1,190 @@
.. include:: ../../../../Includes.txt
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.advancedpassword:
==================
[AdvancedPassword]
==================
.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.advancedpassword-properties:
Properties
==========
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.implementationclassname:
.. include:: AdvancedPassword/implementationClassName.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.properties.containerclassattribute:
.. include:: AdvancedPassword/properties/containerClassAttribute.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.properties.elementclassattribute:
.. include:: AdvancedPassword/properties/elementClassAttribute.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.properties.elementDescription:
.. include:: AdvancedPassword/properties/elementDescription.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.properties.elementerrorclassattribute:
.. include:: AdvancedPassword/properties/elementErrorClassAttribute.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.properties.confirmationlabel:
.. include:: AdvancedPassword/properties/confirmationLabel.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.properties.confirmationclassattribute:
.. include:: AdvancedPassword/properties/confirmationClassAttribute.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor:
.. include:: AdvancedPassword/formEditor.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.editors.100:
.. include:: AdvancedPassword/formEditor/editors/100.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.editors.200:
.. include:: AdvancedPassword/formEditor/editors/200.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.editors.230:
.. include:: AdvancedPassword/formEditor/editors/230.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.editors.300:
.. include:: AdvancedPassword/formEditor/editors/300.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.editors.400:
.. include:: AdvancedPassword/formEditor/editors/400.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.editors.700:
.. include:: AdvancedPassword/formEditor/editors/700.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.editors.800:
.. include:: AdvancedPassword/formEditor/editors/800.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.editors.900:
.. include:: AdvancedPassword/formEditor/editors/900.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.editors.9999:
.. include:: AdvancedPassword/formEditor/editors/9999.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.predefineddefaults:
.. include:: AdvancedPassword/formEditor/predefinedDefaults.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.10:
.. include:: AdvancedPassword/formEditor/propertyCollections/validators/10.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.10.identifier:
.. include:: AdvancedPassword/formEditor/propertyCollections/validators/10/identifier.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.10.editors.100:
.. include:: AdvancedPassword/formEditor/propertyCollections/validators/10/editors/100.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.10.editors.9999:
.. include:: AdvancedPassword/formEditor/propertyCollections/validators/10/editors/9999.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.20:
.. include:: AdvancedPassword/formEditor/propertyCollections/validators/20.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.20.identifier:
.. include:: AdvancedPassword/formEditor/propertyCollections/validators/20/identifier.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.20.editors.100:
.. include:: AdvancedPassword/formEditor/propertyCollections/validators/20/editors/100.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.20.editors.9999:
.. include:: AdvancedPassword/formEditor/propertyCollections/validators/20/editors/9999.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.30:
.. include:: AdvancedPassword/formEditor/propertyCollections/validators/30.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.30.identifier:
.. include:: AdvancedPassword/formEditor/propertyCollections/validators/30/identifier.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.30.editors.100:
.. include:: AdvancedPassword/formEditor/propertyCollections/validators/30/editors/100.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.30.editors.200:
.. include:: AdvancedPassword/formEditor/propertyCollections/validators/30/editors/200.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.30.editors.300:
.. include:: AdvancedPassword/formEditor/propertyCollections/validators/30/editors/300.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.30.editors.9999:
.. include:: AdvancedPassword/formEditor/propertyCollections/validators/30/editors/9999.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.40:
.. include:: AdvancedPassword/formEditor/propertyCollections/validators/40.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.40.identifier:
.. include:: AdvancedPassword/formEditor/propertyCollections/validators/40/identifier.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.40.editors.100:
.. include:: AdvancedPassword/formEditor/propertyCollections/validators/40/editors/100.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.40.editors.9999:
.. include:: AdvancedPassword/formEditor/propertyCollections/validators/40/editors/9999.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.50:
.. include:: AdvancedPassword/formEditor/propertyCollections/validators/50.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.50.identifier:
.. include:: AdvancedPassword/formEditor/propertyCollections/validators/50/identifier.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.50.editors.100:
.. include:: AdvancedPassword/formEditor/propertyCollections/validators/50/editors/100.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.50.editors.9999:
.. include:: AdvancedPassword/formEditor/propertyCollections/validators/50/editors/9999.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.60:
.. include:: AdvancedPassword/formEditor/propertyCollections/validators/60.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.60.identifier:
.. include:: AdvancedPassword/formEditor/propertyCollections/validators/60/identifier.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.60.editors.100:
.. include:: AdvancedPassword/formEditor/propertyCollections/validators/60/editors/100.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.60.editors.9999:
.. include:: AdvancedPassword/formEditor/propertyCollections/validators/60/editors/9999.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.70:
.. include:: AdvancedPassword/formEditor/propertyCollections/validators/70.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.70.identifier:
.. include:: AdvancedPassword/formEditor/propertyCollections/validators/70/identifier.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.70.editors.100:
.. include:: AdvancedPassword/formEditor/propertyCollections/validators/70/editors/100.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.70.editors.200:
.. include:: AdvancedPassword/formEditor/propertyCollections/validators/70/editors/200.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.70.editors.300:
.. include:: AdvancedPassword/formEditor/propertyCollections/validators/70/editors/300.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.70.editors.9999:
.. include:: AdvancedPassword/formEditor/propertyCollections/validators/70/editors/9999.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.80:
.. include:: AdvancedPassword/formEditor/propertyCollections/validators/80.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.80.identifier:
.. include:: AdvancedPassword/formEditor/propertyCollections/validators/80/identifier.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.80.editors.100:
.. include:: AdvancedPassword/formEditor/propertyCollections/validators/80/editors/100.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.80.editors.200:
.. include:: AdvancedPassword/formEditor/propertyCollections/validators/80/editors/200.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.propertycollections.validators.80.editors.9999:
.. include:: AdvancedPassword/formEditor/propertyCollections/validators/80/editors/9999.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.label:
.. include:: AdvancedPassword/formEditor/label.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.group:
.. include:: AdvancedPassword/formEditor/group.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.groupsorting:
.. include:: AdvancedPassword/formEditor/groupSorting.rst
.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.iconidentifier:
.. include:: AdvancedPassword/formEditor/iconIdentifier.rst
@@ -0,0 +1,245 @@
formEditor
----------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor
:aspect:`Data type`
array
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Recommended
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 2-
AdvancedPassword:
formEditor:
editors:
100:
identifier: header
templateName: Inspector-FormElementHeaderEditor
200:
identifier: label
templateName: Inspector-TextEditor
label: formEditor.elements.FormElement.editor.label.label
propertyPath: label
230:
identifier: elementDescription
templateName: Inspector-TextEditor
label: formEditor.elements.FormElement.editor.elementDescription.label
propertyPath: properties.elementDescription
300:
identifier: confirmationLabel
templateName: Inspector-TextEditor
label: formEditor.elements.AdvancedPassword.editor.confirmationLabel.label
propertyPath: properties.confirmationLabel
400:
identifier: placeholder
templateName: Inspector-TextEditor
label: formEditor.elements.TextMixin.editor.placeholder.label
propertyPath: properties.fluidAdditionalAttributes.placeholder
compatibilityPropertyPath: properties.placeholder
doNotSetIfPropertyValueIsEmpty: true
700:
identifier: gridColumnViewPortConfiguration
templateName: Inspector-GridColumnViewPortConfigurationEditor
label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label
configurationOptions:
viewPorts:
10:
viewPortIdentifier: xs
label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label
20:
viewPortIdentifier: sm
label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label
30:
viewPortIdentifier: md
label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label
40:
viewPortIdentifier: lg
label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label
numbersOfColumnsToUse:
label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label
propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse'
fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText
800:
identifier: requiredValidator
templateName: Inspector-RequiredValidatorEditor
label: formEditor.elements.FormElement.editor.requiredValidator.label
validatorIdentifier: NotEmpty
propertyPath: properties.fluidAdditionalAttributes.required
propertyValue: required
900:
identifier: validators
templateName: Inspector-ValidatorsEditor
label: formEditor.elements.TextMixin.editor.validators.label
selectOptions:
10:
value: ''
label: formEditor.elements.TextMixin.editor.validators.EmptyValue.label
20:
value: Alphanumeric
label: formEditor.elements.TextMixin.editor.validators.Alphanumeric.label
30:
value: Text
label: formEditor.elements.TextMixin.editor.validators.Text.label
40:
value: StringLength
label: formEditor.elements.TextMixin.editor.validators.StringLength.label
50:
value: EmailAddress
label: formEditor.elements.TextMixin.editor.validators.EmailAddress.label
60:
value: Integer
label: formEditor.elements.TextMixin.editor.validators.Integer.label
70:
value: Float
label: formEditor.elements.TextMixin.editor.validators.Float.label
80:
value: NumberRange
label: formEditor.elements.TextMixin.editor.validators.NumberRange.label
90:
value: RegularExpression
label: formEditor.elements.TextMixin.editor.validators.RegularExpression.label
9999:
identifier: removeButton
templateName: Inspector-RemoveElementEditor
predefinedDefaults:
properties:
confirmationLabel: formEditor.element.AdvancedPassword.editor.confirmationLabel.predefinedDefaults
propertyCollections:
validators:
10:
identifier: Alphanumeric
editors:
100:
identifier: header
templateName: Inspector-CollectionElementHeaderEditor
label: formEditor.elements.TextMixin.validators.Alphanumeric.editor.header.label
9999:
identifier: removeButton
templateName: Inspector-RemoveElementEditor
20:
identifier: Text
editors:
100:
identifier: header
templateName: Inspector-CollectionElementHeaderEditor
label: formEditor.elements.TextMixin.validators.Text.editor.header.label
9999:
identifier: removeButton
templateName: Inspector-RemoveElementEditor
30:
identifier: StringLength
editors:
100:
identifier: header
templateName: Inspector-CollectionElementHeaderEditor
label: formEditor.elements.TextMixin.validators.StringLength.editor.header.label
200:
identifier: minimum
templateName: Inspector-TextEditor
label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label
propertyPath: options.minimum
propertyValidators:
10: Integer
additionalElementPropertyPaths:
10: properties.fluidAdditionalAttributes.minlength
300:
identifier: maximum
templateName: Inspector-TextEditor
label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label
propertyPath: options.maximum
propertyValidators:
10: Integer
additionalElementPropertyPaths:
10: properties.fluidAdditionalAttributes.maxlength
9999:
identifier: removeButton
templateName: Inspector-RemoveElementEditor
40:
identifier: EmailAddress
editors:
100:
identifier: header
templateName: Inspector-CollectionElementHeaderEditor
label: formEditor.elements.TextMixin.validators.EmailAddress.editor.header.label
9999:
identifier: removeButton
templateName: Inspector-RemoveElementEditor
50:
identifier: Integer
editors:
100:
identifier: header
templateName: Inspector-CollectionElementHeaderEditor
label: formEditor.elements.TextMixin.validators.Integer.editor.header.label
9999:
identifier: removeButton
templateName: Inspector-RemoveElementEditor
60:
identifier: Float
editors:
100:
identifier: header
templateName: Inspector-CollectionElementHeaderEditor
label: formEditor.elements.TextMixin.validators.Float.editor.header.label
9999:
identifier: removeButton
templateName: Inspector-RemoveElementEditor
70:
identifier: NumberRange
editors:
100:
identifier: header
templateName: Inspector-CollectionElementHeaderEditor
label: formEditor.elements.TextMixin.validators.NumberRange.editor.header.label
200:
identifier: minimum
templateName: Inspector-TextEditor
label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label
propertyPath: options.minimum
propertyValidators:
10: Integer
additionalElementPropertyPaths:
10: properties.fluidAdditionalAttributes.min
300:
identifier: maximum
templateName: Inspector-TextEditor
label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label
propertyPath: options.maximum
propertyValidators:
10: Integer
additionalElementPropertyPaths:
10: properties.fluidAdditionalAttributes.max
9999:
identifier: removeButton
templateName: Inspector-RemoveElementEditor
80:
identifier: RegularExpression
editors:
100:
identifier: header
templateName: Inspector-CollectionElementHeaderEditor
label: formEditor.elements.TextMixin.validators.RegularExpression.editor.header.label
200:
identifier: regex
templateName: Inspector-TextEditor
label: formEditor.elements.TextMixin.validators.RegularExpression.editor.regex.label
fieldExplanationText: formEditor.elements.TextMixin.validators.RegularExpression.editor.regex.fieldExplanationText
propertyPath: options.regularExpression
propertyValidators:
10: NotEmpty
9999:
identifier: removeButton
templateName: Inspector-RemoveElementEditor
label: formEditor.elements.AdvancedPassword.label
group: custom
groupSorting: 500
iconIdentifier: t3-form-icon-advanced-password
@@ -0,0 +1,29 @@
formEditor.editors.100
----------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.editors.100
:aspect:`Data type`
array/ :ref:`[FormElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>`
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Recommended
.. :aspect:`Related options`
@ToDo
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 4-
AdvancedPassword:
formEditor:
editors:
100:
identifier: header
templateName: Inspector-FormElementHeaderEditor
@@ -0,0 +1,31 @@
formEditor.editors.200
----------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.editors.200
:aspect:`Data type`
array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>`
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Recommended
.. :aspect:`Related options`
@ToDo
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 4-
AdvancedPassword:
formEditor:
editors:
200:
identifier: label
templateName: Inspector-TextEditor
label: formEditor.elements.FormElement.editor.label.label
propertyPath: label
@@ -0,0 +1,28 @@
formEditor.editors.230
----------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.editors.230
:aspect:`Data type`
array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>`
:aspect:`Needed by`
Frontend/ Backend (form editor)
:aspect:`Mandatory`
No
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 4-
Date:
formEditor:
editors:
230:
identifier: elementDescription
templateName: Inspector-TextEditor
label: formEditor.elements.FormElement.editor.elementDescription.label
propertyPath: properties.elementDescription
@@ -0,0 +1,31 @@
formEditor.editors.300
----------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.editors.300
:aspect:`Data type`
array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>`
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Recommended
.. :aspect:`Related options`
@ToDo
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 4-
AdvancedPassword:
formEditor:
editors:
300:
identifier: confirmationLabel
templateName: Inspector-TextEditor
label: formEditor.elements.AdvancedPassword.editor.confirmationLabel.label
propertyPath: properties.confirmationLabel
@@ -0,0 +1,33 @@
formEditor.editors.400
----------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.editors.400
:aspect:`Data type`
array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>`
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Recommended
.. :aspect:`Related options`
@ToDo
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 4-
AdvancedPassword:
formEditor:
editors:
400:
identifier: placeholder
templateName: Inspector-TextEditor
label: formEditor.elements.TextMixin.editor.placeholder.label
propertyPath: properties.fluidAdditionalAttributes.placeholder
compatibilityPropertyPath: properties.placeholder
doNotSetIfPropertyValueIsEmpty: true
@@ -0,0 +1,48 @@
formEditor.editors.700
----------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.editors.700
:aspect:`Data type`
array/ :ref:`[GridColumnViewPortConfigurationEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.gridcolumnviewportconfigurationeditor>`
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Recommended
.. :aspect:`Related options`
@ToDo
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 4-
AdvancedPassword:
formEditor:
editors:
700:
identifier: gridColumnViewPortConfiguration
templateName: Inspector-GridColumnViewPortConfigurationEditor
label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label
configurationOptions:
viewPorts:
10:
viewPortIdentifier: xs
label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label
20:
viewPortIdentifier: sm
label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label
30:
viewPortIdentifier: md
label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label
40:
viewPortIdentifier: lg
label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label
numbersOfColumnsToUse:
label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label
propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse'
fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText
@@ -0,0 +1,33 @@
formEditor.editors.800
----------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.editors.800
:aspect:`Data type`
array/ :ref:`[RequiredValidatorEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.requiredvalidatoreditor>`
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Recommended
.. :aspect:`Related options`
@ToDo
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 4-
AdvancedPassword:
formEditor:
editors:
800:
identifier: requiredValidator
templateName: Inspector-RequiredValidatorEditor
label: formEditor.elements.FormElement.editor.requiredValidator.label
validatorIdentifier: NotEmpty
propertyPath: properties.fluidAdditionalAttributes.required
propertyValue: required
@@ -0,0 +1,58 @@
formEditor.editors.900
----------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.editors.900
:aspect:`Data type`
array/ :ref:`[ValidatorsEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.validatorseditor>`
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Recommended
.. :aspect:`Related options`
@ToDo
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 4-
AdvancedPassword:
formEditor:
editors:
900:
identifier: validators
templateName: Inspector-ValidatorsEditor
label: formEditor.elements.TextMixin.editor.validators.label
selectOptions:
10:
value: ''
label: formEditor.elements.TextMixin.editor.validators.EmptyValue.label
20:
value: Alphanumeric
label: formEditor.elements.TextMixin.editor.validators.Alphanumeric.label
30:
value: Text
label: formEditor.elements.TextMixin.editor.validators.Text.label
40:
value: StringLength
label: formEditor.elements.TextMixin.editor.validators.StringLength.label
50:
value: EmailAddress
label: formEditor.elements.TextMixin.editor.validators.EmailAddress.label
60:
value: Integer
label: formEditor.elements.TextMixin.editor.validators.Integer.label
70:
value: Float
label: formEditor.elements.TextMixin.editor.validators.Float.label
80:
value: NumberRange
label: formEditor.elements.TextMixin.editor.validators.NumberRange.label
90:
value: RegularExpression
label: formEditor.elements.TextMixin.editor.validators.RegularExpression.label
@@ -0,0 +1,29 @@
formEditor.editors.9999
-----------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.editors.9999
:aspect:`Data type`
array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>`
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Recommended
.. :aspect:`Related options`
@ToDo
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 4-
AdvancedPassword:
formEditor:
editors:
9999:
identifier: removeButton
templateName: Inspector-RemoveElementEditor
@@ -0,0 +1,30 @@
formEditor.group
----------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.group
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Recommended
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 3
AdvancedPassword:
formEditor:
group: custom
:aspect:`Default value`
Depends (see :ref:`concrete element configuration <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>-concreteconfigurations>`)
:aspect:`Description`
Define within which group within the ``form editor`` "new Element" modal the form element should be shown.
The ``group`` value must be equal to an array key within ``formElementGroups``.
@@ -0,0 +1,29 @@
formEditor.groupSorting
-----------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.groupSorting
:aspect:`Data type`
int
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Recommended
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 3-
AdvancedPassword:
formEditor:
groupSorting: 500
.. :aspect:`Good to know`
ToDo
:aspect:`Description`
The position within the ``formEditor.group`` for this form element.
@@ -0,0 +1,35 @@
formEditor.iconIdentifier
-------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.iconIdentifier
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Recommended
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 3-
AdvancedPassword:
formEditor:
iconIdentifier: t3-form-icon-advanced-password
.. :aspect:`Good to know`
ToDo
:aspect:`Description`
An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``.
This icon will be shown within
- :ref:`"Inspector [FormElementHeaderEditor]"<typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>`.
- :ref:`"Abstract view formelement templates"<apireference-formeditor-stage-commonabstractformelementtemplates>`.
- ``Tree`` component.
- "new element" Modal
@@ -0,0 +1,29 @@
formEditor.label
----------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.label
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 3-
AdvancedPassword:
formEditor:
label: formEditor.elements.AdvancedPassword.label
:aspect:`Good to know`
- :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>`
:aspect:`Description`
This label will be shown within the "new element" Modal.
@@ -0,0 +1,31 @@
formEditor.predefinedDefaults
-----------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.predefinedDefaults
:aspect:`Data type`
array
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Recommended
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 3-
AdvancedPassword:
formEditor:
predefinedDefaults:
properties:
confirmationLabel: formEditor.element.AdvancedPassword.editor.confirmationLabel.predefinedDefaults
.. :aspect:`Good to know`
ToDo
:aspect:`Description`
Defines predefined defaults for form element properties which are prefilled, if the form element is added to a form.
@@ -0,0 +1,34 @@
formEditor.propertyCollections.validators.10
--------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.10
:aspect:`Data type`
array
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
No
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 5-
AdvancedPassword:
formEditor:
propertyCollections:
validators:
10:
identifier: Alphanumeric
editors:
100:
identifier: header
templateName: Inspector-CollectionElementHeaderEditor
label: formEditor.elements.TextMixin.validators.Alphanumeric.editor.header.label
9999:
identifier: removeButton
templateName: Inspector-RemoveElementEditor
@@ -0,0 +1,31 @@
formEditor.propertyCollections.validators.10.editors.100
--------------------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.10.editors.100
:aspect:`Data type`
array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>`
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Recommended
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 8-
AdvancedPassword:
formEditor:
propertyCollections:
validators:
10:
identifier: Alphanumeric
editors:
100:
identifier: header
templateName: Inspector-CollectionElementHeaderEditor
label: formEditor.elements.TextMixin.validators.Alphanumeric.editor.header.label
@@ -0,0 +1,30 @@
formEditor.propertyCollections.validators.10.editors.9999
---------------------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.10.editors.9999
:aspect:`Data type`
array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>`
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Recommended
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 8-
AdvancedPassword:
formEditor:
propertyCollections:
validators:
10:
identifier: Alphanumeric
editors:
9999:
identifier: removeButton
templateName: Inspector-RemoveElementEditor
@@ -0,0 +1,33 @@
formEditor.propertyCollections.validators.10.identifier
-------------------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.10.identifier
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 6
AdvancedPassword:
formEditor:
propertyCollections:
validators:
10:
identifier: Alphanumeric
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
- :ref:`"\<validatorIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>>`
:aspect:`Description`
Identifies the validator which should be attached to the form element. Must be equal to a existing ``<validatorIdentifier>``.
@@ -0,0 +1,34 @@
formEditor.propertyCollections.validators.20
--------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.20
:aspect:`Data type`
array
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
No
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 5-
AdvancedPassword:
formEditor:
propertyCollections:
validators:
20:
identifier: Text
editors:
100:
identifier: header
templateName: Inspector-CollectionElementHeaderEditor
label: formEditor.elements.TextMixin.validators.Text.editor.header.label
9999:
identifier: removeButton
templateName: Inspector-RemoveElementEditor
@@ -0,0 +1,31 @@
formEditor.propertyCollections.validators.20.editors.100
--------------------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.20.editors.100
:aspect:`Data type`
array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>`
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Recommended
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 8-
AdvancedPassword:
formEditor:
propertyCollections:
validators:
20:
identifier: Text
editors:
100:
identifier: header
templateName: Inspector-CollectionElementHeaderEditor
label: formEditor.elements.TextMixin.validators.Text.editor.header.label
@@ -0,0 +1,30 @@
formEditor.propertyCollections.validators.20.editors.9999
---------------------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.20.editors.9999
:aspect:`Data type`
array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>`
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Recommended
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 8-
AdvancedPassword:
formEditor:
propertyCollections:
validators:
20:
identifier: Text
editors:
9999:
identifier: removeButton
templateName: Inspector-RemoveElementEditor
@@ -0,0 +1,33 @@
formEditor.propertyCollections.validators.20.identifier
-------------------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.20.identifier
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 6
AdvancedPassword:
formEditor:
propertyCollections:
validators:
20:
identifier: Text
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
- :ref:`"\<validatorIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>>`
:aspect:`Description`
Identifies the validator which should be attached to the form element. Must be equal to a existing ``<validatorIdentifier>``.
@@ -0,0 +1,52 @@
formEditor.propertyCollections.validators.30
--------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.30
:aspect:`Data type`
array
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
No
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 5-
AdvancedPassword:
formEditor:
propertyCollections:
validators:
30:
identifier: StringLength
editors:
100:
identifier: header
templateName: Inspector-CollectionElementHeaderEditor
label: formEditor.elements.TextMixin.validators.StringLength.editor.header.label
200:
identifier: minimum
templateName: Inspector-TextEditor
label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label
propertyPath: options.minimum
propertyValidators:
10: Integer
additionalElementPropertyPaths:
10: properties.fluidAdditionalAttributes.minlength
300:
identifier: maximum
templateName: Inspector-TextEditor
label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label
propertyPath: options.maximum
propertyValidators:
10: Integer
additionalElementPropertyPaths:
10: properties.fluidAdditionalAttributes.maxlength
9999:
identifier: removeButton
templateName: Inspector-RemoveElementEditor
@@ -0,0 +1,31 @@
formEditor.propertyCollections.validators.30.editors.100
--------------------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.30.editors.100
:aspect:`Data type`
array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>`
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Recommended
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 8-
AdvancedPassword:
formEditor:
propertyCollections:
validators:
30:
identifier: StringLength
editors:
100:
identifier: header
templateName: Inspector-CollectionElementHeaderEditor
label: formEditor.elements.TextMixin.validators.StringLength.editor.header.label
@@ -0,0 +1,36 @@
formEditor.propertyCollections.validators.30.editors.200
--------------------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.30.editors.200
:aspect:`Data type`
array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>`
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Recommended
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 8-
AdvancedPassword:
formEditor:
propertyCollections:
validators:
30:
identifier: StringLength
editors:
200:
identifier: minimum
templateName: Inspector-TextEditor
label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label
propertyPath: options.minimum
propertyValidators:
10: Integer
additionalElementPropertyPaths:
10: properties.fluidAdditionalAttributes.minlength
@@ -0,0 +1,36 @@
formEditor.propertyCollections.validators.30.editors.300
--------------------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.30.editors.300
:aspect:`Data type`
array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>`
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Recommended
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 8-
AdvancedPassword:
formEditor:
propertyCollections:
validators:
30:
identifier: StringLength
editors:
300:
identifier: maximum
templateName: Inspector-TextEditor
label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label
propertyPath: options.maximum
propertyValidators:
10: Integer
additionalElementPropertyPaths:
10: properties.fluidAdditionalAttributes.maxlength
@@ -0,0 +1,30 @@
formEditor.propertyCollections.validators.30.editors.9999
---------------------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.30.editors.9999
:aspect:`Data type`
array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>`
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Recommended
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 8-
AdvancedPassword:
formEditor:
propertyCollections:
validators:
30:
identifier: StringLength
editors:
9999:
identifier: removeButton
templateName: Inspector-RemoveElementEditor
@@ -0,0 +1,33 @@
formEditor.propertyCollections.validators.30.identifier
-------------------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.30.identifier
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 6
AdvancedPassword:
formEditor:
propertyCollections:
validators:
30:
identifier: StringLength
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
- :ref:`"\<validatorIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>>`
:aspect:`Description`
Identifies the validator which should be attached to the form element. Must be equal to a existing ``<validatorIdentifier>``.
@@ -0,0 +1,34 @@
formEditor.propertyCollections.validators.40
--------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.40
:aspect:`Data type`
array
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
No
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 5-
AdvancedPassword:
formEditor:
propertyCollections:
validators:
40:
identifier: EmailAddress
editors:
100:
identifier: header
templateName: Inspector-CollectionElementHeaderEditor
label: formEditor.elements.TextMixin.validators.EmailAddress.editor.header.label
9999:
identifier: removeButton
templateName: Inspector-RemoveElementEditor
@@ -0,0 +1,31 @@
formEditor.propertyCollections.validators.40.editors.100
--------------------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.40.editors.100
:aspect:`Data type`
array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>`
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Recommended
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 8-
AdvancedPassword:
formEditor:
propertyCollections:
validators:
40:
identifier: EmailAddress
editors:
100:
identifier: header
templateName: Inspector-CollectionElementHeaderEditor
label: formEditor.elements.TextMixin.validators.EmailAddress.editor.header.label
@@ -0,0 +1,30 @@
formEditor.propertyCollections.validators.40.editors.9999
---------------------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.40.editors.9999
:aspect:`Data type`
array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>`
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Recommended
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 8-
AdvancedPassword:
formEditor:
propertyCollections:
validators:
40:
identifier: EmailAddress
editors:
100:
identifier: removeButton
templateName: Inspector-RemoveElementEditor
@@ -0,0 +1,33 @@
formEditor.propertyCollections.validators.40.identifier
-------------------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.40.identifier
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 6
AdvancedPassword:
formEditor:
propertyCollections:
validators:
40:
identifier: EmailAddress
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
- :ref:`"\<validatorIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>>`
:aspect:`Description`
Identifies the validator which should be attached to the form element. Must be equal to a existing ``<validatorIdentifier>``.
@@ -0,0 +1,34 @@
formEditor.propertyCollections.validators.50
--------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.50
:aspect:`Data type`
array
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
No
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 5-
AdvancedPassword:
formEditor:
propertyCollections:
validators:
50:
identifier: Integer
editors:
100:
identifier: header
templateName: Inspector-CollectionElementHeaderEditor
label: formEditor.elements.TextMixin.validators.Integer.editor.header.label
9999:
identifier: removeButton
templateName: Inspector-RemoveElementEditor
@@ -0,0 +1,31 @@
formEditor.propertyCollections.validators.50.editors.100
--------------------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.50.editors.100
:aspect:`Data type`
array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>`
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Recommended
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 8-
AdvancedPassword:
formEditor:
propertyCollections:
validators:
50:
identifier: Integer
editors:
100:
identifier: header
templateName: Inspector-CollectionElementHeaderEditor
label: formEditor.elements.TextMixin.validators.Integer.editor.header.label
@@ -0,0 +1,30 @@
formEditor.propertyCollections.validators.50.editors.9999
---------------------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.50.editors.9999
:aspect:`Data type`
array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>`
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Recommended
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 8-
AdvancedPassword:
formEditor:
propertyCollections:
validators:
50:
identifier: Integer
editors:
9999:
identifier: removeButton
templateName: Inspector-RemoveElementEditor
@@ -0,0 +1,33 @@
formEditor.propertyCollections.validators.50.identifier
-------------------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.50.identifier
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 6
AdvancedPassword:
formEditor:
propertyCollections:
validators:
50:
identifier: Integer
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
- :ref:`"\<validatorIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>>`
:aspect:`Description`
Identifies the validator which should be attached to the form element. Must be equal to a existing ``<validatorIdentifier>``.
@@ -0,0 +1,34 @@
formEditor.propertyCollections.validators.60
--------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.60
:aspect:`Data type`
array
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
No
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 5-
AdvancedPassword:
formEditor:
propertyCollections:
validators:
60:
identifier: Float
editors:
100:
identifier: header
templateName: Inspector-CollectionElementHeaderEditor
label: formEditor.elements.TextMixin.validators.Float.editor.header.label
9999:
identifier: removeButton
templateName: Inspector-RemoveElementEditor
@@ -0,0 +1,31 @@
formEditor.propertyCollections.validators.60.editors.100
--------------------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.60.editors.100
:aspect:`Data type`
array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>`
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Recommended
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 8-
AdvancedPassword:
formEditor:
propertyCollections:
validators:
60:
identifier: Float
editors:
100:
identifier: header
templateName: Inspector-CollectionElementHeaderEditor
label: formEditor.elements.TextMixin.validators.Float.editor.header.label
@@ -0,0 +1,30 @@
formEditor.propertyCollections.validators.60.editors.9999
---------------------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.60.editors.9999
:aspect:`Data type`
array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>`
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Recommended
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 8-
AdvancedPassword:
formEditor:
propertyCollections:
validators:
60:
identifier: Float
editors:
100:
identifier: removeButton
templateName: Inspector-RemoveElementEditor
@@ -0,0 +1,33 @@
formEditor.propertyCollections.validators.60.identifier
-------------------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.60.identifier
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 6
AdvancedPassword:
formEditor:
propertyCollections:
validators:
60:
identifier: Float
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
- :ref:`"\<validatorIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>>`
:aspect:`Description`
Identifies the validator which should be attached to the form element. Must be equal to a existing ``<validatorIdentifier>``.
@@ -0,0 +1,52 @@
formEditor.propertyCollections.validators.70
--------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.70
:aspect:`Data type`
array
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
No
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 5-
AdvancedPassword:
formEditor:
propertyCollections:
validators:
70:
identifier: NumberRange
editors:
100:
identifier: header
templateName: Inspector-CollectionElementHeaderEditor
label: formEditor.elements.TextMixin.validators.NumberRange.editor.header.label
200:
identifier: minimum
templateName: Inspector-TextEditor
label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label
propertyPath: options.minimum
propertyValidators:
10: Integer
additionalElementPropertyPaths:
10: properties.fluidAdditionalAttributes.min
300:
identifier: maximum
templateName: Inspector-TextEditor
label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label
propertyPath: options.maximum
propertyValidators:
10: Integer
additionalElementPropertyPaths:
10: properties.fluidAdditionalAttributes.max
9999:
identifier: removeButton
templateName: Inspector-RemoveElementEditor
@@ -0,0 +1,31 @@
formEditor.propertyCollections.validators.70.editors.100
--------------------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.70.editors.100
:aspect:`Data type`
array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>`
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Recommended
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 8-
AdvancedPassword:
formEditor:
propertyCollections:
validators:
70:
identifier: NumberRange
editors:
100:
identifier: header
templateName: Inspector-CollectionElementHeaderEditor
label: formEditor.elements.TextMixin.validators.NumberRange.editor.header.label
@@ -0,0 +1,36 @@
formEditor.propertyCollections.validators.70.editors.200
--------------------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.70.editors.200
:aspect:`Data type`
array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>`
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Recommended
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 8-
AdvancedPassword:
formEditor:
propertyCollections:
validators:
70:
identifier: NumberRange
editors:
200:
identifier: minimum
templateName: Inspector-TextEditor
label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label
propertyPath: options.minimum
propertyValidators:
10: Integer
additionalElementPropertyPaths:
10: properties.fluidAdditionalAttributes.min
@@ -0,0 +1,36 @@
formEditor.propertyCollections.validators.70.editors.300
--------------------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.70.editors.300
:aspect:`Data type`
array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>`
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Recommended
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 8-
AdvancedPassword:
formEditor:
propertyCollections:
validators:
70:
identifier: NumberRange
editors:
300:
identifier: maximum
templateName: Inspector-TextEditor
label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label
propertyPath: options.maximum
propertyValidators:
10: Integer
additionalElementPropertyPaths:
10: properties.fluidAdditionalAttributes.max
@@ -0,0 +1,30 @@
formEditor.propertyCollections.validators.70.editors.9999
---------------------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.70.editors.9999
:aspect:`Data type`
array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>`
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Recommended
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 8-
AdvancedPassword:
formEditor:
propertyCollections:
validators:
70:
identifier: NumberRange
editors:
9999:
identifier: removeButton
templateName: Inspector-RemoveElementEditor
@@ -0,0 +1,33 @@
formEditor.propertyCollections.validators.70.identifier
-------------------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.70.identifier
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 6
AdvancedPassword:
formEditor:
propertyCollections:
validators:
70:
identifier: NumberRange
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
- :ref:`"\<validatorIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>>`
:aspect:`Description`
Identifies the validator which should be attached to the form element. Must be equal to a existing ``<validatorIdentifier>``.
@@ -0,0 +1,42 @@
formEditor.propertyCollections.validators.80
--------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.80
:aspect:`Data type`
array
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
No
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 5-
AdvancedPassword:
formEditor:
propertyCollections:
validators:
80:
identifier: RegularExpression
editors:
100:
identifier: header
templateName: Inspector-CollectionElementHeaderEditor
label: formEditor.elements.TextMixin.validators.RegularExpression.editor.header.label
200:
identifier: regex
templateName: Inspector-TextEditor
label: formEditor.elements.TextMixin.validators.RegularExpression.editor.regex.label
fieldExplanationText: formEditor.elements.TextMixin.validators.RegularExpression.editor.regex.fieldExplanationText
propertyPath: options.regularExpression
propertyValidators:
10: NotEmpty
9999:
identifier: removeButton
templateName: Inspector-RemoveElementEditor
@@ -0,0 +1,31 @@
formEditor.propertyCollections.validators.80.editors.100
--------------------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.80.editors.100
:aspect:`Data type`
array/ :ref:`[CollectionElementHeaderEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>`
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Recommended
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 8-
AdvancedPassword:
formEditor:
propertyCollections:
validators:
80:
identifier: RegularExpression
editors:
100:
identifier: header
templateName: Inspector-CollectionElementHeaderEditor
label: formEditor.elements.TextMixin.validators.RegularExpression.editor.header.label
@@ -0,0 +1,35 @@
formEditor.propertyCollections.validators.80.editors.200
--------------------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.80.editors.200
:aspect:`Data type`
array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>`
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Recommended
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 8-
AdvancedPassword:
formEditor:
propertyCollections:
validators:
80:
identifier: RegularExpression
editors:
200:
identifier: regex
templateName: Inspector-TextEditor
label: formEditor.elements.TextMixin.validators.RegularExpression.editor.regex.label
fieldExplanationText: formEditor.elements.TextMixin.validators.RegularExpression.editor.regex.fieldExplanationText
propertyPath: options.regularExpression
propertyValidators:
10: NotEmpty
@@ -0,0 +1,30 @@
formEditor.propertyCollections.validators.80.editors.9999
---------------------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.80.editors.9999
:aspect:`Data type`
array/ :ref:`[RemoveElementEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.removeelementeditor>`
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Recommended
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 8-
AdvancedPassword:
formEditor:
propertyCollections:
validators:
80:
identifier: RegularExpression
editors:
100:
identifier: removeButton
templateName: Inspector-RemoveElementEditor
@@ -0,0 +1,33 @@
formEditor.propertyCollections.validators.80.identifier
-------------------------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.propertyCollections.validators.80.identifier
:aspect:`Data type`
string
:aspect:`Needed by`
Backend (form editor)
:aspect:`Mandatory`
Yes
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 6
AdvancedPassword:
formEditor:
propertyCollections:
validators:
80:
identifier: RegularExpression
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
- :ref:`"\<validatorIdentifier>"<typo3.cms.form.prototypes.\<prototypeidentifier>.validatorsdefinition.\<validatoridentifier>>`
:aspect:`Description`
Identifies the validator which should be attached to the form element. Must be equal to a existing ``<validatorIdentifier>``.
@@ -0,0 +1,34 @@
implementationClassName
-----------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.implementationClassName
:aspect:`Data type`
string
:aspect:`Needed by`
Frontend/ Backend (form editor)
:aspect:`Overwritable within form definition`
No
:aspect:`form editor can write this property into the form definition (for prototype 'standard')`
No
:aspect:`Mandatory`
Yes
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 2
AdvancedPassword:
implementationClassName: TYPO3\CMS\Form\Domain\Model\FormElements\AdvancedPassword
.. :aspect:`Good to know`
ToDo
:aspect:`Description`
Classname which implements the form element.
@@ -0,0 +1,39 @@
properties.confirmationClassAttribute
-------------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.properties.confirmationClassAttribute
:aspect:`Data type`
string
:aspect:`Needed by`
Frontend/ Backend (form editor)
:aspect:`Overwritable within form definition`
Yes
:aspect:`form editor can write this property into the form definition (for prototype 'standard')`
No
:aspect:`Mandatory`
No
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 7
AdvancedPassword:
properties:
containerClassAttribute: input
elementClassAttribute: input-medium
elementErrorClassAttribute: error
confirmationLabel: ''
confirmationClassAttribute: input-medium
.. :aspect:`Good to know`
ToDo
:aspect:`Description`
A CSS class written to the password confirmation form element.
@@ -0,0 +1,39 @@
properties.confirmationLabel
----------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.properties.confirmationLabel
:aspect:`Data type`
string
:aspect:`Needed by`
Frontend/ Backend (form editor)
:aspect:`Overwritable within form definition`
Yes
:aspect:`form editor can write this property into the form definition (for prototype 'standard')`
Yes
:aspect:`Mandatory`
No
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 6
AdvancedPassword:
properties:
containerClassAttribute: input
elementClassAttribute: input-medium
elementErrorClassAttribute: error
confirmationLabel: ''
confirmationClassAttribute: input-medium
.. :aspect:`Good to know`
ToDo
:aspect:`Description`
The label for the password confirmation form element.
@@ -0,0 +1,39 @@
properties.containerClassAttribute
----------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.properties.containerClassAttribute
:aspect:`Data type`
string
:aspect:`Needed by`
Frontend/ Backend (form editor)
:aspect:`Overwritable within form definition`
Yes
:aspect:`form editor can write this property into the form definition (for prototype 'standard')`
No
:aspect:`Mandatory`
No
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 3
AdvancedPassword:
properties:
containerClassAttribute: input
elementClassAttribute: input-medium
elementErrorClassAttribute: error
confirmationLabel: ''
confirmationClassAttribute: input-medium
.. :aspect:`Good to know`
ToDo
:aspect:`Description`
A CSS class which is typically wrapped around the form elements.
@@ -0,0 +1,39 @@
properties.elementClassAttribute
--------------------------------
:aspect:`Option path`
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.properties.elementClassAttribute
:aspect:`Data type`
string
:aspect:`Needed by`
Frontend/ Backend (form editor)
:aspect:`Overwritable within form definition`
Yes
:aspect:`form editor can write this property into the form definition (for prototype 'standard')`
No
:aspect:`Mandatory`
No
:aspect:`Default value (for prototype 'standard')`
.. code-block:: yaml
:linenos:
:emphasize-lines: 4
AdvancedPassword:
properties:
containerClassAttribute: input
elementClassAttribute: input-medium
elementErrorClassAttribute: error
confirmationLabel: ''
confirmationClassAttribute: input-medium
.. :aspect:`Good to know`
ToDo
:aspect:`Description`
A CSS class written to the form element.
Loaded 100 of 12716 files, more files were not shown because too many files have changed in this diff. Show more