DefaultTcaSchemaTest.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\Database\Schema;
 
use Doctrine\DBAL\Schema\Column;
use Doctrine\DBAL\Schema\Index;
use Doctrine\DBAL\Schema\SchemaException;
use Doctrine\DBAL\Schema\Table;
use Doctrine\DBAL\Types\IntegerType;
use Doctrine\DBAL\Types\StringType;
use Doctrine\DBAL\Types\Type;
use ‪TYPO3\CMS\Core\Database\Schema\DefaultTcaSchema;
use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
class ‪DefaultTcaSchemaTest extends UnitTestCase
{
    protected ?‪DefaultTcaSchema ‪$subject;
    protected ?Table ‪$defaultTable;
 
    public function ‪setUp(): void
    {
        parent::setUp();
        $this->subject = new ‪DefaultTcaSchema();
        $this->defaultTable = new Table('aTable');
    }
 
    public function ‪enrichKeepsGivenTablesArrayWithEmptyTca(): void
    {
        ‪$GLOBALS['TCA'] = [];
        self::assertEquals([$this->defaultTable], $this->subject->enrich([$this->defaultTable]));
    }
 
    public function ‪enrichDoesNotAddColumnIfExists(): void
    {
        ‪$GLOBALS['TCA']['aTable']['ctrl'] = [];
 
        $table = new Table('aTable');
        $table->addColumn('uid', 'integer');
        $table->addColumn('pid', 'integer');
        $input = [];
        $input[] = $table;
 
        $table = new Table('aTable');
        $table->addColumn('uid', 'integer');
        $table->addColumn('pid', 'integer');
        $expected = [];
        $expected[] = $table;
 
        self::assertEquals($expected, $this->subject->enrich($input));
    }
 
    public function ‪enrichDoesNotAddColumnIfTableExistsMultipleTimesAndUidExists(): void
    {
        ‪$GLOBALS['TCA']['aTable']['ctrl'] = [];
 
        $table = new Table('aTable');
        $table->addColumn('foo', 'integer');
        $input = [];
        $input[] = $table;
        $table = new Table('aTable');
        $table->addColumn('uid', 'integer');
        $table->addColumn('pid', 'integer');
        $input[] = $table;
 
        $table = new Table('aTable');
        $table->addColumn('foo', 'integer');
        $expected = [];
        $expected[] = $table;
        $table = new Table('aTable');
        $table->addColumn('uid', 'integer');
        $table->addColumn('pid', 'integer');
        $expected[] = $table;
 
        self::assertEquals($expected, $this->subject->enrich($input));
    }
 
    public function ‪enrichAddsFieldToFirstTableDefinitionOfThatName(): void
    {
        ‪$GLOBALS['TCA']['aTable']['ctrl'] = [];
 
        $table = new Table('aTable');
        $table->addColumn('foo', 'integer');
        $input = [];
        $input[] = $table;
        $table = new Table('aTable');
        $table->addColumn('bar', 'integer');
        $input[] = $table;
 
        $result = $this->subject->enrich($input);
 
        self::assertInstanceOf(Column::class, $result[0]->getColumn('uid'));
    }
 
    public function ‪enrichAddsUidAndPrimaryKey(): void
    {
        ‪$GLOBALS['TCA']['aTable']['ctrl'] = [];
        $result = $this->subject->enrich([$this->defaultTable]);
        $expectedUidColumn = new Column(
            '`uid`',
            Type::getType('integer'),
            [
                'notnull' => true,
                'unsigned' => true,
                'autoincrement' => true,
            ]
        );
        $expectedPrimaryKey = new Index('primary', ['uid'], true, true);
        self::assertEquals($expectedUidColumn, $result[0]->getColumn('uid'));
        self::assertEquals($expectedPrimaryKey, $result[0]->getPrimaryKey());
    }
 
    public function ‪enrichAddsPid(): void
    {
        ‪$GLOBALS['TCA']['aTable']['ctrl'] = [];
        $result = $this->subject->enrich([$this->defaultTable]);
        $expectedPidColumn = new Column(
            '`pid`',
            Type::getType('integer'),
            [
                'default' => 0,
                'notnull' => true,
                'unsigned' => true,
            ]
        );
        self::assertEquals($expectedPidColumn, $result[0]->getColumn('pid'));
    }
 
