IRRE / inline

New in version 13.0

TYPO3 generates the correct database fields for the inline type. Developers do not need to define this field in an extension ext_tables.sql file.

Inline Relational Record Editing (IRRE) is a convenient way of editing parent-child relations in the backend. New child records can be created directly in the backend view (by AJAX call, so that the backend view is not reloaded).

The database field is generated automatically.

Note

Inline fields should not be used to handle files. Use TCA column type file.

The 'inline' TCA type is a powerful element that handles links between records. It can handle 1:n, nested 1:n-1:n and m:n relations and the different views and localizations. When used with 'ctrl' and 'types' properties, many different backend views are possible.

The inline type is mainly used to handle 1:n relations (1 to many), where one parent record has many children and each child has only one parent. A child record cannot be moved between parents.

However, the inline type can also be used for m:n relations (many to many). An m:n relation is where a child has many parents. The relation is set up using an intermediate table. The intermediate table contains the parent and child relation fields as well as any extra fields providing additional information about the relation. One example of this is "FAL" / resource handling in the Core. A parent record (in table "tt_content") is linked to a media resource in "sys_file" via the intermediate table "sys_file_reference". The sys_file child record has itself table "sys_file_metadata" as a child record holding meta information about the file (for example, a description). This information can be overwritten for a file resource used by "tt_content" by adding a new description in "sys_file_reference". TCA properties such as "placeholders" can be used to set this up.

Hint

The inline type does not have fieldInformation, fieldControl or fieldWizard properties like other types because it is a container rather than an element. You can still add fieldInformation or fieldWizard, but they must be configured in the ctrl. See example.

Table of contents:

Properties of the TCA column type `inline`

Name	Type	Scope
appearance	array	Display
collapseAll	boolean	Display
expandSingle	boolean	Display
showNewRecordLink	boolean	Display
newRecordLinkAddTitle	boolean
newRecordLinkTitle	plain text label or label reference
createNewRelationLinkTitle	plain text label or label reference
levelLinksPosition	string
useCombination	boolean
suppressCombinationWarning	boolean
useSortable	boolean
showPossibleLocalizationRecords	boolean
showAllLocalizationLink	boolean
showSynchronizationLink	boolean
enabledControls	array
showPossibleRecordsSelector	boolean
elementBrowserEnabled	boolean
autoSizeMax	integer	Display
behaviour
allowLanguageSynchronization	boolean	Proc.
disableMovingChildrenWithParent	boolean	Proc.
enableCascadingDelete	boolean	Proc.
customControls	array	Display
filter	array	Display / Proc.
foreign_default_sortby	string	Display
foreign_field	string	Display / Proc.
foreign_label	string	Display / Proc.
foreign_match_fields	array	Proc.
foreign_selector	string	Display / Proc.
foreign_sortby	string	Display / Proc.
foreign_table	string (table name)	Display / Proc.
foreign_table_field	string	Display / Proc.
foreign_unique	string	Display / Proc.
maxitems	integer > 0	Display / Proc.
minitems	integer > 0	Display
MM	string (table name)	Proc.
MM_opposite_field	string (field name)	Proc.
overrideChildTca	array	Display
relationship	string	Proc.
size	integer	Display
symmetric_field	string	Display / Proc.
symmetric_label	string	Display / Proc.
symmetric_sortby	string	Display / Proc.

appearance

Type: array
TCA path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['appearance']
Scope: Display

Has information about the appearance of child records, namely:

collapseAll

Type: boolean
TCA path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['appearance']['collapseAll']
Scope: Display

Show all child records collapsed (if false, all are expanded)

expandSingle

Type: boolean
TCA path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['appearance']['expandSingle']
Scope: Display

Show only one child record expanded at a time. If a collapsed record is clicked, the currently open record collapses and the clicked on one expands.

showNewRecordLink

Type: boolean
Default: True
TCA path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['appearance']['showNewRecordLink']
Scope: Display

Disables the New record link in TCA inline elements without simultaneously disabling the + button in the header of each inline record (using ['appearance']['enabledControls']['new']).

newRecordLinkAddTitle

Type: boolean
TCA path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['appearance']['newRecordLinkAddTitle']

Adds the title of the foreign_table to the "New record" link.

false: "Create new"
true: "Create new <title of foreign_table>", e.g. "Create new address"

newRecordLinkTitle

Type: plain text label or label reference
TCA path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['appearance']['newRecordLinkTitle']

Overrides the title of the "New record" link with a localized string. This will work only if newRecordLinkAddTitle is not set to true.

Example:

'newRecordLinkTitle' => 'LLL:my_extension.db:my_new_record_label',

createNewRelationLinkTitle

Type: plain text label or label reference
TCA path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['appearance']['createNewRelationLinkTitle']

Overrides the link text and title of the "Create new relation" button with a localised string. Only useful if the element browser is enabled. This is usually used together with FAL relations to change it to "Add file" or similar.

