TcaMigration.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Core\Migrations;
 
class ‪TcaMigration
{
    protected ‪$messages = [];
 
    public function ‪migrate(array ‪$tca): array
    {
        $this->‪validateTcaType($tca);
 
        ‪$tca = $this->‪migrateColumnsConfig($tca);
        ‪$tca = $this->‪migrateLocalizeChildrenAtParentLocalization($tca);
        ‪$tca = $this->‪migratePagesLanguageOverlayRemoval($tca);
        ‪$tca = $this->‪removeSelIconFieldPath($tca);
        ‪$tca = $this->‪removeSetToDefaultOnCopy($tca);
        ‪$tca = $this->‪sanitizeControlSectionIntegrity($tca);
        ‪$tca = $this->‪removeEnableMultiSelectFilterTextfieldConfiguration($tca);
        ‪$tca = $this->‪removeExcludeFieldForTransOrigPointerField($tca);
        ‪$tca = $this->‪removeShowRecordFieldListField($tca);
        ‪$tca = $this->‪migrateSelectAuthModeIndividualItemsKeywordToNewPosition($tca);
 
        return ‪$tca;
    }
 
    public function ‪getMessages(): array
    {
        return ‪$this->messages;
    }
 
    protected function ‪validateTcaType(array ‪$tca)
    {
        foreach (‪$tca as $table => $tableDefinition) {
            if (!isset($tableDefinition['columns']) || !is_array($tableDefinition['columns'])) {
                continue;
            }
            foreach ($tableDefinition['columns'] as $fieldName => $fieldConfig) {
                if (isset($fieldConfig['config']) && is_array($fieldConfig['config']) && empty($fieldConfig['config']['type'])) {
                    throw new \UnexpectedValueException(
                        'Missing "type" in TCA of field "[\'' . $table . '\'][\'' . $fieldName . '\'][\'config\']".',
                        1482394401
                    );
                }
            }
        }
    }
 
    protected function ‪migrateColumnsConfig(array ‪$tca): array
    {
        foreach (‪$tca as $table => &$tableDefinition) {
            if (!isset($tableDefinition['columns']) || !is_array($tableDefinition['columns'])) {
                continue;
            }
            foreach ($tableDefinition['columns'] as $fieldName => &$fieldConfig) {
                if ((!isset($fieldConfig['config']) || !is_array($fieldConfig['config'])) && !isset($fieldConfig['type'])) {
                    $fieldConfig['config'] = [
                        'type' => 'none',
                    ];
                    $this->messages[] = 'TCA table "' . $table . '" columns field "' . $fieldName . '"'
                        . ' had no mandatory "config" section. This has been added with default type "none":'
                        . ' TCA "' . $table . '[\'columns\'][\'' . $fieldName . '\'][\'config\'][\'type\'] = \'none\'"';
                }
            }
        }
        return ‪$tca;
    }
 
    protected function ‪migrateLocalizeChildrenAtParentLocalization(array ‪$tca): array
    {
        foreach (‪$tca as $table => &$tableDefinition) {
            if (!isset($tableDefinition['columns']) || !is_array($tableDefinition['columns'])) {
                continue;
            }
            foreach ($tableDefinition['columns'] as $fieldName => &$fieldConfig) {
                if (($fieldConfig['config']['type'] ?? null) !== 'inline') {
                    continue;
                }
 
                $localizeChildrenAtParentLocalization = ($fieldConfig['config']['behaviour']['localizeChildrenAtParentLocalization'] ?? null);
                if ($localizeChildrenAtParentLocalization === null) {
                    continue;
                }
 
                if ($localizeChildrenAtParentLocalization) {
                    $this->messages[] = 'The TCA setting \'localizeChildrenAtParentLocalization\' is deprecated '
                        . ' and should be removed from TCA for ' . $table . '[\'columns\']'
                        . '[\'' . $fieldName . '\'][\'config\'][\'behaviour\'][\'localizeChildrenAtParentLocalization\']';
                } else {
                    $this->messages[] = 'The TCA setting \'localizeChildrenAtParentLocalization\' is deprecated '
                        . ', as this functionality is always enabled. The option should be removed from TCA for '
                        . $table . '[\'columns\'][\'' . $fieldName . '\'][\'config\'][\'behaviour\']'
                        . '[\'localizeChildrenAtParentLocalization\']';
                }
                unset($fieldConfig['config']['behaviour']['localizeChildrenAtParentLocalization']);
            }
        }
        return ‪$tca;
    }
 
    protected function ‪migratePagesLanguageOverlayRemoval(array ‪$tca)
    {
        if (isset(‪$tca['pages_language_overlay'])) {
            $this->messages[] = 'The TCA table \'pages_language_overlay\' is'
                . ' not used anymore and has been removed automatically in'
                . ' order to avoid negative side-effects.'
                . ' To ensure migration is possible, a definition still exists in sysext:frontend.'
                . ' Check your extensions for additional definitions, those need to be removed.'
                . ' You can ignore this message, when only the core definition still exists.'
            ;
            unset(‪$tca['pages_language_overlay']);
        }
        return ‪$tca;
    }
 
