Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Backport 12.4] Clarify overriding FlexForm in TCEFORM #413

Merged
merged 3 commits into from
Dec 3, 2023
Merged

[Backport 12.4] Clarify overriding FlexForm in TCEFORM #413

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
25483f5
Clarify overriding FlexForm in TCEFORM
sypets Dec 2, 2023
8d0741a
Optimize phrase
sypets Dec 2, 2023
57a271a
Add link
sypets Dec 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
99 changes: 66 additions & 33 deletions Documentation/PageTsconfig/TceForm.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ disable options, blind options in selector boxes etc.
See the core API document section :ref:`FormEngine <t3coreapi:FormEngine>` for more
details on how records are rendered in the backend.

Applying properties
===================

The properties listed below apply to various contexts which are explained per
property. The full property path thus depends on the property and where it should
apply. In general, a more specific property path overrides a less specific one:
Expand All @@ -27,24 +30,39 @@ per table and record type. This leads to the property paths
and `TCEFORM.[tableName].[fieldName].types.[typeName]` to configure a field for a specific
type, see the :ref:`TCA type section <t3tca:types>` for details on types.

Other properties also apply to flex form fields, in this case the full property
While all that property path munging looks messy at first, it should become more
clear when reading through the single properties below and looking at the examples.

.. youtube:: B3IQq7pIJ_o

.. _tceformApplyPropertiesFlexForm:

Applying properties to FlexForm fields
--------------------------------------

Other properties also apply to :ref:`FlexForm <t3coreapi:flexforms>` fields, in this case the full property
path including the data structure key has to be set:
`TCEFORM.[tableName].[fieldName].[dataStructureKey].[flexSheet].[flexFieldName].[propertyName]`.

.. code-block:: typoscript

# TCEFORM.[tableName].[fieldName].[dataStructureKey].[flexSheet].[flexFieldName with escaped dots].[propertyName]
TCEFORM.tt_content.pi_flexform.sfregister_create.sDEF.settings\.fields\.selected.addItems.ZZZ = ZZZ

The sheet name (sDEF) must be given only if the FlexForm has a sheet.

The `[dataStructureKey]` represents the key of a FlexForm in
:php:`$GLOBALS['TCA'][<tableName>]['columns'][<field>]['config']['ds']`. This key will be split into up to
two parts. By default the first part will be used as identifier of the FlexForm in TSconfig. The second part
will override the identifier if it is not empty, `list` or `*`. For example the identifier of the key
`myext_pi1,list` will be `myext_pi1` and of the key `*,my_CType` it will be `my_CType`. See section
:ref:`Pointing to a data structure <t3tca:columns-flex-ds-pointer>` of the TCA reference for details.

The flexFieldName is the name of the property in the FlexForm. If it contains
dots ('.'), these must be escaped with backslash.

Some properties apply to whole FlexForm sheets, their property path is
`TCEFORM.[tableName].[fieldName].[dataStructureKey].[flexSheet].[propertyName]`.

While all that property path munging looks messy at first, it should become more
clear if reading through the single properties below and looking at the examples.

.. youtube:: B3IQq7pIJ_o

Properties
==========

Expand Down Expand Up @@ -83,9 +101,10 @@ addItems
`TCEFORM.tt_content.header_layout.types.textpic.addItems`

Flex form field level, example:
`TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.myField.addItems`
`TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.settings\.myfield.addItems`

Where `sDEF` is the sheet name.
Where `sDEF` is the sheet name. For a description
see the section :ref:`tceformApplyPropertiesFlexForm` on this page.

.. warning::
Do not add page types this way (using `TCEFORM.pages.doktype.addItems`), instead the proper
Expand Down Expand Up @@ -132,9 +151,10 @@ altLabels
`TCEFORM.[tableName].[fieldName].types.[typeName].altLabels`

Flex form field level, example:
`TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.myField.altLabels`
`TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.settings\.myfield.altLabels`

Where `sDEF` is the sheet name.
Where `sDEF` is the sheet name. For a description
see the section :ref:`tceformApplyPropertiesFlexForm` on this page.

:aspect:`Example`
.. code-block:: typoscript
Expand Down Expand Up @@ -347,9 +367,10 @@ config.treeConfig
`TCEFORM.tt_content.header.types.config.treeConfig.startingPoints`

Flex form field level, example:
`TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.myField.config.treeConfig.startingPoints`
`TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.settings\.myfield.config.treeConfig.startingPoints`

Where `sDEF` is the sheet name.
Where `sDEF` is the sheet name. For a description
see the section :ref:`tceformApplyPropertiesFlexForm` on this page.


.. index::
Expand Down Expand Up @@ -426,12 +447,14 @@ disabled
Flex form sheet level. If set, the entire tab is not rendered, example:
`TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.disabled`

Where `sDEF` is the sheet name.
Where `sDEF` is the sheet name. For a description
see the section :ref:`tceformApplyPropertiesFlexForm` on this page.