levelLinksPosition

Type: string
TCA path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['appearance']['levelLinksPosition']
Values: 'top' (default), 'bottom', 'both'.

Defines where to show the "New record" link in relation to the child records. Value 'none' is no longer supported, use showAllLocalizationLink, showSynchronizationLink and showNewRecordLink with value false instead.

useCombination

Type: boolean
TCA path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['appearance']['useCombination']

This is only useful on bidirectional relations using an intermediate table with attributes. In a "combination" it is possible to edit the attributes AND the related child record itself. If using a foreign_selector, the foreign_unique property must be set to the same field as the foreign_selector.

suppressCombinationWarning

Type: boolean
Default: false
TCA path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['appearance']['suppressCombinationWarning']

Suppresses the warning flash message that will be displayed when using useCombination. You can also override the message with your own message using the example below.

        EXT:my_extension/Configuration/TCA/Overrides/126-tx_myextension_conference-registrations.php
    

<?php

use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;

defined('TYPO3') or die();

ExtensionManagementUtility::addTCAcolumns('tx_myextension_conference', [
  'registrations' => [
    'label' => 'my_extension.db:conference.registrations',
    'config' => [
      'type' => 'inline',
      'foreign_table' => 'tx_myextension_registration',
      'foreign_field' => 'conference',
      'foreign_selector' => 'attendee',
      'foreign_unique' => 'attendee',
      'foreign_match_fields' => [
        'status' => 'confirmed',
      ],
      'appearance' => [
        'useCombination' => true,
        'overwriteCombinationWarningMessage' => 'my_extension.db:conference.registrations.combinationWarning',
      ],
      'overrideChildTca' => [
        'columns' => [
          'attendee' => [
            'config' => [
              // The frontend users are stored in the same folder as the conferences
              'elementBrowserEntryPoints' => [
                'fe_users' => '###CURRENT_PID###',
              ],
            ],
          ],
        ],
      ],
    ],
  ],
]);
ExtensionManagementUtility::addToAllTCAtypes(
  'tx_myextension_conference',
  '--div--;my_extension.db:tab.registrations, registrations',
  '',
  'before:--div--;my_extension.db:tab.details',
);

useSortable

Type: boolean
TCA path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['appearance']['useSortable']

Activate drag & drop sorting.

showPossibleLocalizationRecords

Type: boolean
TCA path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['appearance']['showPossibleLocalizationRecords']

Show unlocalized records which are in the original language but not yet localized.

showAllLocalizationLink

Type: boolean
TCA path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['appearance']['showAllLocalizationLink']

Defines whether to show the "localize all records" link to fetch untranslated records from the original language.

showSynchronizationLink

Type: boolean
TCA path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['appearance']['showSynchronizationLink']

Defines whether to show a "synchronize" link to update to a 1:1 translation with the original language.

enabledControls

Type: array
TCA path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['appearance']['enabledControls']

Associative array with keys 'info', 'new', 'dragdrop', 'sort', 'hide', 'delete', 'localize'. If a value is set to a boolean (true or false), the respective control is shown/hidden in the record header.

showPossibleRecordsSelector

Type: boolean
TCA path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['appearance']['showPossibleRecordsSelector']

Can be used to hide the foreign record selector from the interface, even if you have a foreign_selector configured. This can be used to keep the technical functionality of the foreign_selector but is useful if you want to replace it with your own implementation using a custom control, see customControls.

elementBrowserEnabled

Type: boolean
TCA path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['appearance']['elementBrowserEnabled']

Hides or displays the element browser button in inline records

autoSizeMax

Type: integer
TCA path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['autoSizeMax']
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 autoSizeMax.

Note

Only has an effect if maxitems is greater than 1.

behaviour

allowLanguageSynchronization

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_state. It tells the DataHandler which fields of the localization records should be kept in sync if the underlying default or source record changes.

        EXT:my_extension/Configuration/TCA/Overrides/159-tx_myextension_conference-content_elements.php
    

<?php

use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;

defined('TYPO3') or die();

ExtensionManagementUtility::addTCAcolumns('tx_myextension_conference', [
  'content_elements' => [
    'label' => 'my_extension.db:conference.content_elements',
    'config' => [
      'type' => 'inline',
      'foreign_table' => 'tt_content',
      'foreign_field' => 'tx_myextension_conference',
      'behaviour' => [
        'allowLanguageSynchronization' => true,
      ],
      'overrideChildTca' => [
        'columns' => [
          'CType' => [
            'config' => [
              'default' => 'text',
            ],
          ],
        ],
        'types' => [
          'text' => [
            'showitem' => 'CType, header, bodytext',
          ],
        ],
      ],
    ],
  ],
]);
ExtensionManagementUtility::addToAllTCAtypes(
  'tx_myextension_conference',
  'content_elements',
  '',
  'before:--div--;core.form.tabs:categories',
);

