selectCheckBox
This page describes the select type with
renderType='selectCheckBox'. For differences to type="check" see
selectCheckBox and type check compared.
The according database field is generated automatically.
Table of contents:
Example: Simple select checkbox with 3 possible values
The topics of a speaker
The select checkbox stores the values as comma separated values.
<?php
use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
defined('TYPO3') or die();
ExtensionManagementUtility::addTCAcolumns('tx_myextension_speaker', [
'topics' => [
'label' => 'my_extension.db:speaker.topics',
'config' => [
'type' => 'select',
'renderType' => 'selectCheckBox',
'items' => [
[
'label' => 'my_extension.db:speaker.topics.tca',
'value' => 'tca',
'group' => 'backend',
'icon' => 'content-database',
'description' => 'my_extension.db:speaker.topics.tca.description',
],
['label' => 'my_extension.db:speaker.topics.extbase', 'value' => 'extbase', 'group' => 'backend'],
['label' => 'my_extension.db:speaker.topics.fluid', 'value' => 'fluid', 'group' => 'frontend'],
['label' => 'my_extension.db:speaker.topics.typoscript', 'value' => 'typoscript', 'group' => 'frontend'],
['label' => 'my_extension.db:speaker.topics.accessibility', 'value' => 'accessibility', 'group' => 'frontend'],
],
'itemGroups' => [
'backend' => 'my_extension.db:speaker.topics.group.backend',
'frontend' => 'my_extension.db:speaker.topics.group.frontend',
],
'appearance' => [
'expandAll' => true,
],
'behaviour' => [
'allowLanguageSynchronization' => true,
],
],
],
]);
ExtensionManagementUtility::addToAllTCAtypes(
'tx_myextension_speaker',
'topics',
'',
'after:short_bio',
);
Example: Select checkbox with icons and groups
The topics of a speaker in two groups
The select checkbox stores the values as comma separated values.
<?php
use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
defined('TYPO3') or die();
ExtensionManagementUtility::addTCAcolumns('tx_myextension_speaker', [
'topics' => [
'label' => 'my_extension.db:speaker.topics',
'config' => [
'type' => 'select',
'renderType' => 'selectCheckBox',
'items' => [
[
'label' => 'my_extension.db:speaker.topics.tca',
'value' => 'tca',
'group' => 'backend',
'icon' => 'content-database',
'description' => 'my_extension.db:speaker.topics.tca.description',
],
['label' => 'my_extension.db:speaker.topics.extbase', 'value' => 'extbase', 'group' => 'backend'],
['label' => 'my_extension.db:speaker.topics.fluid', 'value' => 'fluid', 'group' => 'frontend'],
['label' => 'my_extension.db:speaker.topics.typoscript', 'value' => 'typoscript', 'group' => 'frontend'],
['label' => 'my_extension.db:speaker.topics.accessibility', 'value' => 'accessibility', 'group' => 'frontend'],
],
'itemGroups' => [
'backend' => 'my_extension.db:speaker.topics.group.backend',
'frontend' => 'my_extension.db:speaker.topics.group.frontend',
],
'appearance' => [
'expandAll' => true,
],
'behaviour' => [
'allowLanguageSynchronization' => true,
],
],
],
]);
ExtensionManagementUtility::addToAllTCAtypes(
'tx_myextension_speaker',
'topics',
'',
'after:short_bio',
);
Properties of the TCA column type select with renderType selectCheckBox
| Name | Type | Scope |
|---|---|---|
| boolean | Proc. | |
| array | Display | |
| string (keyword) | Display / Proc. | |
| boolean | Proc. | |
| integer | Proc. | |
| string | Display / Proc. | |
| boolean | Display | |
| string (list of tables) | Proc. | |
| array | ||
| array | ||
| array | ||
| array | Display | |
| string | Display / Proc. | |
| integer | Display / Proc. | |
| string | Display / Proc. | |
| string (table name) | Display / Proc. | |
| string (column name) | Display / Proc. | |
| plain text label or label reference | Display | |
| string (SQL WHERE) | Display / Proc. | |
| array | Display / Proc. | |
| array | Display / Proc. | |
| array | Display / Proc. | |
| string (class->method reference) | Display / Proc. | |
| integer > 0 | Display / Proc. | |
| integer > 0 | Display | |
| string (table name) | Proc. | |
| array | Display / Proc. | |
| string (field name) | Proc. | |
| array | Proc. | |
| string (SQL WHERE) | Proc. | |
| boolean | Display | |
| string | Proc. | |
| boolean | Display |
-
- Type
- boolean
- TCA path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']['allowNonIdValues']
- Scope
- Proc.
- RenderType
- all
Only useful if foreign_table is enabled.
If set, then values which are not integer ids will be allowed. May be needed if you use itemsProcFunc or enter additional items in the items array to produce some string-value elements for the list.
Note
If you mix non-database relations with database relations like this, DO NOT use integers for values and DO NOT use "_" (underscore) in values either! Will not work if you also use "MM" relations!
-
-
- Type
- array
- TCA path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']['appearance']['selectCheckBox']
- Scope
- Display
Options for refining the appearance of
selectfields.Check Box - expandAll (boolean)
- If set, all select groups are initially expanded.
Example: Select checkbox, all divs expanded
The topics of a speaker, all groups expanded
EXT:my_extension/Configuration/TCA/Overrides/332-tx_myextension_speaker-topics.php<?php use TYPO3\CMS\Core\Utility\ExtensionManagementUtility; defined('TYPO3') or die(); ExtensionManagementUtility::addTCAcolumns('tx_myextension_speaker', [ 'topics' => [ 'label' => 'my_extension.db:speaker.topics', 'config' => [ 'type' => 'select', 'renderType' => 'selectCheckBox', 'items' => [ [ 'label' => 'my_extension.db:speaker.topics.tca', 'value' => 'tca', 'group' => 'backend', 'icon' => 'content-database', 'description' => 'my_extension.db:speaker.topics.tca.description', ], ['label' => 'my_extension.db:speaker.topics.extbase', 'value' => 'extbase', 'group' => 'backend'], ['label' => 'my_extension.db:speaker.topics.fluid', 'value' => 'fluid', 'group' => 'frontend'], ['label' => 'my_extension.db:speaker.topics.typoscript', 'value' => 'typoscript', 'group' => 'frontend'], ['label' => 'my_extension.db:speaker.topics.accessibility', 'value' => 'accessibility', 'group' => 'frontend'], ], 'itemGroups' => [ 'backend' => 'my_extension.db:speaker.topics.group.backend', 'frontend' => 'my_extension.db:speaker.topics.group.frontend', ], 'appearance' => [ 'expandAll' => true, ], 'behaviour' => [ 'allowLanguageSynchronization' => true, ], ], ], ]); ExtensionManagementUtility::addToAllTCAtypes( 'tx_myextension_speaker', 'topics', '', 'after:short_bio', );
-
- Type
- string (keyword)
- TCA path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']['authMode']
- Scope
- Display / Proc.
- RenderType
- all
Authorization mode for the selector box. The only possible option is:
- explicitAllow
- All static values from the "items" array of the selector box will be added to a matrix in the backend user configuration where a value must be explicitly selected if a user (other than admin) is allowed to use it!)
-
-
- Type
- boolean
- Default
- false
- TCA path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']['behaviour']['allowLanguageSynchronization']
- Scope
- Proc.
Allows an editor to select in a localized record whether the value is copied over from default or source language record, or if the field has an own value in the localization. If set to true and if the table supports localization and if a localized record is edited, this setting enables FieldWizard LocalizationStateSelector: Two or three radio buttons shown below the field input. The state of this is stored in a json encoded array in the database table called
l10n_. It tells the DataHandler which fields of the localization records should be kept in sync if the underlying default or source record changes.state EXT:my_extension/Configuration/TCA/Overrides/332-tx_myextension_speaker-topics.php<?php use TYPO3\CMS\Core\Utility\ExtensionManagementUtility; defined('TYPO3') or die(); ExtensionManagementUtility::addTCAcolumns('tx_myextension_speaker', [ 'topics' => [ 'label' => 'my_extension.db:speaker.topics', 'config' => [ 'type' => 'select', 'renderType' => 'selectCheckBox', 'items' => [ [ 'label' => 'my_extension.db:speaker.topics.tca', 'value' => 'tca', 'group' => 'backend', 'icon' => 'content-database', 'description' => 'my_extension.db:speaker.topics.tca.description', ], ['label' => 'my_extension.db:speaker.topics.extbase', 'value' => 'extbase', 'group' => 'backend'], ['label' => 'my_extension.db:speaker.topics.fluid', 'value' => 'fluid', 'group' => 'frontend'], ['label' => 'my_extension.db:speaker.topics.typoscript', 'value' => 'typoscript', 'group' => 'frontend'], ['label' => 'my_extension.db:speaker.topics.accessibility', 'value' => 'accessibility', 'group' => 'frontend'], ], 'itemGroups' => [ 'backend' => 'my_extension.db:speaker.topics.group.backend', 'frontend' => 'my_extension.db:speaker.topics.group.frontend', ], 'appearance' => [ 'expandAll' => true, ], 'behaviour' => [ 'allowLanguageSynchronization' => true, ], ], ], ]); ExtensionManagementUtility::addToAllTCAtypes( 'tx_myextension_speaker', 'topics', '', 'after:short_bio', );
-
- Type
- integer
- Default
- 255
- TCA path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']['dbFieldLength']
- Scope
- Proc.
New in version 13.0
As TYPO3 takes care of generating the according database field for
selectfields since TYPO3 v13, a developer can adjust the length of the database field with this option in TCA directly.The TCA config option
dbcontains an integer value that is applied toField Length varcharfields (nottext) and defines the length of the database field. It will not be respected for fields that resolve to an integer type. Developers who wish to optimize field length can usedbforField Length type=selectfields to increase or decrease the default length.
'dbFieldLength' => 1000,
-
- Type
- string
- TCA path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']['default']
- Scope
- Display / Proc.
- RenderType
- all
Default value set if a new record is created. If empty, the first element in the items array is selected.
-
- Type
- boolean
- TCA path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']['disableNoMatchingValueElement']
- Scope
- Display
- RenderType
- all
If set, then no element is inserted if the current value does not match any of the existing elements. A corresponding options is also found in Page TSconfig.
-
- Type
- string (list of tables)
- TCA path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']['dontRemapTablesOnCopy']
- Scope
- Proc.
A list of tables which should not be remapped to the new element uids if the field holds elements that are copied in the session.
-
For details see fieldInformation.
-
-
- Type
- array
- TCA path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']['fieldWizard']['defaultLanguageDifferences']
For details see defaultLanguageDifferences.
-
- Type
- array
- TCA path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']['fieldWizard']['localizationStateSelector']
For details see localizationStateSelector.
-
- Type
- array
- TCA path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']['fieldWizard']['otherLanguageContent']
For details see otherLanguageContent.
-
- Type
- array
- TCA path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']['fieldWizard']['selectIcons']
- Scope
- Display
Render thumbnails of icons below the select drop-down. Disabled by default.
-
-
- Type
- string
- TCA path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']['fileFolderConfig']['allowedExtensions']
- Scope
- Display / Proc.
List of file extensions to select. If blank, all files are selected. Specify list in lowercase.
This configuration can be overridden by Page TSconfig.
-
- Type
- integer
- TCA path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']['fileFolderConfig']['depth']
- Scope
- Display / Proc.
- RenderType
- all
Depth of directory recursions. Default is 99. Specify in range from 0-99. 0 (zero) means no recursion into subdirectories. Only useful in combination with property folder.
This configuration can be overridden by Page TSconfig.
-
- Type
- string
- TCA path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']['fileFolderConfig']['folder']
- Scope
- Display / Proc.
Specifying a folder from where files are added to the item array.
Specify the folder relative to the
\TYPO3\. See getPublicPath() . Alternatively use the prefix "EXT:" to point to an extension folder.CMS\ Core\ Core\ Environment:: get Public Path () Files from the folder are selected recursively to the level specified by depth and only files of the extensions defined by allowedExtensions are listed in the select box.
Only the file reference relative to the folder is stored.
If the files are images (gif,png,jpg) they will be configured as icons (third parameter in items array).
This configuration can be overridden by Page TSconfig.
-
- Type
- string (table name)
- TCA path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']['foreign_table']
- Scope
- Display / Proc.
- RenderType
- all
The item-array will be filled with records from the table defined here. The table must have a TCA definition.
The uids of the chosen records will be saved in a comma separated list by default.
Use property MM to store the values in an intermediate MM table instead.
-
- Type
- string (column name)
- TCA path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']['foreign_table_item_group']
- Scope
- Display / Proc.
- RenderType
- all
- Added
- 13.0
This property references a specific field in the foreign table, which holds an item group identifier.
See also foreign_table_item_group.
-
- Type
- plain text label or label reference
- TCA path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']['foreign_table_prefix']
- Scope
- Display
- RenderType
- all
Label prefix to the title of the records from the foreign-table.
-
- Type
- string (SQL WHERE)
- TCA path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']['foreign_table_where']
- Scope
- Display / Proc.
- RenderType
- all
The items from foreign_table are selected with this
WHEREclause. TheWHEREclause is effectively appended to the existingWHEREclause (which contains default constraints, such asNOT deleted) and must begin withAND.
The example below uses the special field quoting syntax {#...} around
identifiers to be as DBAL-compatible as possible.
Note that
ORDER BY
and
GROUP BY
should NOT be quoted, since they always receive proper quoting automatically
through the API.
Markers inside the WHERE statement
It is possible to use markers in the WHERE clause:
- ###REC_FIELD_[field name]###
-
Any field of the current record.
Note
The field name part of the marker is not in upper case letters. It must match the exact case used in the database.
So for example
sys_must be referenced usinglanguage_ uid ###REC_FIELD_ sys_ language_ uid### - ###THIS_UID###
- Current element uid (zero if new).
- ###CURRENT_PID###
- The current page id (pid of the record).
###SITEROOT###
- ###PAGE_TSCONFIG_ID###
- A value you can set from Page TSconfig dynamically.
- ###PAGE_TSCONFIG_IDLIST###
- A value you can set from Page TSconfig dynamically.
- ###PAGE_TSCONFIG_STR###
- A value you can set from Page TSconfig dynamically.
- ###SITE:<KEY>.<SUBKEY>###
- A value from the site configuration, for example:
###SITE:ormy Setting. category Pid### ###SITE:.root Page Id###
The markers are preprocessed so that the value of CURRENT_PID and PAGE_TSCONFIG_ID are always integers (default is zero), PAGE_TSCONFIG_IDLIST will always be a comma-separated list of integers (default is zero) and PAGE_TSCONFIG_STR will be quoted before substitution (default is blank string).
More information about markers set by Page TSconfig can be found in the TSconfig reference.
-
- Type
- array
- TCA path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']['itemGroups']
- Scope
- Display / Proc.
- RenderType
- all
Contains an array of key-value pairs. The key contains the id of the item group, the value contains the label of the item group or its language reference.
Only groups containing items will be displayed. In the select field first all items with no group defined are listed then the item groups in the order of their definition, each group with the corresponding items.
Item groups are rendered as
<optgroup>.Item groups can also be defined for items in foreign tables.
See also item group API methods
-
- Type
- array
- TCA path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']['items']
- Scope
- Display / Proc.
- RenderType
- all
Contains the elements for the selector box unless the property
foreign_ortable specialhas been set in which case automated values are set in addition to any values listed in this array.Each element in this array is in itself an associative array.
- label (plain text label or label reference)
- The displayed title.
- value (integer or string)
-
The value stored in the database.
- The special value
--was used to insert a non-selectablediv-- - value that appears as a divider label in the selector box. It is kept for backwards-compatible reasons. Use item groups for custom selects instead.
- The special value
- Values must not contain
,(comma) and|(vertical bar). If you want to useauth, you shouldMode - also refrain from using
:(colon).
- Values must not contain
- icon (EXT: path or icon identifier)
- Optional icon. For custom icons use a path prepended with
EXT:to refer to an image file found inside an extension or use an registered icon identifier. If configured on theforeign_, selicon-field is respected.table - group (string)
- The key of the item group.
- description (string or array)
- Fifth value is an optional description text.
Note
When having a zero as
valueand the field is of typeintin the database, make sure to define the default value as well in TCA:(10) 'default' => 0. Otherwise issues may arise, e.g. with MySQL strict mode.Select checkbox field with icons and descriptions
The topics of a speaker
EXT:my_extension/Configuration/TCA/Overrides/332-tx_myextension_speaker-topics.php<?php use TYPO3\CMS\Core\Utility\ExtensionManagementUtility; defined('TYPO3') or die(); ExtensionManagementUtility::addTCAcolumns('tx_myextension_speaker', [ 'topics' => [ 'label' => 'my_extension.db:speaker.topics', 'config' => [ 'type' => 'select', 'renderType' => 'selectCheckBox', 'items' => [ [ 'label' => 'my_extension.db:speaker.topics.tca', 'value' => 'tca', 'group' => 'backend', 'icon' => 'content-database', 'description' => 'my_extension.db:speaker.topics.tca.description', ], ['label' => 'my_extension.db:speaker.topics.extbase', 'value' => 'extbase', 'group' => 'backend'], ['label' => 'my_extension.db:speaker.topics.fluid', 'value' => 'fluid', 'group' => 'frontend'], ['label' => 'my_extension.db:speaker.topics.typoscript', 'value' => 'typoscript', 'group' => 'frontend'], ['label' => 'my_extension.db:speaker.topics.accessibility', 'value' => 'accessibility', 'group' => 'frontend'], ], 'itemGroups' => [ 'backend' => 'my_extension.db:speaker.topics.group.backend', 'frontend' => 'my_extension.db:speaker.topics.group.frontend', ], 'appearance' => [ 'expandAll' => true, ], 'behaviour' => [ 'allowLanguageSynchronization' => true, ], ], ], ]); ExtensionManagementUtility::addToAllTCAtypes( 'tx_myextension_speaker', 'topics', '', 'after:short_bio', );
-
- Type
- array
- TCA path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']['itemsProcessors']
- Scope
- Display / Proc.
- Added
- 14.0
An array indexed numerically. Each entry defines an item processor implementing
Items.Processor Interface Item processors are executed sequentially in ascending order of their numerical array key. Each processor can add, modify, or remove items from the
Select, influencing which items are ultimately displayed.Item Collection This option can be combined with itemsProcFunc. If both are configured,
itemsis executed first andProc Func itemsare executed afterwards.Processors EXT:my_extension/Configuration/TCA/Overrides/121-tx_myextension_conference-timezone.php<?php use MyVendor\MyExtension\Backend\ItemsProcessor\TimezoneItemsProcessor; use MyVendor\MyExtension\Backend\TimezoneSorter; use TYPO3\CMS\Core\Utility\ExtensionManagementUtility; defined('TYPO3') or die(); ExtensionManagementUtility::addTCAcolumns('tx_myextension_conference', [ 'timezone' => [ 'label' => 'my_extension.db:conference.timezone', 'config' => [ 'type' => 'select', 'renderType' => 'selectSingle', 'items' => [ ['label' => '', 'value' => ''], ], 'itemsProcessors' => [ 100 => [ 'class' => TimezoneItemsProcessor::class, 'parameters' => [ 'regions' => 'Europe,America', ], ], ], 'itemGroups' => [ 'Europe' => 'my_extension.db:conference.timezone.europe', 'America' => 'my_extension.db:conference.timezone.america', ], 'sortItems' => [ 'label' => 'asc', // Then by the offset to UTC, the time zones with the same offset // stay sorted by label 'offset' => TimezoneSorter::class . '->sortByOffset', ], 'dbFieldLength' => 64, 'behaviour' => [ 'allowLanguageSynchronization' => true, ], ], ], ]); ExtensionManagementUtility::addToAllTCAtypes( 'tx_myextension_conference', 'timezone', '', 'after:location', );For fields of type
select, eachSelectmust be created withItem type: 'select'and must provide alabeland avalue. The value can be an integer or a string.Use the special value
'--to insert a divider (that cannot be selected).div--' You can also use any arguments supported by the items array, including
group,iconanddescription.EXT:my_extension/Classes/Backend/ItemsProcessor/TimezoneItemsProcessor.php<?php declare(strict_types=1); namespace MyVendor\MyExtension\Backend\ItemsProcessor; use TYPO3\CMS\Core\DataHandling\ItemsProcessorContext; use TYPO3\CMS\Core\DataHandling\ItemsProcessorInterface; use TYPO3\CMS\Core\Schema\Struct\SelectItem; use TYPO3\CMS\Core\Schema\Struct\SelectItemCollection; /** * Offers the time zones of the regions given in the parameter "regions", * grouped by region */ final readonly class TimezoneItemsProcessor implements ItemsProcessorInterface { public function processItems( SelectItemCollection $items, ItemsProcessorContext $context, ): SelectItemCollection { $regions = explode(',', (string)($context->processorParameters['regions'] ?? 'Europe')); foreach (\DateTimeZone::listIdentifiers() as $identifier) { [$region, $city] = array_pad(explode('/', $identifier, 2), 2, ''); if ($city === '' || !in_array($region, $regions, true)) { continue; } $items->add(new SelectItem( type: 'select', label: str_replace('_', ' ', $city), value: $identifier, group: $region, )); } return $items; } }
-
- Type
- string (class->method reference)
- TCA path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']['itemsProcFunc']
- Scope
- Display / Proc.
PHP method which is called to fill or manipulate the items array. See itemsProcFunc about details.
-
- Type
- integer > 0
- TCA path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']['maxitems']
- Scope
- Display / Proc.
Maximum number of child items. Defaults to a high value. JavaScript record validation prevents the record from being saved if the limit is not satisfied.
-
- Type
- integer > 0
- TCA path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']['minitems']
- Scope
- Display
Minimum number of child items. Defaults to 0. JavaScript record validation prevents the record from being saved if the limit is not satisfied.
Note
TCA table column fields that define ['config'] can omit the
specification of the intermediate MM table layout in
ext_tables.sql. The TYPO3 database
analyzer takes care of proper schema definition.
-
- Type
- string (table name)
- TCA path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']['MM']
- Scope
- Proc.
This value contains the name of the table in which to store a MM relation. It is used together with foreign_table.
The database field with a MM property only stores the number of records in the relation.
Please have a look into the additional information in the MM common property description.
-
- Type
- array
- TCA path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']['MM_match_fields']
- Scope
- Display / Proc.
Array of field => value pairs to both insert and match against when writing/reading MM relations.
-
- Type
- string (field name)
- TCA path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']['MM_opposite_field']
- Scope
- Proc.
If you want to make a MM relation editable from the foreign side (bidirectional) of the relation as well, you need to set
MM_on the foreign side to the field name on the local side.opposite_ field For example, if the field
companies.is your local side and you want to make the same relation editable from the foreign side of the relation in a field calledemployees persons., you would need to set theemployers MM_value of the TCA configuration of theopposite_ field persons.field to the string "employees".employers Note
Bidirectional references only get registered once on the native side in
sys_.refindex
-
- Type
- array
- TCA path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']['MM_oppositeUsage']
- Scope
- Proc.
In a MM bidirectional relation using match fields the opposite side needs to know about the match fields for certain operations (for example, when a copy is created in a workspace) so that relations are carried over with the correct information.
MM_is an array which references which fields contain the references to the opposite side, so that they can be queried for match field configuration.opposite Usage
-
- Type
- string (SQL WHERE)
- TCA path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']['MM_table_where']
- Scope
- Proc.
Additional where clause used when reading MM relations.
Example:
{#uid_local} = ###THIS_UID###Copied!The above example uses the special field quoting syntax
{#...}around identifiers to be as DBAL-compatible as possible.
-
- Type
- boolean
- TCA path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']['readOnly']
- Scope
- Display
Renders the field in a way that the user can see the value but cannot edit it.
Warning
This property affects only the display. It is still possible to write to those fields when using the DataHandler.
-
- Type
- string
- TCA path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']['relationship']
- Scope
- Proc.
New in version 13.3
Defines whether the field holds one related record or several, if it relates to records through
foreign_. This decides which value a Record object provides for this field, for example in a Fluid template.table one,To One manyTo One - The field provides a single
Recordobject, ornullif no record is selected.maxitemsis set to1automatically, overriding any other value. oneTo Many - The field provides a
LazyofRecord Collection Recordobjects.
A field with
MMalways provides a collection, whateverrelationshipsays. Any other value, includingmany, throws an exception unlessTo Many MMis set.maxitemsdoes not change the result the other way round: a field withonestill provides a collection, even ifTo Many maxitemsis1.A select field without
foreign_has no relation. It provides an array of the selected values, or the single value fortable render.Type => 'select Single' If
relationshipis not set, a field withforeign_provides a collection.table
-
- Type
- boolean
- Default
- false
- TCA path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']['showIfEmpty']
- Scope
- Display
Changed in version 14.2
Starting with TYPO3 14.2, relational fields are hidden when no selectable items are available. Option
showwill disable this behaviour.If Empty By default,
selectfields and any render types are hidden when no select items are available. Settingshowto true displays the field even if no options are available.If Empty EXT:my_extension/Configuration/TCA/Overrides/pages.php$GLOBALS['TCA']['pages']['columns']['some_select_field']['config']['showIfEmpty'] = true;Copied!Possible reasons why no select items are available:
- a foreign_table is used and the referenced table has no records or none matching the foreign_table_where.
- a foreign_table is used and the currently logged in user has no permissions for the referenced table or its records.
- All items have been hidden via page TSconfig, for example, removeItems or keepItems are inproperly configured.
- The itemsProcessors or itemsProcFunc had no result.