    public function ‪enrichAddsSignedPidWithEnabledWorkspace(): void
    {
        ‪$GLOBALS['TCA']['aTable']['ctrl'] = [
            'versioningWS' => true,
        ];
        $result = $this->subject->enrich([$this->defaultTable]);
        $expectedPidColumn = new Column(
            '`pid`',
            Type::getType('integer'),
            [
                'default' => 0,
                'notnull' => true,
                'unsigned' => false,
            ]
        );
        self::assertEquals($expectedPidColumn, $result[0]->getColumn('pid'));
    }
 
    public function ‪enrichAddsTstamp(): void
    {
        ‪$GLOBALS['TCA']['aTable']['ctrl'] = [
            'tstamp' => 'updatedon',
        ];
        $result = $this->subject->enrich([$this->defaultTable]);
        $expectedColumn = new Column(
            '`updatedon`',
            Type::getType('integer'),
            [
                'default' => 0,
                'notnull' => true,
                'unsigned' => true,
            ]
        );
        self::assertEquals($expectedColumn, $result[0]->getColumn('updatedon'));
    }
 
    public function ‪enrichAddsCrdate(): void
    {
        ‪$GLOBALS['TCA']['aTable']['ctrl'] = [
            'crdate' => 'createdon',
        ];
        $result = $this->subject->enrich([$this->defaultTable]);
        $expectedColumn = new Column(
            '`createdon`',
            Type::getType('integer'),
            [
                'default' => 0,
                'notnull' => true,
                'unsigned' => true,
            ]
        );
        self::assertEquals($expectedColumn, $result[0]->getColumn('createdon'));
    }
 
    public function ‪enrichAddsCruserid(): void
    {
        ‪$GLOBALS['TCA']['aTable']['ctrl'] = [
            'cruser_id' => 'createdby',
        ];
        $result = $this->subject->enrich([$this->defaultTable]);
        $expectedColumn = new Column(
            '`createdby`',
            Type::getType('integer'),
            [
                'default' => 0,
                'notnull' => true,
                'unsigned' => true,
            ]
        );
        self::assertEquals($expectedColumn, $result[0]->getColumn('createdby'));
    }
 
    public function ‪enrichAddsDeleted(): void
    {
        ‪$GLOBALS['TCA']['aTable']['ctrl'] = [
            'delete' => 'deleted',
        ];
        $result = $this->subject->enrich([$this->defaultTable]);
        $expectedColumn = new Column(
            '`deleted`',
            Type::getType('smallint'),
            [
                'default' => 0,
                'notnull' => true,
                'unsigned' => true,
            ]
        );
        self::assertEquals($expectedColumn, $result[0]->getColumn('deleted'));
    }
 
    public function ‪enrichAddsDisabled(): void
    {
        ‪$GLOBALS['TCA']['aTable']['ctrl'] = [
            'enablecolumns' => [
                'disabled' => 'disabled',
            ],
        ];
        $result = $this->subject->enrich([$this->defaultTable]);
        $expectedColumn = new Column(
            '`disabled`',
            Type::getType('smallint'),
            [
                'default' => 0,
                'notnull' => true,
                'unsigned' => true,
            ]
        );
        self::assertEquals($expectedColumn, $result[0]->getColumn('disabled'));
    }
 
    public function ‪enrichAddsStarttime(): void
    {
        ‪$GLOBALS['TCA']['aTable']['ctrl'] = [
            'enablecolumns' => [
                'starttime' => 'starttime',
            ],
        ];
        $result = $this->subject->enrich([$this->defaultTable]);
        $expectedColumn = new Column(
            '`starttime`',
            Type::getType('integer'),
            [
                'default' => 0,
                'notnull' => true,
                'unsigned' => true,
            ]
        );
        self::assertEquals($expectedColumn, $result[0]->getColumn('starttime'));
    }
 