disableMovingChildrenWithParent

Type: boolean
TCA path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['behaviour']['disableMovingChildrenWithParent']
Scope: Proc.

Default false. Disables that child records get moved along with their parent records. Usually if in a parent-child relation a parent record is moved to a different page (eg. via cut+paste from clipboard), the children are relocated along with the parent. This flag disables the child move.

This property can be especially useful if all child records should be gathered in one storage folder and their parents are spread out at different places in the page tree. In combination with the Tsconfig setting TCAdefaults.<table>.pid = <page id> children can be forced to be created in this folder and stay there.

enableCascadingDelete

Type: boolean
TCA path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['behaviour']['enableCascadingDelete']
Scope: Proc.

Default true. Usually in inline relations, if a parent is deleted, all children are deleted along with the parent. This flag can be used to disable that cascading delete. Example usage: A frontend user (parent) has assigned invoices (children). If a frontend user is deleted, it could be useful to keep the invoices.

customControls

Type: array
TCA path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['customControls']
Scope: Display

Numerical array containing definitions of custom header controls for IRRE fields. This makes it possible to create special controls by calling user-defined functions (userFuncs). Each item in the array item must be an array itself, with at least on key "userFunc" pointing to the user function to call.

The userFunc string is defined as usual in TYPO3 as ['class']->['method'], e.g.:

MyClass::class . '->myUserFuncMethod'

For more details, see the implementation in TYPO3\\CMS\\Backend\\Form\\Container\\InlineControlContainer and search for "customControls".

filter

Type: array
TCA path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['filter']
Scope: Display / Proc.

Possibility to define user functions to filter out child items.

This is useful in special scenarios when used in conjunction with a foreign_selector where only certain foreign records are allowed to be related to.

For further documentation on this feature, see the "filter" documentation under TYPE: "group".

foreign_default_sortby

Type: string
TCA path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['foreign_default_sortby']
Scope: Display

If a field name for foreign_sortby is defined, then this is ignored. Otherwise, this is used as the "ORDER BY" statement to sort the records in the table when listed.

foreign_field

Type: string
TCA path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['foreign_field']
Scope: Display / Proc.

The foreign_field is the field of the child record pointing to the parent record. This defines where to store the uid of the parent record.

foreign_label

Type: string
TCA path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['foreign_label']
Scope: Display / Proc.

Insert the fieldname of the inline element, that you want to have as the title of the inline element. E.g. 'header'. If set, it overrides the label set in $GLOBALS['TCA'][<foreign_table>]['ctrl']['label'] for the inline-view.

foreign_match_fields

Type: array
TCA path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['foreign_match_fields']
Scope: Proc.

Array of field-value pairs to both insert and match against when writing/reading IRRE relations. Using the match fields, it is possible to re-use the same child table in more than one field of the parent table by using a match field with different values for each of the use cases.

Examples

A conference has two fields of type "inline", registrations and waiting_list. Both contain registrations. The field status of the registration, which the form does not show, keeps them apart:

        EXT:my_extension/Configuration/TCA/Overrides/126-tx_myextension_conference-registrations.php
    

<?php

use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;

defined('TYPO3') or die();

ExtensionManagementUtility::addTCAcolumns('tx_myextension_conference', [
  'registrations' => [
    'label' => 'my_extension.db:conference.registrations',
    'config' => [
      'type' => 'inline',
      'foreign_table' => 'tx_myextension_registration',
      'foreign_field' => 'conference',
      'foreign_selector' => 'attendee',
      'foreign_unique' => 'attendee',
      'foreign_match_fields' => [
        'status' => 'confirmed',
      ],
      'appearance' => [
        'useCombination' => true,
        'overwriteCombinationWarningMessage' => 'my_extension.db:conference.registrations.combinationWarning',
      ],
      'overrideChildTca' => [
        'columns' => [
          'attendee' => [
            'config' => [
              // The frontend users are stored in the same folder as the conferences
              'elementBrowserEntryPoints' => [
                'fe_users' => '###CURRENT_PID###',
              ],
            ],
          ],
        ],
      ],
    ],
  ],
]);
ExtensionManagementUtility::addToAllTCAtypes(
  'tx_myextension_conference',
  '--div--;my_extension.db:tab.registrations, registrations',
  '',
  'before:--div--;my_extension.db:tab.details',
);

        EXT:my_extension/Configuration/TCA/Overrides/127-tx_myextension_conference-waiting_list.php
    

<?php

use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;

defined('TYPO3') or die();

ExtensionManagementUtility::addTCAcolumns('tx_myextension_conference', [
  'waiting_list' => [
    'label' => 'my_extension.db:conference.waiting_list',
    'config' => [
      'type' => 'inline',
      // The same table as the registrations, kept apart by the status
      'foreign_table' => 'tx_myextension_registration',
      'foreign_field' => 'conference',
      'foreign_selector' => 'attendee',
      'foreign_unique' => 'attendee',
      'foreign_match_fields' => [
        'status' => 'waiting',
      ],
    ],
  ],
]);
ExtensionManagementUtility::addToAllTCAtypes(
  'tx_myextension_conference',
  'waiting_list',
  '',
  'after:registrations',
);

