CategoryRegistryTest.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\Tests\Unit\Category;
 
use ‪TYPO3\CMS\Core\Category\CategoryRegistry;
use ‪TYPO3\CMS\Core\Utility\StringUtility;
use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
class ‪CategoryRegistryTest extends UnitTestCase
{
    protected ‪$subject;
 
    protected ‪$tables;
 
    protected function ‪setUp(): void
    {
        parent::setUp();
        ‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['defaultCategorizedTables'] = 'pages';
        ‪$GLOBALS['TCA']['pages']['columns'] = [];
        $this->subject = new ‪CategoryRegistry();
        $this->tables = [
            'first' => ‪StringUtility::getUniqueId('first'),
            'second' => ‪StringUtility::getUniqueId('second')
        ];
        foreach ($this->tables as $tableName) {
            ‪$GLOBALS['TCA'][$tableName] = [
                'ctrl' => [],
                'columns' => [],
                'types' => [
                    '0' => [
                        'showitem' => ''
                    ],
                    '1' => [
                        'showitem' => ''
                    ]
                ],
            ];
        }
    }
 
    public function ‪doesAddReturnTrueOnDefinedTable(): void
    {
        self::assertTrue($this->subject->add('test_extension_a', $this->tables['first'], 'categories'));
    }
 
    public function ‪doesAddReturnTrueOnDefinedTableTheFirstTimeAndFalseTheSecondTime(): void
    {
        self::assertTrue($this->subject->add('test_extension_a', $this->tables['first'], 'categories'));
        self::assertFalse($this->subject->add('test_extension_a', $this->tables['first'], 'categories'));
    }
 
    public function ‪doesAddThrowExceptionOnEmptyTablename(): void
    {
        $this->expectException(\InvalidArgumentException::class);
        $this->expectExceptionCode(1369122038);
 
        $this->subject->add('test_extension_a', '', 'categories');
    }
 
    public function ‪doesAddThrowExceptionOnEmptyExtensionKey(): void
    {
        $this->expectException(\InvalidArgumentException::class);
        $this->expectExceptionCode(1397836158);
 
        $this->subject->add('', 'foo', 'categories');
    }
 
    public function ‪doesAddThrowExceptionOnInvalidTablename(): void
    {
        $this->expectException(\InvalidArgumentException::class);
        $this->expectExceptionCode(1369122038);
 
        $this->subject->add('test_extension_a', '', 'categories');
    }
 
    public function ‪doesAddThrowExceptionOnInvalidExtensionKey(): void
    {
        $this->expectException(\InvalidArgumentException::class);
        $this->expectExceptionCode(1397836158);
 
        $this->subject->add('', 'foo', 'categories');
    }
 
    public function ‪areMultipleElementsOfSameExtensionRegistered(): void
    {
        $this->subject->add('test_extension_a', $this->tables['first'], 'categories');
        $this->subject->add('test_extension_a', $this->tables['second'], 'categories');
        $this->subject->applyTcaForPreRegisteredTables();
 
        self::assertArrayHasKey('categories', ‪$GLOBALS['TCA'][$this->tables['first']]['columns']);
        self::assertArrayHasKey('categories', ‪$GLOBALS['TCA'][$this->tables['second']]['columns']);
    }
 
    public function ‪areElementsOfDifferentExtensionsRegistered(): void
    {
        $this->subject->add('test_extension_a', $this->tables['first'], 'categories');
        $this->subject->add('test_extension_b', $this->tables['second'], 'categories');
        $this->subject->applyTcaForPreRegisteredTables();
 
        self::assertArrayHasKey('categories', ‪$GLOBALS['TCA'][$this->tables['first']]['columns']);
        self::assertArrayHasKey('categories', ‪$GLOBALS['TCA'][$this->tables['second']]['columns']);
    }
 
    public function ‪areElementsOfDifferentExtensionsOnSameTableRegistered(): void
    {
        $this->subject->add('test_extension_a', $this->tables['first'], 'categories1');
        $this->subject->add('test_extension_b', $this->tables['first'], 'categories2');
        $this->subject->applyTcaForPreRegisteredTables();
 
        self::assertArrayHasKey('categories1', ‪$GLOBALS['TCA'][$this->tables['first']]['columns']);
        self::assertArrayHasKey('categories2', ‪$GLOBALS['TCA'][$this->tables['first']]['columns']);
    }
 
    public function ‪areElementsOfSameExtensionOnSameTableRegistered(): void
    {
        $this->subject->add('test_extension_a', $this->tables['first'], 'categories1');
        $this->subject->add('test_extension_a', $this->tables['first'], 'categories2');
        $this->subject->applyTcaForPreRegisteredTables();
 
        self::assertArrayHasKey('categories1', ‪$GLOBALS['TCA'][$this->tables['first']]['columns']);
        self::assertArrayHasKey('categories2', ‪$GLOBALS['TCA'][$this->tables['first']]['columns']);
    }
 
    public function ‪areDatabaseDefinitionsOfAllElementsAvailable(): void
    {
        $this->subject->add('test_extension_a', $this->tables['first'], 'categories');
        $this->subject->add('test_extension_b', $this->tables['second'], 'categories');
        $this->subject->add('test_extension_c', $this->tables['first'], 'categories');
        $definitions = $this->subject->getDatabaseTableDefinitions();
        $matches = [];
        preg_match_all('#CREATE TABLE\\s*([^ (]+)\\s*\\(\\s*([^ )]+)\\s+int\\(11\\)[^)]+\\);#mis', $definitions, $matches);
        self::assertCount(2, $matches[0]);
        self::assertEquals($matches[1][0], $this->tables['first']);
        self::assertEquals($matches[2][0], 'categories');
        self::assertEquals($matches[1][1], $this->tables['second']);
        self::assertEquals($matches[2][1], 'categories');
    }
 