    public function ‪enrichAddsEndtime(): void
    {
        ‪$GLOBALS['TCA']['aTable']['ctrl'] = [
            'enablecolumns' => [
                'endtime' => 'endtime',
            ],
        ];
        $result = $this->subject->enrich([$this->defaultTable]);
        $expectedColumn = new Column(
            '`endtime`',
            Type::getType('integer'),
            [
                'default' => 0,
                'notnull' => true,
                'unsigned' => true,
            ]
        );
        self::assertEquals($expectedColumn, $result[0]->getColumn('endtime'));
    }
 
    public function ‪enrichAddsFegroup(): void
    {
        ‪$GLOBALS['TCA']['aTable']['ctrl'] = [
            'enablecolumns' => [
                'fe_group' => 'fe_group',
            ],
        ];
        $result = $this->subject->enrich([$this->defaultTable]);
        $expectedColumn = new Column(
            '`fe_group`',
            Type::getType('string'),
            [
                'default' => '0',
                'notnull' => true,
                'length' => 255,
            ]
        );
        self::assertEquals($expectedColumn, $result[0]->getColumn('fe_group'));
    }
 
    public function ‪enrichAddsSorting(): void
    {
        ‪$GLOBALS['TCA']['aTable']['ctrl'] = [
            'sortby' => 'sorting',
        ];
        $result = $this->subject->enrich([$this->defaultTable]);
        $expectedColumn = new Column(
            '`sorting`',
            Type::getType('integer'),
            [
                'default' => '0',
                'notnull' => true,
                'unsigned' => false,
            ]
        );
        self::assertEquals($expectedColumn, $result[0]->getColumn('sorting'));
    }
 
    public function ‪enrichAddsParentKey(): void
    {
        ‪$GLOBALS['TCA']['aTable']['ctrl'] = [];
        $result = $this->subject->enrich([$this->defaultTable]);
        $expectedIndex = new Index('parent', ['pid']);
        self::assertEquals($expectedIndex, $result[0]->getIndex('parent'));
    }
 
    public function ‪enrichAddsParentKeyWithDelete(): void
    {
        ‪$GLOBALS['TCA']['aTable']['ctrl'] = [
            'delete' => 'deleted',
        ];
        $result = $this->subject->enrich([$this->defaultTable]);
        $expectedIndex = new Index('parent', ['pid', 'deleted']);
        self::assertEquals($expectedIndex, $result[0]->getIndex('parent'));
    }
 
    public function ‪enrichAddsParentKeyWithDisabled(): void
    {
        ‪$GLOBALS['TCA']['aTable']['ctrl'] = [
            'enablecolumns' => [
                'disabled' => 'disabled',
            ],
        ];
        $result = $this->subject->enrich([$this->defaultTable]);
        $expectedIndex = new Index('parent', ['pid', 'disabled']);
        self::assertEquals($expectedIndex, $result[0]->getIndex('parent'));
    }
 
    public function ‪enrichAddsParentKeyInCorrectOrder(): void
    {
        ‪$GLOBALS['TCA']['aTable']['ctrl'] = [
            'delete' => 'deleted',
            'enablecolumns' => [
                'disabled' => 'disabled',
            ],
        ];
        $result = $this->subject->enrich([$this->defaultTable]);
        $expectedIndex = new Index('parent', ['pid', 'deleted', 'disabled']);
        self::assertEquals($expectedIndex, $result[0]->getIndex('parent'));
    }
 
    public function ‪enrichAddsSysLanguageUid(): void
    {
        ‪$GLOBALS['TCA']['aTable']['ctrl'] = [
            'languageField' => 'sys_language_uid',
        ];
        $result = $this->subject->enrich([$this->defaultTable]);
        $expectedColumn = new Column(
            '`sys_language_uid`',
            Type::getType('integer'),
            [
                'default' => 0,
                'notnull' => true,
                'unsigned' => false,
            ]
        );
        self::assertEquals($expectedColumn, $result[0]->getColumn('sys_language_uid'));
    }
 
    public function ‪enrichAddsL10nParent(): void
    {
        ‪$GLOBALS['TCA']['aTable']['ctrl'] = [
            'languageField' => 'sys_language_uid',
            'transOrigPointerField' => 'l10n_parent',
        ];
        $result = $this->subject->enrich([$this->defaultTable]);
        $expectedColumn = new Column(
            '`l10n_parent`',
            Type::getType('integer'),
            [
                'default' => 0,
                'notnull' => true,
                'unsigned' => true,
            ]
        );
        self::assertEquals($expectedColumn, $result[0]->getColumn('l10n_parent'));
    }
 