    protected function ‪removeEnableMultiSelectFilterTextfieldConfiguration(array ‪$tca): array
    {
        foreach (‪$tca as $table => &$tableDefinition) {
            if (!isset($tableDefinition['columns']) || !is_array($tableDefinition['columns'])) {
                continue;
            }
            foreach ($tableDefinition['columns'] as $fieldName => &$fieldConfig) {
                if (!isset($fieldConfig['config']['enableMultiSelectFilterTextfield'])) {
                    continue;
                }
 
                $this->messages[] = 'The TCA setting \'enableMultiSelectFilterTextfield\' is deprecated '
                    . ' and should be removed from TCA for ' . $table . '[\'columns\']'
                    . '[\'' . $fieldName . '\'][\'config\'][\'enableMultiSelectFilterTextfield\']';
                unset($fieldConfig['config']['enableMultiSelectFilterTextfield']);
            }
        }
        return ‪$tca;
    }
 
    protected function ‪removeSelIconFieldPath(array ‪$tca): array
    {
        foreach (‪$tca as $table => &$configuration) {
            if (isset($configuration['ctrl']['selicon_field_path'])) {
                $this->messages[] = 'The TCA table \'' . $table . '\' defines '
                    . '[ctrl][selicon_field_path] which should be removed from TCA, '
                    . 'as it is not in use anymore.';
                unset($configuration['ctrl']['selicon_field_path']);
            }
        }
        return $tca;
    }
 
    protected function removeSetToDefaultOnCopy(array $tca): array
    {
        foreach ($tca as $table => &$configuration) {
            if (isset($configuration['ctrl']['setToDefaultOnCopy'])) {
                $this->messages[] = 'The TCA table \'' . $table . '\' defines '
                    . '[ctrl][setToDefaultOnCopy] which should be removed from TCA, '
                    . 'as it is not in use anymore.';
                unset($configuration['ctrl']['setToDefaultOnCopy']);
            }
        }
        return $tca;
    }
 
    protected function sanitizeControlSectionIntegrity(array $tca): array
    {
        $controlSectionNames = [
            'origUid',
            'languageField',
            'transOrigPointerField',
            'translationSource'
        ];
        foreach ($tca as $tableName => &$configuration) {
            foreach ($controlSectionNames as $controlSectionName) {
                $columnName = $configuration['ctrl'][$controlSectionName] ?? null;
                if (empty($columnName) || !empty($configuration['columns'][$columnName])) {
                    continue;
                }
                $configuration['columns'][$columnName] = [
                    'config' => [
                        'type' => 'passthrough',
                        'default' => 0,
                    ],
                ];
            }
        }
        return $tca;
    }
 
    protected function removeExcludeFieldForTransOrigPointerField(array $tca): array
    {
        foreach ($tca as $table => &$configuration) {
            if (isset($configuration['ctrl']['transOrigPointerField'],
                $configuration['columns'][$configuration['ctrl']['transOrigPointerField']]['exclude'])
            ) {
                $this->messages[] = 'The \'' . $table . '\' TCA tables transOrigPointerField '
                    . '\'' . $configuration['ctrl']['transOrigPointerField'] . '\' is defined '
                    . ' as excluded field which is no longer needed and should therefore be removed. ';
                unset($configuration['columns'][$configuration['ctrl']['transOrigPointerField']]['exclude']);
            }
        }
 
        return $tca;
    }
 
    protected function removeShowRecordFieldListField(array $tca): array
    {
        foreach ($tca as $table => &$configuration) {
            if (!isset($configuration['interface']['showRecordFieldList'])) {
                continue;
            }
            $this->messages[] = 'The \'' . $table . '\' TCA configuration \'showRecordFieldList\''
                . ' inside the section \'interface\' is not evaluated anymore and should therefore be removed.';
            unset($configuration['interface']['showRecordFieldList']);
            if ($configuration['interface'] === []) {
                unset($configuration['interface']);
            }
        }
 
        return ‪$tca;
    }
 
    protected function ‪migrateSelectAuthModeIndividualItemsKeywordToNewPosition(array ‪$tca): array
    {
        foreach (‪$tca as $table => $tableDefinition) {
            if (!isset($tableDefinition['columns']) || !is_array($tableDefinition['columns'])) {
                continue;
            }
 
            foreach ($tableDefinition['columns'] as $fieldName => $fieldConfig) {
                if (($fieldConfig['config']['type'] ?? '') !== 'select' || ($fieldConfig['config']['authMode'] ?? '') !== 'individual') {
                    continue;
                }
 
                foreach ($fieldConfig['config']['items'] ?? [] as $index => $item) {
                    if (in_array($item[4] ?? '', ['EXPL_ALLOW', 'EXPL_DENY'], true)) {
                        ‪$tca[$table]['columns'][$fieldName]['config']['items'][$index][5] = $item[4];
                        ‪$tca[$table]['columns'][$fieldName]['config']['items'][$index][4] = '';
 
                        // This migration does not log any message
                    }
                }
            }
        }
 
        return ‪$tca;
    }
}