Flex form field level, example:
`TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.myField.disabled`
`TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.settings\.myfield.disabled`

Where `sDEF` is the sheet name.
Where `sDEF` is the sheet name. For a description
see the section :ref:`tceformApplyPropertiesFlexForm` on this page.

:aspect:`Example`
.. code-block:: typoscript
Expand Down Expand Up @@ -474,9 +497,10 @@ disableNoMatchingValueElement
`TCEFORM.tt_content.header_layout.types.textpic.disableNoMatchingValueElement`

Flex form field level, example:
`TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.myField.disableNoMatchingValueElement`
`TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.settings\.myfield.disableNoMatchingValueElement`

Where `sDEF` is the sheet name.
Where `sDEF` is the sheet name. For a description
see the section :ref:`tceformApplyPropertiesFlexForm` on this page.

:aspect:`Example`
.. code-block:: typoscript
Expand Down Expand Up @@ -537,9 +561,10 @@ fileFolderConfig
`TCEFORM.[tableName].[fieldName].types.[typeName].fileFolderConfig.folder`

Flex form field level, example:
`TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.myField.fileFolderConfig.folder`
`TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.settings\.myfield.fileFolderConfig.folder`

Where `sDEF` is the sheet name.
Where `sDEF` is the sheet name. For a description
see the section :ref:`tceformApplyPropertiesFlexForm` on this page.


.. index::
Expand All @@ -566,9 +591,10 @@ itemsProcFunc
`TCEFORM.[tableName].[fieldName].types.[typeName].itemsProcFunc`

Flex form field level, example:
`TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.myField.itemsProcFunc`
`TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.settings\.myfield.itemsProcFunc`

Where `sDEF` is the sheet name.
Where `sDEF` is the sheet name. For a description
see the section :ref:`tceformApplyPropertiesFlexForm` on this page.


.. index::
Expand All @@ -593,9 +619,10 @@ keepItems
`TCEFORM.tt_content.header_layout.types.textpic.keepItems`

Flex form field level, example:
`TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.myField.keepItems`
`TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.settings\.myfield.keepItems`

Where `sDEF` is the sheet name.
Where `sDEF` is the sheet name. For a description
see the section :ref:`tceformApplyPropertiesFlexForm` on this page.

:aspect:`Example`
.. code-block:: typoscript
Expand Down Expand Up @@ -633,9 +660,10 @@ label
`TCEFORM.[tableName].[fieldName].types.[typeName].label`

Flex form field level, example:
`TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.myField.label`
`TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.settings\.myfield.label`

Where `sDEF` is the sheet name.
Where `sDEF` is the sheet name. For a description
see the section :ref:`tceformApplyPropertiesFlexForm` on this page.

:aspect:`Example`
.. code-block:: typoscript
Expand Down Expand Up @@ -673,9 +701,10 @@ noMatchingValue_label
`TCEFORM.tt_content.header_layout.types.textpic.noMatchingValue_label`

Flex form field level, example:
`TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.myField.noMatchingValue_label`
`TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.settings\.myfield.noMatchingValue_label`

Where `sDEF` is the sheet name.
Where `sDEF` is the sheet name. For a description
see the section :ref:`tceformApplyPropertiesFlexForm` on this page.

:aspect:`Example`
.. code-block:: typoscript
Expand Down Expand Up @@ -714,9 +743,10 @@ removeItems
`TCEFORM.tt_content.header_layout.types.textpic.removeItems`

Flex form field level, example:
`TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.myField.removeItems`
`TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.settings\.myfield.removeItems`

Where `sDEF` is the sheet name.
Where `sDEF` is the sheet name. For a description
see the section :ref:`tceformApplyPropertiesFlexForm` on this page.

:aspect:`Example`
.. code-block:: typoscript
Expand All @@ -742,7 +772,8 @@ sheetDescription
This property is only available on flex form sheet level, example:
`TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.sheetDescription`

Where `sDEF` is the sheet name.
Where `sDEF` is the sheet name. For a description
see the section :ref:`tceformApplyPropertiesFlexForm` on this page.


.. index::
Expand All @@ -760,7 +791,8 @@ sheetShortDescr
This property is only available on flex form sheet level, example:
`TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.sheetShortDescription`

Where `sDEF` is the sheet name.
Where `sDEF` is the sheet name. For a description
see the section :ref:`tceformApplyPropertiesFlexForm` on this page.

.. index::
FlexForm; Sheet title
Expand All @@ -777,7 +809,8 @@ sheetTitle
This property is only available on flex form sheet level, example:
`TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.sheetTitle`

Where `sDEF` is the sheet name.
Where `sDEF` is the sheet name. For a description
see the section :ref:`tceformApplyPropertiesFlexForm` on this page.

:aspect:`Example`
.. code-block:: typoscript
Expand Down
Loading