Uuid

The main purpose of the TCA type uuid is to simplify the TCA configuration when working with fields containing a UUID.

The according database field is generated automatically.

Table of contents

Example

An example configuration looks like the following:

<?php

$uuidField = [
    'label' => 'My record identifier',
    'config' => [
        'type' => 'uuid',
        'version' => 6,
    ],
];
Copied!

Properties of the TCA column type uuid

Name Type Scope
enableCopyToClipboard
 boolean Display
fieldInformation
required
 boolean Display / Proc.
searchable
 boolean Display
size
 integer Display
version
 integer Display

enableCopyToClipboard

enableCopyToClipboard
Type
boolean
Path
$GLOBALS['TCA'][$table]['columns'][$field]['config']
Scope
Display

In case enableCopyToClipboard is set to true, which is the default, a button is rendered next to the input field, which allows to copy the UUID to the clipboard of the operating system.

This column configuration can be overwritten by page TSconfig.

fieldInformation

fieldInformation

For details see fieldInformation.

required

required
Type
boolean
Path
$GLOBALS['TCA'][$table]['columns'][$field]['config']
Scope
Display / Proc.
Default
false

If set to true a non-empty value is required in the field. Otherwise the form cannot be saved.

searchable

searchable
Type
boolean
Path
$GLOBALS['TCA'][$table]['columns'][$field]['config']['searchable']
Scope
Display
Default
true

New in version 14.0

TYPO3 now automatically includes all fields of suitable types in backend search operations in the List module.

This option can be used to explicitly exclude fields from being searchable, instead of having to list them in the now removed option $GLOBALS['TCA'][$table]['ctrl']['searchFields'].

By default, all fields of type uuid are considered searchable. To exclude a field from being searchable, set the following in the field's TCA configuration:

packages/my_extension/Configuration/TCA/Overrides/tx_my_table.php 
$GLOBALS['TCA']['tx_my_table']['columns']['my_field'] = [
    'label' => 'My field',
    'config' => [
        'type' => 'uuid',
        'searchable' => false,
    ],
];
Copied!

size

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

Abstract value for the width of the <input> field. To set the field to the full width of the form area, use the value 50. Minimum is 10. Default is 30.

This column configuration can be overwritten by page TSconfig.

version

version
Type
integer
Path
$GLOBALS['TCA'][$table]['columns'][$field]['config']
Scope
Display

The version option defines the UUID version to be used. Allowed values are 4, 6 or 7. The default is 4. For more information about the different versions, have a look at the corresponding Symfony documentation.