If the match field is made editable, for instance as a select drop-down of two values, the relation would switch between the two parent fields after change and save. If an editor changed the status of a registration from "waiting" to "confirmed", the registration would move from the waiting list to the registrations on save.

foreign_selector

Type: string
TCA path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['foreign_selector']
Scope: Display / Proc.

A selector is used to show all possible child records that could be used to create a relation with the parent record. It will be rendered as a multi-select-box. On clicking on an item inside the selector a new relation is created. The foreign_selector points to a field of the foreign_table that is responsible for providing a selector-box – this field on the foreign_table usually is of type select and also has a foreign_table defined.

In most cases you must assign the field uid_local to the foreign_selector. This field name is used as a convention for the child record of the intermediate table. The automatic generation of MM tables also uses this field name. It depends whether uid_local of the MM table points to the opposite table (of the perspective of your inline field). In case of the opposite direction the field name uid_foreign is usually used.

Using a group field as foreign selector

The field referenced by foreign_selector can also be of type group. The child records are then selected from the table defined in its allowed option. Only one table is supported here: if allowed lists several tables, only the first one is used.

A conference lists its registrations. Each registration refers to a frontend user, and the intermediate table stores the ticket of this user. The group field attendee of the intermediate table is the selector: an editor picks a frontend user, and a new registration is created for it:

        EXT:my_extension/Configuration/TCA/Overrides/126-tx_myextension_conference-registrations.php
    

<?php

use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;

defined('TYPO3') or die();

ExtensionManagementUtility::addTCAcolumns('tx_myextension_conference', [
  'registrations' => [
    'label' => 'my_extension.db:conference.registrations',
    'config' => [
      'type' => 'inline',
      'foreign_table' => 'tx_myextension_registration',
      'foreign_field' => 'conference',
      'foreign_selector' => 'attendee',
      'foreign_unique' => 'attendee',
      'foreign_match_fields' => [
        'status' => 'confirmed',
      ],
      'appearance' => [
        'useCombination' => true,
        'overwriteCombinationWarningMessage' => 'my_extension.db:conference.registrations.combinationWarning',
      ],
      'overrideChildTca' => [
        'columns' => [
          'attendee' => [
            'config' => [
              // The frontend users are stored in the same folder as the conferences
              'elementBrowserEntryPoints' => [
                'fe_users' => '###CURRENT_PID###',
              ],
            ],
          ],
        ],
      ],
    ],
  ],
]);
ExtensionManagementUtility::addToAllTCAtypes(
  'tx_myextension_conference',
  '--div--;my_extension.db:tab.registrations, registrations',
  '',
  'before:--div--;my_extension.db:tab.details',
);

EXT:my_extension/Configuration/TCA/tx_myextension_registration.php

<?php

return [
  'ctrl' => [
    'title' => 'my_extension.db:registration',
    'label' => 'attendee',
    'label_alt' => 'ticket',
    'label_alt_force' => true,
    'hideTable' => true,
    'tstamp' => 'tstamp',
    'crdate' => 'crdate',
    'delete' => 'deleted',
    'versioningWS' => true,
    'iconfile' => 'EXT:my_extension/Resources/Public/Icons/Registration.svg',
  ],
  'columns' => [
    'attendee' => [
      'label' => 'my_extension.db:registration.attendee',
      'config' => [
        'type' => 'group',
        'allowed' => 'fe_users',
        'minitems' => 1,
        'maxitems' => 1,
      ],
    ],
    'ticket' => [
      'label' => 'my_extension.db:registration.ticket',
      'config' => [
        'type' => 'select',
        'renderType' => 'selectSingle',
        'items' => [
          ['label' => 'my_extension.db:registration.ticket.regular', 'value' => 'regular'],
          ['label' => 'my_extension.db:registration.ticket.student', 'value' => 'student'],
          ['label' => 'my_extension.db:registration.ticket.speaker', 'value' => 'speaker'],
        ],
      ],
    ],
  ],
  'types' => [
    '0' => [
      'showitem' => 'attendee, ticket',
    ],
  ],
];

The table fe_users needs no field for the relation.

Without an attribute such as the role, an intermediate table is not needed: a group or select field with an MM table on the event does the job.

With useCombination, the frontend user itself can be edited inside each registration. Such an edit changes the frontend user everywhere it is used, not only for this conference.

foreign_sortby

Type: string
TCA path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['foreign_sortby']
Scope: Display / Proc.

Define a field on the child record that stores the manual sorting information. It is possible to have a different sorting, depending from which side of the relation we look at parent or child.