    public function ‪enrichDoesNotAddL10nParentIfLanguageFieldIsNotDefined(): void
    {
        ‪$GLOBALS['TCA']['aTable']['ctrl'] = [
            'transOrigPointerField' => 'l10n_parent',
        ];
        $result = $this->subject->enrich([$this->defaultTable]);
        $this->expectException(SchemaException::class);
        $result[0]->getColumn('l10n_parent');
    }
 
    public function ‪enrichAddsDescription(): void
    {
        ‪$GLOBALS['TCA']['aTable']['ctrl'] = [
            'descriptionColumn' => 'rowDescription',
        ];
        $result = $this->subject->enrich([$this->defaultTable]);
        $expectedColumn = new Column(
            '`rowDescription`',
            Type::getType('text'),
            [
                'notnull' => false,
                'length' => 65535,
            ]
        );
        self::assertEquals($expectedColumn, $result[0]->getColumn('rowDescription'));
    }
 
    public function ‪enrichAddsEditlock(): void
    {
        ‪$GLOBALS['TCA']['aTable']['ctrl'] = [
            'editlock' => 'editlock',
        ];
        $result = $this->subject->enrich([$this->defaultTable]);
        $expectedColumn = new Column(
            '`editlock`',
            Type::getType('smallint'),
            [
                'default' => 0,
                'notnull' => true,
                'unsigned' => true,
            ]
        );
        self::assertEquals($expectedColumn, $result[0]->getColumn('editlock'));
    }
 
    public function ‪enrichAddsL10nSource(): void
    {
        ‪$GLOBALS['TCA']['aTable']['ctrl'] = [
            'languageField' => 'sys_language_uid',
            'translationSource' => 'l10n_source',
        ];
        $result = $this->subject->enrich([$this->defaultTable]);
        $expectedColumn = new Column(
            '`l10n_source`',
            Type::getType('integer'),
            [
                'default' => 0,
                'notnull' => true,
                'unsigned' => true,
            ]
        );
        self::assertEquals($expectedColumn, $result[0]->getColumn('l10n_source'));
    }
 
    public function ‪enrichDoesNotAddL10nSourceIfLanguageFieldIsNotDefined(): void
    {
        ‪$GLOBALS['TCA']['aTable']['ctrl'] = [
            'translationSource' => 'l10n_source',
        ];
        $result = $this->subject->enrich([$this->defaultTable]);
        $this->expectException(SchemaException::class);
        $result[0]->getColumn('l10n_source');
    }
 
    public function ‪enrichAddsL10nState(): void
    {
        ‪$GLOBALS['TCA']['aTable']['ctrl'] = [
            'languageField' => 'sys_language_uid',
            'transOrigPointerField' => 'l10n_parent',
        ];
        $result = $this->subject->enrich([$this->defaultTable]);
        $expectedColumn = new Column(
            '`l10n_state`',
            Type::getType('text'),
            [
                'notnull' => false,
                'length' => 65535,
            ]
        );
        self::assertEquals($expectedColumn, $result[0]->getColumn('l10n_state'));
    }
 
    public function ‪enrichDoesNotAddL10nStateIfLanguageFieldIsNotDefined(): void
    {
        ‪$GLOBALS['TCA']['aTable']['ctrl'] = [
            'transOrigPointerField' => 'l10n_parent',
        ];
        $result = $this->subject->enrich([$this->defaultTable]);
        $this->expectException(SchemaException::class);
        $result[0]->getColumn('l10n_state');
    }
 
    public function ‪enrichDoesNotAddL10nStateIfTransOrigPointerFieldIsNotDefined(): void
    {
        ‪$GLOBALS['TCA']['aTable']['ctrl'] = [
            'languageField' => 'sys_language_uid',
        ];
        $result = $this->subject->enrich([$this->defaultTable]);
        $this->expectException(SchemaException::class);
        $result[0]->getColumn('l10n_state');
    }
 
