selectCheckBox
This page describes the select type with
renderType='selectCheckBox'. For differences to type="check"
see
selectCheckBox and type check fields compared.
The according database field is generated automatically.
Table of contents
Example: Simple select checkbox with 3 possible values
The select checkbox stores the values as comma separated values.
[
'columns' => [
'select_checkbox_1' => [
'label' => 'select_checkbox_1 description',
'description' => 'field description',
'config' => [
'type' => 'select',
'renderType' => 'selectCheckBox',
'items' => [
[
'label' => 'foo 1',
'value' => 1,
],
[
'label' => 'foo 2',
'value' => 2,
],
[
'label' => 'foo 3',
'value' => 3,
],
[
'label' => 'foo 4 (empty)',
'value' => '',
],
],
],
],
],
]
Example: Select checkbox with icons and groups
The select checkbox stores the values as comma separated values.
[
'columns' => [
'select_checkbox_7' => [
'label' => 'select_checkbox_7',
'description' => 'itemGroups',
'config' => [
'type' => 'select',
'renderType' => 'selectCheckBox',
'items' => [
[
'label' => 'foo 1',
'value' => 1,
'group' => 'group1',
],
[
'label' => 'foo 2',
'value' => 2,
'icon' => 'EXT:styleguide/Resources/Public/Icons/tx_styleguide.svg',
'group' => 'group1',
],
[
'label' => 'foo 3',
'value' => 3,
'icon' => 'EXT:styleguide/Resources/Public/Icons/tx_styleguide.svg',
],
[
'label' => 'foo 4',
'value' => 4,
],
[
'label' => 'foo 5',
'value' => 1,
'group' => 'group3',
],
],
'itemGroups' => [
'group1' => 'Group 1 with items',
'group2' => 'Group 2 with no items',
'group3' => 'Group 3 with items',
],
],
],
],
]
Properties of the TCA column type select
with renderType selectCheckBox
allowNonIdValues
-
- Type
- boolean
- Path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']
- 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 just 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!
appearance
-
selectCheckBox
-
- Type
- array
- Path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']['appearance']['selectCheckBox']
- Scope
- Display
Options for refining the appearance of
select
fields.Check Box - expandAll (boolean)
- If set, all select groups are initially expanded.
Example: Select checkbox, all divs expanded[ 'columns' => [ 'select_checkbox_5' => [ 'label' => 'select_checkbox_5 dividers, expandAll', 'config' => [ 'type' => 'select', 'renderType' => 'selectCheckBox', 'appearance' => [ 'expandAll' => true, ], 'items' => [ [ 'label' => 'div 1', 'value' => '--div--', ], [ 'label' => 'foo 1', 'value' => 1, ], [ 'label' => 'foo 2', 'value' => 2, ], [ 'label' => 'foo 3', 'value' => 3, ], [ 'label' => 'div 2', 'value' => '--div--', ], [ 'label' => 'foo 4', 'value' => 4, ], [ 'label' => 'foo 5', 'value' => 5, ], ], ], ], ], ]
Copied!
authMode
-
- Type
- string (keyword)
- Path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']
- 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!)
autoSizeMax
-
- Type
- integer
- Path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']
- Scope
- Display
The maximum size (height) of the select field.
The size of the select field will be automatically adjusted based on the number of selected items. The select field will never be smaller than the specified size and never larger than the value of
auto
.Size Max Note
Only has an effect if maxitems is greater than 1.
behaviour
-
allowLanguageSynchronization
-
- Type
- boolean
- Default
- false
- 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
dbFieldLength
-
- Type
- integer
- Path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']
- Default
- 255
- Scope
- Proc.
New in version 13.0
As TYPO3 takes care of generating the according database field for
select
fields since TYPO3 v13, a developer can adjust the length of the database field with this option in TCA directly.The TCA config option
db
contains an integer value that is applied toField Length varchar
fields (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 usedb
forField Length type=select
fields to increase or decrease the default length.
<?php
$selectField = [
'label' => 'My field',
'config' => [
'type' => 'select',
'renderType' => 'selectCheckBox',
'items' => [
['label' => '', 'value' => ''],
['label' => 'Some label', 'value' => 'some'],
['label' => 'Another label', 'value' => 'another'],
],
'default' => '',
'dbFieldLength' => 10,
],
];
default
-
- Type
- string
- Path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']
- 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.
disableNoMatchingValueElement
-
- Type
- boolean
- Path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']
- 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.
dontRemapTablesOnCopy
-
- Type
- string (list of tables)
- Path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']
- 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.
fieldInformation
-
For details see fieldInformation.
fieldWizard
-
defaultLanguageDifferences
-
- Type
- array
- Path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']['fieldWizard']['defaultLanguageDifferences']
For details see defaultLanguageDifferences.
localizationStateSelector
-
- Type
- array
- Path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']['fieldWizard']['localizationStateSelector']
For details see localizationStateSelector.
otherLanguageContent
-
- Type
- array
- Path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']['fieldWizard']['otherLanguageContent']
For details see otherLanguageContent.
selectIcons
-
- Type
- array
- Path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']['fieldWizard']['selectIcons']
- Scope
- fieldWizard
Render thumbnails of icons below the select drop-down. Disabled by default.
fileFolderConfig
-
allowedExtensions
-
- Type
- string
- 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.
depth
-
- Type
- integer
- 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.
folder
-
- Type
- string
- 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.
foreign_table
-
- Type
- string (table name)
- Path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']
- Scope
- Proc. / Display
- 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 <columns-
to store the values in an intermediate MM table instead.select- checkbox- properties- mm>
foreign_table_item_group
-
- Type
- string (column name)
- Path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']
- Scope
- Proc. / Display
- RenderType
- all
New in version 13.0
This property references a specific field in the foreign table, which holds an item group identifier.
See also foreign_table_item_group.
foreign_table_prefix
-
- Type
- string or LLL reference
- Path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']
- Scope
- Display
- RenderType
- all
Label prefix to the title of the records from the foreign-table.
foreign_table_where
-
- Type
- string (SQL WHERE)
- Path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']
- Scope
- Proc. / Display
- RenderType
- all
The items from foreign_table are selected with this
WHERE
clause. TheWHERE
clause is effectively appended to the existingWHERE
clause (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.
itemGroups
-
- Type
- array
- Path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']
- 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
items
-
- Type
- array
- Path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']
- Scope
- Display / Proc.
- RenderType
- all
Contains the elements for the selector box unless the property
foreign_
ortable special
has been set in which case automated values are set in addition to any values listed in this array.Changed in version 13.0
Auto-registration of New content element wizard via TCA introduced. If your extension supports both TYPO3 v12 and v13, keep the page TSconfig option newContentElement.wizardItems until dropping TYPO3 v12 support.
Items registered for the field
CType
of tablett_
get automatically added to the New content element wizard. Settings from the items property can be overridden via page TSconfig newContentElement.wizardItems.content See also Add content elements to the Content Element Wizard.
Each element in this array is in itself an associative array.
- label (string or LLL 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
value
and the field is of typeint
in 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[ 'columns' => [ 'select_checkbox_3' => [ 'label' => 'select_checkbox_3 icons, description', 'config' => [ 'type' => 'select', 'renderType' => 'selectCheckBox', 'items' => [ [ 'label' => 'foo 1', 'value' => 1, 'description' => [ 'title' => 'optional title', 'description' => 'optional description', ], ], [ 'label' => 'foo 2', 'value' => 2, 'icon' => 'EXT:styleguide/Resources/Public/Icons/tx_styleguide.svg', 'description' => 'LLL:EXT:styleguide/Resources/Private/Language/locallang.xlf:translatedHelpTextForSelectCheckBox3', ], [ 'label' => 'foo 3', 'value' => 3, 'icon' => 'EXT:styleguide/Resources/Public/Icons/tx_styleguide.svg', ], [ 'label' => 'foo 4', 'value' => 4, ], ], ], ], ], ]
Copied!
itemsProcFunc
-
- Type
- string (class->method reference)
- Path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']
- Scope
- Display / Proc.
PHP method which is called to fill or manipulate the items array. See itemsProcFunc about details.
maxitems
-
- Type
- integer > 0
- Path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']
- 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.
minitems
-
- Type
- integer > 0
- Path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']
- 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.
MM
-
- Type
- string (table name)
- Path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']
- 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.
MM_match_fields
-
- Type
- array
- Path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']
- Scope
- Display / Proc.
Array of field => value pairs to both insert and match against when writing/reading MM relations.
MM_opposite_field
-
- Type
- string (field name)
- Path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']
- 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
MM_oppositeUsage
-
- Type
- array
- Path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']
- 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
MM_table_where
-
- Type
- string (SQL WHERE)
- Path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']
- 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.
MM_hasUidField
-
Changed in version 13.0
This setting is obsolete. Remove all occurrences of
MM_
from TCA. Thehas Uid Field uid
column is added as primary key automatically, ifmultiple = true
is set, otherwise a combined primary key of fieldsuid_
,local uid_
plus eventuallyforeign tablenames
andfieldname
is used.
multiple
-
- Type
- boolean
- Path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']
- Scope
- Display / Proc.
Allows the same item more than once in a list.
If used with bidirectional MM relations it must be set for both the native and foreign field configuration.
Changed in version 13.0
The property MM_hasUidField is obsolete. It had to be defined previously when using
multiple
.
readOnly
-
- Type
- boolean
- 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.
size
-
- Type
- integer
- Path
- $GLOBALS['TCA'][$table]['columns'][$field]['config']
- Scope
- Display
Size of the input field.