Attention

Do not confuse this property with foreign_default_sortby. The foreign_sortby field contains an integer and is managed by the DataHandler. If by accident a content column like "title" is set as foreign_sortby, the DataHandler will write these integers into that field, which is most likely not what you want. Use foreign_default_sortby in this case.

This property requires that the foreign_field approach is used.

When using MM relations the field used on the intermediate table is hardcoded to sorting_foreign. Setting this property has no effect combined with an MM table.

Warning

If you use the table only as an inline element, do not put the sortby field in the ctrl section, otherwise TYPO3 CMS will sort the entire table with every update. For example, if you have 10000 records, each with 4 inline elements, TYPO3 CMS will sort 40000 records even if only 4 must be sorted.

foreign_table

Type: string (table name)
Required: true
TCA path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['foreign_table']
Scope: Display / Proc.

The table name of the child records is defined here. The table must be configured in $GLOBALS['TCA'].

foreign_table_field

Type: string
TCA path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['foreign_table_field']
Scope: Display / Proc.

The foreign_table_field is the field of the child record pointing to the parent record. This defines where to store the table name of the parent record. On setting this configuration key together with foreign_field, the child record knows what its parent record is – so the child record could also be used on other parent tables. This issue is also known as "weak entity". Do not confuse with foreign_table or foreign_field. It has its own behavior.

foreign_unique

Type: string
TCA path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['foreign_unique']
Scope: Display / Proc.

Field which must be unique for all children of a parent record.

Example

A frontend user can register for a conference only once. foreign_unique names the field attendee of the registration, so the same frontend user cannot be selected twice:

        EXT:my_extension/Configuration/TCA/Overrides/126-tx_myextension_conference-registrations.php
    

<?php

use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;

defined('TYPO3') or die();

ExtensionManagementUtility::addTCAcolumns('tx_myextension_conference', [
  'registrations' => [
    'label' => 'my_extension.db:conference.registrations',
    'config' => [
      'type' => 'inline',
      'foreign_table' => 'tx_myextension_registration',
      'foreign_field' => 'conference',
      'foreign_selector' => 'attendee',
      'foreign_unique' => 'attendee',
      'foreign_match_fields' => [
        'status' => 'confirmed',
      ],
      'appearance' => [
        'useCombination' => true,
        'overwriteCombinationWarningMessage' => 'my_extension.db:conference.registrations.combinationWarning',
      ],
      'overrideChildTca' => [
        'columns' => [
          'attendee' => [
            'config' => [
              // The frontend users are stored in the same folder as the conferences
              'elementBrowserEntryPoints' => [
                'fe_users' => '###CURRENT_PID###',
              ],
            ],
          ],
        ],
      ],
    ],
  ],
]);
ExtensionManagementUtility::addToAllTCAtypes(
  'tx_myextension_conference',
  '--div--;my_extension.db:tab.registrations, registrations',
  '',
  'before:--div--;my_extension.db:tab.details',
);

maxitems

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.

minitems

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']['MM'] 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)
TCA path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['MM']
Scope: Proc.

This value contains the name of the table in which to store an 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.

Warning

Copying with MM relations will not create a copy of the value. Thus copying the record Org with Org->orgA and Org->orgB as New results in New->orgA and New->orgB instead of New->newA and New->newB. Deleting the relation New->orgA will result in a broken relation Org->orgA.

MM_opposite_field

Type: string (field name)
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_opposite_field on the foreign side to the field name on the local side.

For example, if the field companies.employees is your local side and you want to make the same relation editable from the foreign side of the relation in a field called persons.employers, you would need to set the MM_opposite_field value of the TCA configuration of the persons.employers field to the string "employees".

Note

Bidirectional references only get registered once on the native side in sys_refindex.

Example: Inline field with MM table configured

The hotels that a conference recommends are stored in an intermediate table:

        EXT:my_extension/Configuration/TCA/Overrides/158-tx_myextension_conference-hotels.php
    

<?php

use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;

defined('TYPO3') or die();

ExtensionManagementUtility::addTCAcolumns('tx_myextension_conference', [
  'hotels' => [
    'label' => 'my_extension.db:conference.hotels',
    'config' => [
      'type' => 'inline',
      'foreign_table' => 'tx_myextension_hotel',
      'MM' => 'tx_myextension_conference_hotel_mm',
      'appearance' => [
        'collapseAll' => true,
      ],
    ],
  ],
]);
ExtensionManagementUtility::addToAllTCAtypes(
  'tx_myextension_conference',
  'hotels',
  '',
  'before:--div--;core.form.tabs:categories',
);

Example: Opposite field to display MM relations two ways

A hotel shows the conferences that recommend it:

        EXT:my_extension/Configuration/TCA/Overrides/950-tx_myextension_hotel-conferences.php
    

<?php

use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;

defined('TYPO3') or die();