    public function ‪enrichAddsT3origUid(): void
    {
        ‪$GLOBALS['TCA']['aTable']['ctrl'] = [
            'origUid' => 't3_origuid',
        ];
        $result = $this->subject->enrich([$this->defaultTable]);
        $expectedColumn = new Column(
            '`t3_origuid`',
            Type::getType('integer'),
            [
                'default' => 0,
                'notnull' => true,
                'unsigned' => true,
            ]
        );
        self::assertEquals($expectedColumn, $result[0]->getColumn('t3_origuid'));
    }
 
    public function ‪enrichAddsL10nDiffsource(): void
    {
        ‪$GLOBALS['TCA']['aTable']['ctrl'] = [
            'transOrigDiffSourceField' => 'l18n_diffsource',
        ];
        $result = $this->subject->enrich([$this->defaultTable]);
        $expectedColumn = new Column(
            '`l18n_diffsource`',
            Type::getType('blob'),
            [
                'length' => 16777215,
                'notnull' => false,
            ]
        );
        self::assertEquals($expectedColumn, $result[0]->getColumn('l18n_diffsource'));
    }
 
    public function ‪enrichAddsT3verOid(): void
    {
        ‪$GLOBALS['TCA']['aTable']['ctrl'] = [
            'versioningWS' => true,
        ];
        $result = $this->subject->enrich([$this->defaultTable]);
        $expectedColumn = new Column(
            '`t3ver_oid`',
            Type::getType('integer'),
            [
                'default' => 0,
                'notnull' => true,
                'unsigned' => true,
            ]
        );
        self::assertEquals($expectedColumn, $result[0]->getColumn('t3ver_oid'));
    }
 
    public function ‪enrichAddsT3verWsid(): void
    {
        ‪$GLOBALS['TCA']['aTable']['ctrl'] = [
            'versioningWS' => true,
        ];
        $result = $this->subject->enrich([$this->defaultTable]);
        $expectedColumn = new Column(
            '`t3ver_wsid`',
            Type::getType('integer'),
            [
                'default' => 0,
                'notnull' => true,
                'unsigned' => true,
            ]
        );
        self::assertEquals($expectedColumn, $result[0]->getColumn('t3ver_wsid'));
    }
 
    public function ‪enrichAddsT3verState(): void
    {
        ‪$GLOBALS['TCA']['aTable']['ctrl'] = [
            'versioningWS' => true,
        ];
        $result = $this->subject->enrich([$this->defaultTable]);
        $expectedColumn = new Column(
            '`t3ver_state`',
            Type::getType('smallint'),
            [
                'default' => 0,
                'notnull' => true,
                'unsigned' => false,
            ]
        );
        self::assertEquals($expectedColumn, $result[0]->getColumn('t3ver_state'));
    }
 
    public function ‪enrichAddsT3verStage(): void
    {
        ‪$GLOBALS['TCA']['aTable']['ctrl'] = [
            'versioningWS' => true,
        ];
        $result = $this->subject->enrich([$this->defaultTable]);
        $expectedColumn = new Column(
            '`t3ver_stage`',
            Type::getType('integer'),
            [
                'default' => 0,
                'notnull' => true,
                'unsigned' => false,
            ]
        );
        self::assertEquals($expectedColumn, $result[0]->getColumn('t3ver_stage'));
    }
 
    public function ‪enrichAddsT3verOidIndex(): void
    {
        ‪$GLOBALS['TCA']['aTable']['ctrl'] = [
            'versioningWS' => true,
        ];
        $result = $this->subject->enrich([$this->defaultTable]);
        $expectedIndex = new Index('t3ver_oid', ['t3ver_oid', 't3ver_wsid']);
        self::assertEquals($expectedIndex, $result[0]->getIndex('t3ver_oid'));
    }
 