    public function ‪areDatabaseDefinitionsOfParticularExtensionAvailable(): void
    {
        $this->subject->add('test_extension_a', $this->tables['first'], 'categories');
        $this->subject->add('test_extension_b', $this->tables['second'], 'categories');
        $definitions = $this->subject->getDatabaseTableDefinition('test_extension_a');
        $matches = [];
        preg_match_all('#CREATE TABLE\\s*([^ (]+)\\s*\\(\\s*([^ )]+)\\s+int\\(11\\)[^)]+\\);#mis', $definitions, $matches);
        self::assertCount(1, $matches[0]);
        self::assertEquals($matches[1][0], $this->tables['first']);
        self::assertEquals($matches[2][0], 'categories');
    }
 
    public function ‪areDefaultCategorizedTablesLoaded(): void
    {
        ‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['defaultCategorizedTables'] = $this->tables['first'] . ',' . $this->tables['second'];
        $this->subject->applyTcaForPreRegisteredTables();
 
        self::assertArrayHasKey('categories', ‪$GLOBALS['TCA'][$this->tables['first']]['columns']);
        self::assertArrayHasKey('categories', ‪$GLOBALS['TCA'][$this->tables['second']]['columns']);
    }
 
    public function ‪canApplyTca(): void
    {
        $this->subject->add('test_extension_a', $this->tables['first'], 'categories');
        $this->subject->add('test_extension_b', $this->tables['second'], 'categories');
        $this->subject->applyTcaForPreRegisteredTables();
 
        self::assertNotEmpty(‪$GLOBALS['TCA'][$this->tables['first']]['columns']['categories']);
        self::assertNotEmpty(‪$GLOBALS['TCA'][$this->tables['second']]['columns']['categories']);
    }
 
    public function ‪isRegisteredReturnsTrueIfElementIsAlreadyRegistered(): void
    {
        $this->subject->add('test_extension_a', $this->tables['first'], 'categories');
        self::assertTrue($this->subject->isRegistered($this->tables['first'], 'categories'));
    }
 
    public function ‪isRegisteredReturnsFalseIfElementIsNotRegistered(): void
    {
        $this->subject->add('test_extension_a', $this->tables['first'], 'categories');
        self::assertFalse($this->subject->isRegistered($this->tables['first'], '_not_registered'));
        self::assertFalse($this->subject->isRegistered($this->tables['second'], 'categories'));
    }
 
    public function ‪tabIsAddedForElement(): void
    {
        $this->subject->add('text_extension_a', $this->tables['first']);
        $this->subject->applyTcaForPreRegisteredTables();
 
        foreach (‪$GLOBALS['TCA'][$this->tables['first']]['types'] as $typeConfig) {
            self::assertStringContainsString('--div--;LLL:EXT:core/Resources/Private/Language/locallang_tca.xlf:sys_category.tabs.category', $typeConfig['showitem']);
        }
    }
 
    public function ‪tabIsNotAddedForElementIfFieldListIsSpecified(): void
    {
        $this->subject->add('text_extension_a', $this->tables['first'], 'categories', ['fieldList' => 'categories']);
        $this->subject->applyTcaForPreRegisteredTables();
 
        foreach (‪$GLOBALS['TCA'][$this->tables['first']]['types'] as $typeConfig) {
            self::assertStringNotContainsString('--div--;LLL:EXT:core/Resources/Private/Language/locallang_tca.xlf:sys_category.tabs.category', $typeConfig['showitem']);
        }
    }
 
    public function ‪tabIsOnlyAddedForTypesThatAreSpecifiedInTypesList(): void
    {
        $this->subject->add('text_extension_a', $this->tables['first'], 'categories', ['typesList' => '0']);
        $this->subject->applyTcaForPreRegisteredTables();
        self::assertSame('', ‪$GLOBALS['TCA'][$this->tables['first']]['types'][1]['showitem']);
    }
 
    public function ‪tabIsAddedOnlyOncePerTable(): void
    {
        $this->subject->add('text_extension_a', $this->tables['first'], 'categories1');
        $this->subject->add('text_extension_a', $this->tables['first'], 'categories2');
        $this->subject->applyTcaForPreRegisteredTables();
 
        foreach (‪$GLOBALS['TCA'][$this->tables['first']]['types'] as $typeConfig) {
            self::assertSame(
                1,
                substr_count($typeConfig['showitem'], '--div--;LLL:EXT:core/Resources/Private/Language/locallang_tca.xlf:sys_category.tabs.category')
            );
        }
    }
 
    public function ‪addAllowsSettingOfTheSameTableFieldTwice(): void
    {
        $this->subject->add('text_extension_a', $this->tables['first'], 'categories1');
        $result = $this->subject->add('text_extension_a', $this->tables['first'], 'categories1', [], true);
        self::assertTrue($result);
    }
 
    public function ‪addInitializesMissingTypes(): void
    {
        $this->subject->add('text_extension_a', $this->tables['first'], 'categories1');
        ‪$GLOBALS['TCA'][$this->tables['first']]['types']['newtypeafterfirstadd'] = ['showitem' => ''];
        $this->subject->add('text_extension_a', $this->tables['first'], 'categories1', [], true);
        self::assertSame(
            1,
            substr_count(‪$GLOBALS['TCA'][$this->tables['first']]['types']['newtypeafterfirstadd']['showitem'], '--div--;LLL:EXT:core/Resources/Private/Language/locallang_tca.xlf:sys_category.tabs.category')
        );
    }
}