ExtensionManagementUtility::addTCAcolumns('tx_myextension_hotel', [
  'conferences' => [
    'label' => 'my_extension.db:hotel.conferences',
    'config' => [
      'type' => 'inline',
      'foreign_table' => 'tx_myextension_conference',
      'MM' => 'tx_myextension_conference_hotel_mm',
      // The other side of the hotels of a conference
      'MM_opposite_field' => 'hotels',
      'appearance' => [
        'collapseAll' => true,
      ],
    ],
  ],
]);
ExtensionManagementUtility::addToAllTCAtypes(
  'tx_myextension_hotel',
  'conferences',
  '',
  'after:city',
);

overrideChildTca

Type: array
TCA path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['overrideChildTca']
Scope: Display

This property can be used to override certain aspects of the child's TCA if that child record is opened inline of the given parent. Display related TCA properties of the child table can be overridden in types and columns section.

relationship

Type: string
TCA path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['relationship']
Scope: Proc.
Added: 13.3

Defines whether the field holds one child record or several. This decides which value a Record object provides for this field, for example in a Fluid template.

oneToOne, manyToOne: The field provides a single Record object, or null if there is no child record. maxitems is set to 1 automatically, overriding any other value.
oneToMany: The field provides a LazyRecordCollection of Record objects.

If relationship is not set, the field also provides a collection. So does a field with MM, whatever relationship says. Any other value, including manyToMany, throws an exception unless MM is set.

maxitems does not change the result the other way round: a field without relationship still provides a collection, even if maxitems is 1.

The organizers answer a comment once. Their reply is a comment, too, so a comment holds one inline comment:

The field "Reply of the organizers" with one collapsed comment "The organizers (2027-05-12)" and the counter "1/1 Reply of the organizers" — A comment with the reply of the organizers

        EXT:my_extension/Configuration/TCA/Overrides/525-tx_myextension_comment-reply.php
    

<?php

use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;

defined('TYPO3') or die();

ExtensionManagementUtility::addTCAcolumns('tx_myextension_comment', [
  'reply' => [
    'label' => 'my_extension.db:comment.reply',
    'config' => [
      'type' => 'inline',
      // The reply of the organizers is a comment, too. Its parent is the
      // comment that it answers
      'foreign_table' => 'tx_myextension_comment',
      'foreign_field' => 'parent',
      'foreign_table_field' => 'parent_table',
      // The organizers answer a comment once
      'relationship' => 'oneToOne',
      'overrideChildTca' => [
        'types' => [
          '0' => [
            'showitem' => 'name, content',
          ],
        ],
        // Only a reply offers the prepared answers
        'columns' => [
          'content' => [
            'config' => [
              'valuePicker' => [
                'items' => [
                  [
                    'label' => 'my_extension.db:comment.reply.thanks',
                    'value' => 'Thank you for your feedback.',
                  ],
                  [
                    'label' => 'my_extension.db:comment.reply.recordings',
                    'value' => 'The recordings are online one week after the conference.',
                  ],
                ],
              ],
            ],
          ],
        ],
      ],
    ],
  ],
]);
ExtensionManagementUtility::addToAllTCAtypes(
  'tx_myextension_comment',
  'reply',
  '',
  'after:content',
);

size

Type: integer
TCA path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['size']
Scope: Display

Only useful in combination with foreign_selector.

If set to 1 (default), the combination box is a select drop-down, else a select box of given size.

symmetric_field

Type: string
TCA path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['symmetric_field']
Scope: Display / Proc.

This works like foreign_field, but in case of using bidirectional symmetric relations. symmetric_field defines in which field on the foreign_table the uid of the "other" parent is stored.

Example

        EXT:my_extension/Configuration/TCA/Overrides/128-tx_myextension_conference-partners.php
    

<?php

use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;

defined('TYPO3') or die();

ExtensionManagementUtility::addTCAcolumns('tx_myextension_conference', [
  'partners' => [
    'label' => 'my_extension.db:conference.partners',
    'config' => [
      'type' => 'inline',
      'foreign_table' => 'tx_myextension_partnership',
      'foreign_field' => 'conference',
      'foreign_sortby' => 'conference_sorting',
      'foreign_label' => 'partner',
      'symmetric_field' => 'partner',
      'symmetric_sortby' => 'partner_sorting',
      'symmetric_label' => 'conference',
    ],
  ],
]);
ExtensionManagementUtility::addToAllTCAtypes(
  'tx_myextension_conference',
  'partners',
  '',
  'after:speakers',
);

symmetric_label

Type: string
TCA path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['symmetric_label']
Scope: Display / Proc.

If set, it overrides the label set in $GLOBALS['TCA'][<foreign_table>]['ctrl']['label'] for the inline-view and only if looking to a symmetric relation from the "other" side.

symmetric_sortby

Type: string
TCA path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['symmetric_sortby']
Scope: Display / Proc.