    public function ‪enrichAddsSimpleMmForSelect(): void
    {
        ‪$GLOBALS['TCA']['aTable']['columns']['aField']['config'] = [
            'type' => 'select',
            'MM' => 'tx_myext_atable_afield_mm',
        ];
        $result = $this->subject->enrich([$this->defaultTable]);
        $expectedMmTable = new Table(
            'tx_myext_atable_afield_mm',
            [
                new Column(
                    '`uid_local`',
                    new IntegerType(),
                    [
                        'default' => 0,
                        'unsigned' => true,
                    ]
                ),
                new Column(
                    '`uid_foreign`',
                    new IntegerType(),
                    [
                        'default' => 0,
                        'unsigned' => true,
                    ]
                ),
                new Column(
                    '`sorting`',
                    new IntegerType(),
                    [
                        'default' => 0,
                        'unsigned' => true,
                    ]
                ),
                new Column(
                    '`sorting_foreign`',
                    new IntegerType(),
                    [
                        'default' => 0,
                        'unsigned' => true,
                    ]
                ),
            ],
            [
                new Index(
                    'uid_local',
                    ['uid_local']
                ),
                new Index(
                    'uid_foreign',
                    ['uid_foreign']
                ),
            ]
        );
        self::assertEquals($expectedMmTable, $result[1]);
    }
 
    public function ‪enrichAddsMmWithTcaHasUid(): void
    {
        ‪$GLOBALS['TCA']['aTable']['columns']['aField']['config'] = [
            'type' => 'select',
            'MM' => 'tx_myext_atable_afield_mm',
            'MM_hasUidField' => true,
        ];
        $result = $this->subject->enrich([$this->defaultTable]);
        $expectedMmTable = new Table(
            'tx_myext_atable_afield_mm',
            [
                new Column(
                    '`uid_local`',
                    new IntegerType(),
                    [
                        'default' => 0,
                        'unsigned' => true,
                    ]
                ),
                new Column(
                    '`uid_foreign`',
                    new IntegerType(),
                    [
                        'default' => 0,
                        'unsigned' => true,
                    ]
                ),
                new Column(
                    '`sorting`',
                    new IntegerType(),
                    [
                        'default' => 0,
                        'unsigned' => true,
                    ]
                ),
                new Column(
                    '`sorting_foreign`',
                    new IntegerType(),
                    [
                        'default' => 0,
                        'unsigned' => true,
                    ]
                ),
                new Column(
                    '`uid`',
                    new IntegerType(),
                    [
                        'default' => null,
                        'autoincrement' => true,
                        'unsigned' => true,
                    ]
                ),
            ],
            [
                new Index(
                    'uid_local',
                    ['uid_local']
                ),
                new Index(
                    'uid_foreign',
                    ['uid_foreign']
                ),
                new Index(
                    'primary',
                    ['uid'],
                    true,
                    true
                ),
            ]
        );
        self::assertEquals($expectedMmTable, $result[1]);
    }
 
    public function ‪enrichAddsMmWithTablenamesAndFieldname(): void
    {
        ‪$GLOBALS['TCA']['aTable']['columns']['aField']['config'] = [
            'type' => 'select',
            'MM' => 'tx_myext_atable_afield_mm',
            'MM_oppositeUsage' => [
                'tt_content' => [
                    'categories',
                ],
            ],
        ];
        $result = $this->subject->enrich([$this->defaultTable]);
        $expectedMmTable = new Table(
            'tx_myext_atable_afield_mm',
            [
                new Column(
                    '`uid_local`',
                    new IntegerType(),
                    [
                        'default' => 0,
                        'unsigned' => true,
                    ]
                ),
                new Column(
                    '`uid_foreign`',
                    new IntegerType(),
                    [
                        'default' => 0,
                        'unsigned' => true,
                    ]
                ),
                new Column(
                    '`sorting`',
                    new IntegerType(),
                    [
                        'default' => 0,
                        'unsigned' => true,
                    ]
                ),
                new Column(
                    '`sorting_foreign`',
                    new IntegerType(),
                    [
                        'default' => 0,
                        'unsigned' => true,
                    ]
                ),
                new Column(
                    '`tablenames`',
                    new StringType(),
                    [
                        'default' => '',
                        'length' => 255,
                    ]
                ),
                new Column(
                    '`fieldname`',
                    new StringType(),
                    [
                        'default' => '',
                        'length' => 255,
                    ]
                ),
            ],
            [
                new Index(
                    'uid_local',
                    ['uid_local']
                ),
                new Index(
                    'uid_foreign',
                    ['uid_foreign']
                ),
            ]
        );
        self::assertEquals($expectedMmTable, $result[1]);
    }
}