CategoryRegistry.php

Go to the documentation of this file.

<?php
 
/*
 * 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\Category;
 
use ‪TYPO3\CMS\Core\Database\Event\AlterTableDefinitionStatementsEvent;
use ‪TYPO3\CMS\Core\Localization\LanguageService;
use ‪TYPO3\CMS\Core\SingletonInterface;
use ‪TYPO3\CMS\Core\Utility\ArrayUtility;
use ‪TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
class ‪CategoryRegistry implements ‪SingletonInterface
{
    protected ‪$registry = [];
 
    protected ‪$extensions = [];
 
    protected ‪$addedCategoryTabs = [];
 
    protected ‪$template = '';
 
    public static function ‪getInstance()
    {
        return GeneralUtility::makeInstance(__CLASS__);
    }
 
    public function ‪__construct()
    {
        $this->template = str_repeat(PHP_EOL, 3) . 'CREATE TABLE %s (' . PHP_EOL
            . '  %s int(11) DEFAULT \'0\' NOT NULL' . PHP_EOL . ');' . str_repeat(PHP_EOL, 3);
    }
 
    public function ‪add($extensionKey, $tableName, $fieldName = 'categories', array $options = [], $override = false)
    {
        $didRegister = false;
        if (empty($tableName) || !is_string($tableName)) {
            throw new \InvalidArgumentException('No or invalid table name "' . $tableName . '" given.', 1369122038);
        }
        if (empty($extensionKey) || !is_string($extensionKey)) {
            throw new \InvalidArgumentException('No or invalid extension key "' . $extensionKey . '" given.', 1397836158);
        }
 
        if ($override) {
            $this->remove($tableName, $fieldName);
        }
 
        if (!$this->‪isRegistered($tableName, $fieldName)) {
            $this->registry[$tableName][$fieldName] = $options;
            $this->extensions[$extensionKey][$tableName][$fieldName] = $fieldName;
 
            if (isset(‪$GLOBALS['TCA'][$tableName]['columns'])) {
                $this->‪applyTcaForTableAndField($tableName, $fieldName);
                $didRegister = true;
            }
        }
 
        return $didRegister;
    }
 
    public function ‪getExtensionKeys()
    {
        return array_keys($this->extensions);
    }
 
    public function ‪getCategorizedTables()
    {
        return array_keys($this->registry);
    }
 
    public function ‪getCategoryFieldsForTable(array &$configuration)
    {
        $table = $configuration['config']['itemsProcConfig']['table'] ?? '';
        // Return early if no table is defined
        if (empty($table)) {
            throw new \UnexpectedValueException('No table is given.', 1381823570);
        }
        // Loop on all registries and find entries for the correct table
        foreach ($this->registry as $tableName => ‪$fields) {
            if ($tableName === $table) {
                foreach (‪$fields as $fieldName => $options) {
                    $fieldLabel = $this->‪getLanguageService()->‪sL(‪$GLOBALS['TCA'][$tableName]['columns'][$fieldName]['label']);
                    $configuration['items'][] = [$fieldLabel, $fieldName];
                }
            }
        }
    }
 
    public function ‪isRegistered($tableName, $fieldName = 'categories')
    {
        return isset($this->registry[$tableName][$fieldName]);
    }
 
    public function ‪getDatabaseTableDefinitions()
    {
        $sql = '';
        foreach ($this->‪getExtensionKeys() as $extensionKey) {
            $sql .= $this->‪getDatabaseTableDefinition($extensionKey);
        }
        return $sql;
    }
 
    public function ‪getDatabaseTableDefinition($extensionKey)
    {
        if (!isset($this->extensions[$extensionKey]) || !is_array($this->extensions[$extensionKey])) {
            return '';
        }
        $sql = '';
 
        foreach ($this->extensions[$extensionKey] as $tableName => ‪$fields) {
            foreach (‪$fields as $fieldName) {
                $sql .= sprintf($this->template, $tableName, $fieldName);
            }
        }
        return $sql;
    }
 
    public function ‪applyTcaForPreRegisteredTables()
    {
        $this->‪registerDefaultCategorizedTables();
        foreach ($this->registry as $tableName => ‪$fields) {
            foreach (‪$fields as $fieldName => $_) {
                $this->‪applyTcaForTableAndField($tableName, $fieldName);
            }
        }
    }
 
    protected function ‪applyTcaForTableAndField($tableName, $fieldName)
    {
        $this->‪addTcaColumn($tableName, $fieldName, $this->registry[$tableName][$fieldName]);
        $this->‪addToAllTCAtypes($tableName, $fieldName, $this->registry[$tableName][$fieldName]);
    }
 
    protected function ‪registerDefaultCategorizedTables()
    {
        $defaultCategorizedTables = ‪GeneralUtility::trimExplode(
            ',',
            ‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['defaultCategorizedTables'],
            true
        );
        if ($defaultCategorizedTables !== []) {
            trigger_error(
                '$GLOBALS[\'TYPO3_CONF_VARS\'][\'SYS\'][\'defaultCategorizedTables\'] is deprecated and will be removed in v12. Register category fields with the TCA type "category" instead.',
                E_USER_DEPRECATED
            );
        }
        foreach ($defaultCategorizedTables as $defaultCategorizedTable) {
            if (!$this->‪isRegistered($defaultCategorizedTable)) {
                $this->‪add('core', $defaultCategorizedTable, 'categories');
            }
        }
    }
 
    protected function ‪addToAllTCAtypes($tableName, $fieldName, array $options)
    {
        // Makes sure to add more TCA to an existing structure
        if (isset(‪$GLOBALS['TCA'][$tableName]['columns'])) {
            if (empty($options['fieldList'])) {
                $fieldList = $this->‪addCategoryTab($tableName, $fieldName);
            } else {
                $fieldList = $options['fieldList'];
            }
 
            $typesList = '';
            if (isset($options['typesList']) && $options['typesList'] !== '') {
                $typesList = $options['typesList'];
            }
 
            $position = '';
            if (!empty($options['position'])) {
                $position = $options['position'];
            }
 
            // Makes the new "categories" field to be visible in TSFE.
            ‪ExtensionManagementUtility::addToAllTCAtypes($tableName, $fieldList, $typesList, $position);
        }
    }
 
    protected function ‪addCategoryTab($tableName, $fieldName)
    {
        $fieldList = '';
        if (!isset($this->addedCategoryTabs[$tableName])) {
            $fieldList .= '--div--;LLL:EXT:core/Resources/Private/Language/locallang_tca.xlf:sys_category.tabs.category, ';
            $this->addedCategoryTabs[$tableName] = $tableName;
        }
        $fieldList .= $fieldName;
        return $fieldList;
    }
 
    protected function ‪addTcaColumn($tableName, $fieldName, array $options)
    {
        // Makes sure to add more TCA to an existing structure
        if (isset(‪$GLOBALS['TCA'][$tableName]['columns'])) {
            // Take specific label into account
            $label = 'LLL:EXT:core/Resources/Private/Language/locallang_tca.xlf:sys_category.categories';
            if (!empty($options['label'])) {
                $label = $options['label'];
            }
 
            // Take specific value of exclude flag into account
            $exclude = true;
            if (isset($options['exclude'])) {
                $exclude = (bool)$options['exclude'];
            }
 
            $fieldConfiguration = empty($options['fieldConfiguration']) ? [] : $options['fieldConfiguration'];
 
            $columns = [
                $fieldName => [
                    'exclude' => $exclude,
                    'label' => $label,
                    'config' =>  static::getTcaFieldConfiguration($tableName, $fieldName, $fieldConfiguration),
                ],
            ];
 
            if (isset($options['l10n_mode'])) {
                $columns[$fieldName]['l10n_mode'] = $options['l10n_mode'];
            }
            if (isset($options['l10n_display'])) {
                $columns[$fieldName]['l10n_display'] = $options['l10n_display'];
            }
            if (isset($options['displayCond'])) {
                $columns[$fieldName]['displayCond'] = $options['displayCond'];
            }
            if (isset($options['onChange'])) {
                $columns[$fieldName]['onChange'] = $options['onChange'];
            }
 
            // Register opposite references for the foreign side of a relation
            if (empty(‪$GLOBALS['TCA']['sys_category']['columns']['items']['config']['MM_oppositeUsage'][$tableName])) {
                ‪$GLOBALS['TCA']['sys_category']['columns']['items']['config']['MM_oppositeUsage'][$tableName] = [];
            }
            if (!in_array($fieldName, ‪$GLOBALS['TCA']['sys_category']['columns']['items']['config']['MM_oppositeUsage'][$tableName])) {
                ‪$GLOBALS['TCA']['sys_category']['columns']['items']['config']['MM_oppositeUsage'][$tableName][] = $fieldName;
            }
 
            // Adding fields to an existing table definition
            ‪ExtensionManagementUtility::addTCAcolumns($tableName, $columns);
        }
    }
 
    public static function ‪getTcaFieldConfiguration($tableName, $fieldName = 'categories', array $fieldConfigurationOverride = [])
    {
        // Forges a new field, default name is "categories"
        $fieldConfiguration = [
            'type' => 'select',
            'renderType' => 'selectTree',
            'foreign_table' => 'sys_category',
            'foreign_table_where' => ' AND {#sys_category}.{#sys_language_uid} IN (-1, 0)',
            'MM' => 'sys_category_record_mm',
            'MM_opposite_field' => 'items',
            'MM_match_fields' => [
                'tablenames' => $tableName,
                'fieldname' => $fieldName,
            ],
            'size' => 20,
            'maxitems' => 9999,
            'treeConfig' => [
                'parentField' => 'parent',
                'appearance' => [
                    'expandAll' => true,
                    'showHeader' => true,
                    'maxLevels' => 99,
                ],
            ],
        ];
 
        // Merge changes to TCA configuration
        if (!empty($fieldConfigurationOverride)) {
            ‪ArrayUtility::mergeRecursiveWithOverrule(
                $fieldConfiguration,
                $fieldConfigurationOverride
            );
        }
 
        return $fieldConfiguration;
    }
 
    public function ‪addCategoryDatabaseSchema(AlterTableDefinitionStatementsEvent $event): void
    {
        $this->‪registerDefaultCategorizedTables();
        $event->addSqlData($this->‪getDatabaseTableDefinitions());
    }
 
    protected function ‪getLanguageService()
    {
        return ‪$GLOBALS['LANG'];
    }
 
    protected function remove($tableName, $fieldName)
    {
        if (!$this->‪isRegistered($tableName, $fieldName)) {
            return;
        }
 
        unset($this->registry[$tableName][$fieldName]);
 
        foreach ($this->extensions as $extensionKey => $tableFieldConfig) {
            foreach ($tableFieldConfig as $extTableName => $fieldNameArray) {
                if ($extTableName === $tableName && isset($fieldNameArray[$fieldName])) {
                    unset($this->extensions[$extensionKey][$tableName][$fieldName]);
                    break;
                }
            }
        }
 
        // If no more fields are configured we unregister the categories tab.
        if (empty($this->registry[$tableName]) && isset($this->addedCategoryTabs[$tableName])) {
            unset($this->addedCategoryTabs[$tableName]);
        }
    }
}