This works like foreign_sortby, but in case of using bidirectional symmetric relations. Each side of a symmetric relation could have its own sorting, so symmetric_sortby defines a field on the foreign_table where the sorting of the "other" side is stored. This property requires that the foreign_field approach is used.

Inline fields and workspaces

Deprecated since version 14.0

Using a workspace-aware parent table with a child table that is not workspace-aware is deprecated in TYPO3 v14. The automatic TCA migration functionality scans for this and adds versioningWS = true; to affected child tables.

TCA tables that are used as inline child tables in a standard foreign_table relationship must be declared workspace-aware if the parent table is workspace-aware. A typical scenario is inline child tables attached to the tt_content table as tt_content is workspace-aware by default.

The conferences are workspace-aware:

EXT:my_extension/Configuration/TCA/tx_myextension_conference.php

<?php

return [
  'ctrl' => [
    'title' => 'my_extension.db:conference',
    'label' => 'title',
    'descriptionColumn' => 'internal_notes',
    'default_sortby' => 'conference_date DESC',
    'tstamp' => 'tstamp',
    'crdate' => 'crdate',
    'delete' => 'deleted',
    'editlock' => 'editlock',
    'enablecolumns' => [
      'disabled' => 'hidden',
      'starttime' => 'starttime',
      'endtime' => 'endtime',
      'fe_group' => 'fe_group',
    ],
    'languageField' => 'sys_language_uid',
    'transOrigPointerField' => 'l10n_parent',
    'transOrigDiffSourceField' => 'l10n_diffsource',
    'translationSource' => 'l10n_source',
    'versioningWS' => true,
    'origUid' => 't3_origuid',
    'iconfile' => 'EXT:my_extension/Resources/Public/Icons/Conference.svg',
    'security' => [
      'ignorePageTypeRestriction' => true,
    ],
  ],
  'columns' => [
    'title' => [
      'label' => 'my_extension.db:conference.title',
      'config' => [
        'type' => 'input',
        'required' => true,
        'max' => 255,
        'eval' => 'trim',
      ],
    ],
    'conference_date' => [
      'label' => 'my_extension.db:conference.conference_date',
      'config' => [
        'type' => 'datetime',
        'format' => 'date',
        'required' => true,
      ],
    ],
    'internal_notes' => [
      'label' => 'my_extension.db:conference.internal_notes',
      'config' => [
        'type' => 'text',
        'rows' => 3,
      ],
    ],
  ],
  // The fields of the other tabs are added in Configuration/TCA/Overrides/
  'types' => [
    '0' => [
      'showitem' => '
        title, conference_date,
        --div--;my_extension.db:tab.program,
        --div--;my_extension.db:tab.details,
        --div--;core.form.tabs:categories,
        --div--;core.form.tabs:access,
          hidden, --palette--;;access, fe_group, editlock,
        --div--;core.form.tabs:language,
          --palette--;;language,
        --div--;my_extension.db:tab.comments,
        --div--;core.form.tabs:notes,
          internal_notes,
      ',
    ],
  ],
  'palettes' => [
    'access' => [
      'label' => 'core.form.palettes:access',
      // The labels of the fields tell the editors what the dates are for
      'showitem' => '
        starttime;my_extension.db:conference.starttime,
        endtime;my_extension.db:conference.endtime,
      ',
    ],
    'language' => [
      'showitem' => 'sys_language_uid, l10n_parent',
    ],
  ],
];

If the parent table is workspace-aware, versioningWS set to true, the child table must also be made workspace-aware. The hotels are inline children of the conferences:

EXT:my_extension/Configuration/TCA/tx_myextension_hotel.php

<?php

return [
  'ctrl' => [
    'title' => 'my_extension.db:hotel',
    'label' => 'name',
    'label_alt' => 'city',
    'label_alt_force' => true,
    'default_sortby' => 'name',
    'tstamp' => 'tstamp',
    'crdate' => 'crdate',
    'delete' => 'deleted',
    // Required, as the hotels are inline children of the conferences
    'versioningWS' => true,
    'iconfile' => 'EXT:my_extension/Resources/Public/Icons/Hotel.svg',
  ],
  'columns' => [
    'name' => [
      'label' => 'my_extension.db:hotel.name',
      'config' => [
        'type' => 'input',
        'required' => true,
      ],
    ],
    'city' => [
      'label' => 'my_extension.db:hotel.city',
      'config' => [
        'type' => 'input',
      ],
    ],
  ],
  'types' => [
    '0' => [
      'showitem' => 'name, city',
    ],
  ],
];

The same applies if an inline field is used inside a FlexForm field.

Inline fields in content `tt_content` or on regular pages

If a parent table can be created on regular pages, most commonly when the inline field is created in table tt_content, the child table must also be allowed on regular pages.

Otherwise you will see the following error on saving:

Warning

Attempt to insert record on pages:42 where table "tx_myextension_registration" is not allowed.

To allow the child table on regular pages, set $GLOBALS['TCA'][$table]['ctrl']['security']['ignorePageTypeRestriction'] to true:

EXT:my_extension/Configuration/TCA/tx_myextension_conference.php

<?php

return [
  'ctrl' => [
    'title' => 'my_extension.db:conference',
    'label' => 'title',
    'descriptionColumn' => 'internal_notes',
    'default_sortby' => 'conference_date DESC',
    'tstamp' => 'tstamp',
    'crdate' => 'crdate',
    'delete' => 'deleted',
    'editlock' => 'editlock',
    'enablecolumns' => [
      'disabled' => 'hidden',
      'starttime' => 'starttime',
      'endtime' => 'endtime',
      'fe_group' => 'fe_group',
    ],
    'languageField' => 'sys_language_uid',
    'transOrigPointerField' => 'l10n_parent',
    'transOrigDiffSourceField' => 'l10n_diffsource',
    'translationSource' => 'l10n_source',
    'versioningWS' => true,
    'origUid' => 't3_origuid',
    'iconfile' => 'EXT:my_extension/Resources/Public/Icons/Conference.svg',
    'security' => [
      'ignorePageTypeRestriction' => true,
    ],
  ],
  'columns' => [
    'title' => [
      'label' => 'my_extension.db:conference.title',
      'config' => [
        'type' => 'input',
        'required' => true,
        'max' => 255,
        'eval' => 'trim',
      ],
    ],
    'conference_date' => [
      'label' => 'my_extension.db:conference.conference_date',
      'config' => [
        'type' => 'datetime',
        'format' => 'date',
        'required' => true,
      ],
    ],
    'internal_notes' => [
      'label' => 'my_extension.db:conference.internal_notes',
      'config' => [
        'type' => 'text',
        'rows' => 3,
      ],
    ],
  ],
  // The fields of the other tabs are added in Configuration/TCA/Overrides/
  'types' => [
    '0' => [
      'showitem' => '
        title, conference_date,
        --div--;my_extension.db:tab.program,
        --div--;my_extension.db:tab.details,
        --div--;core.form.tabs:categories,
        --div--;core.form.tabs:access,
          hidden, --palette--;;access, fe_group, editlock,
        --div--;core.form.tabs:language,
          --palette--;;language,
        --div--;my_extension.db:tab.comments,
        --div--;core.form.tabs:notes,
          internal_notes,
      ',
    ],
  ],
  'palettes' => [
    'access' => [
      'label' => 'core.form.palettes:access',
      // The labels of the fields tell the editors what the dates are for
      'showitem' => '
        starttime;my_extension.db:conference.starttime,
        endtime;my_extension.db:conference.endtime,
      ',
    ],
    'language' => [
      'showitem' => 'sys_language_uid, l10n_parent',
    ],
  ],
];

Inline fields on root level tables

If a parent table can be or is always created on root level, the child table has to also be allowed on root level.

An example of this is if you add an inline field to system tables like sys_file_metadata or be_users.

Set $GLOBALS['TCA'][$table]['ctrl']['rootLevel'] to -1 to allow on both root level and regular pages or set to 1 to allow only on root level.

If regular non-admin backend users need to be able to edit the table, add $GLOBALS['TCA'][$table]['ctrl']['security']['ignoreRootLevelRestriction']

EXT:my_extension/Configuration/TCA/tx_myextension_location.php

<?php

return [
  'ctrl' => [
    'title' => 'my_extension.db:location',
    'label' => 'name',
    'label_alt' => 'city',
    'label_alt_force' => true,
    'selicon_field' => 'image',
    'default_sortby' => 'name',
    'rootLevel' => -1,
    'security' => [
      'ignoreRootLevelRestriction' => true,
    ],
    'tstamp' => 'tstamp',
    'crdate' => 'crdate',
    'delete' => 'deleted',
    'iconfile' => 'EXT:my_extension/Resources/Public/Icons/Location.svg',
  ],
  'columns' => [
    'name' => [
      'label' => 'my_extension.db:location.name',
      'config' => [
        'type' => 'input',
        'required' => true,
      ],
    ],
    'city' => [
      'label' => 'my_extension.db:location.city',
      'config' => [
        'type' => 'input',
      ],
    ],
    'image' => [
      'label' => 'my_extension.db:location.image',
      'config' => [
        'type' => 'file',
        'maxitems' => 1,
        'allowed' => 'common-image-types',
        'relationship' => 'manyToOne',
      ],
    ],
  ],
  'types' => [
    '0' => [
      'showitem' => 'name, city, image',
    ],
  ],
];

IRRE / inline

Properties of the TCA column type inline

Inline fields and workspaces

Inline fields in content tt_content or on regular pages

Inline fields on root level tables

Properties of the TCA column type `inline`

Inline fields in content `tt_content` or on regular pages