DataMapFactoryTest.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\Extbase\Tests\Unit\Persistence\Generic\Mapper;
 
use ‪ExtbaseTeam\BlogExample\Domain\Model\Administrator;
use ‪TYPO3\CMS\Belog\Domain\Model\LogEntry;
use ‪TYPO3\CMS\Core\Cache\Frontend\VariableFrontend;
use ‪TYPO3\CMS\Core\DataHandling\TableColumnSubType;
use ‪TYPO3\CMS\Core\DataHandling\TableColumnType;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Extbase\Persistence\Generic\Exception\InvalidClassException;
use ‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap;
use ‪TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapFactory;
use ‪TYPO3\CMS\Extbase\Persistence\ObjectStorage;
use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
class ‪DataMapFactoryTest extends UnitTestCase
{
    public function ‪oneToOneRelation(): array
    {
        return [
            ['Tx_Myext_Domain_Model_Foo'],
            [Administrator::class],
        ];
    }
 
    public function ‪setRelationsDetectsOneToOneRelation($className): void
    {
        $mockColumnMap = $this->createMock(ColumnMap::class);
        $columnConfiguration = [
            'type' => 'select',
            'foreign_table' => 'tx_myextension_bar',
            'foreign_field' => 'parentid',
        ];
        $type = $className;
        $elementType = null;
        $mockDataMapFactory = $this->getAccessibleMock(DataMapFactory::class, ['setOneToOneRelation', 'setOneToManyRelation', 'setManyToManyRelation'], [], '', false);
        $mockDataMapFactory->expects(self::once())->method('setOneToOneRelation')->willReturn($mockColumnMap);
        $mockDataMapFactory->expects(self::never())->method('setOneToManyRelation');
        $mockDataMapFactory->expects(self::never())->method('setManyToManyRelation');
        $mockDataMapFactory->_call('setRelations', $mockColumnMap, $columnConfiguration, $type, $elementType);
    }
 
    public function ‪settingOneToOneRelationSetsRelationTableMatchFields(): void
    {
        $mockColumnMap = $this->createMock(ColumnMap::class);
        $matchFields = [
            'fieldname' => 'foo_model',
        ];
        $columnConfiguration = [
            'type' => 'select',
            'foreign_table' => 'tx_myextension_bar',
            'foreign_field' => 'parentid',
            'foreign_match_fields' => $matchFields,
        ];
 
        $mockColumnMap->expects(self::once())
            ->method('setRelationTableMatchFields')
            ->with($matchFields);
        $mockDataMapFactory = $this->getAccessibleMock(DataMapFactory::class, ['dummy'], [], '', false);
        $mockDataMapFactory->_call('setOneToOneRelation', $mockColumnMap, $columnConfiguration);
    }
 
    public function ‪settingOneToManyRelationSetsRelationTableMatchFields(): void
    {
        $mockColumnMap = $this->createMock(ColumnMap::class);
        $matchFields = [
            'fieldname' => 'foo_model',
        ];
        $columnConfiguration = [
            'type' => 'select',
            'foreign_table' => 'tx_myextension_bar',
            'foreign_field' => 'parentid',
            'foreign_match_fields' => $matchFields,
        ];
 
        $mockColumnMap->expects(self::once())
            ->method('setRelationTableMatchFields')
            ->with($matchFields);
        $mockDataMapFactory = $this->getAccessibleMock(DataMapFactory::class, ['dummy'], [], '', false);
        $mockDataMapFactory->_call('setOneToManyRelation', $mockColumnMap, $columnConfiguration);
    }
 
    public function ‪setRelationsDetectsOneToOneRelationWithIntermediateTable(): void
    {
        $mockColumnMap = $this->createMock(ColumnMap::class);
        $columnConfiguration = [
            'type' => 'select',
            'foreign_table' => 'tx_myextension_bar',
            'MM' => 'tx_myextension_mm',
        ];
        $type = 'Tx_Myext_Domain_Model_Foo';
        $elementType = null;
        $mockDataMapFactory = $this->getAccessibleMock(DataMapFactory::class, ['setOneToOneRelation', 'setOneToManyRelation', 'setManyToManyRelation'], [], '', false);
        $mockDataMapFactory->expects(self::never())->method('setOneToOneRelation');
        $mockDataMapFactory->expects(self::never())->method('setOneToManyRelation');
        $mockDataMapFactory->expects(self::once())->method('setManyToManyRelation')->willReturn($mockColumnMap);
        $mockDataMapFactory->_call('setRelations', $mockColumnMap, $columnConfiguration, $type, $elementType);
    }
 
    public function ‪setRelationsDetectsOneToManyRelation(): void
    {
        $mockColumnMap = $this->createMock(ColumnMap::class);
        $columnConfiguration = [
            'type' => 'select',
            'foreign_table' => 'tx_myextension_bar',
            'foreign_field' => 'parentid',
            'foreign_table_field' => 'parenttable',
        ];
        $type = ObjectStorage::class;
        $elementType = 'Tx_Myext_Domain_Model_Foo';
        $mockDataMapFactory = $this->getAccessibleMock(DataMapFactory::class, ['setOneToOneRelation', 'setOneToManyRelation', 'setManyToManyRelation'], [], '', false);
        $mockDataMapFactory->expects(self::never())->method('setOneToOneRelation');
        $mockDataMapFactory->expects(self::once())->method('setOneToManyRelation')->willReturn($mockColumnMap);
        $mockDataMapFactory->expects(self::never())->method('setManyToManyRelation');
        $mockDataMapFactory->_call('setRelations', $mockColumnMap, $columnConfiguration, $type, $elementType);
    }
 
    public function ‪setRelationsDetectsSelectRenderTypeSingleAsNonRelational(): void
    {
        $columnMap = new ‪ColumnMap('foo', 'foo');
        $columnConfiguration = [
            'type' => 'select',
            'renderType' => 'selectSingle',
            'items' => [
                ['One', 1],
                ['Two', 2],
                ['Three', 3],
            ],
        ];
        $type = null;
        $elementType = null;
        $mockDataMapFactory = $this->getAccessibleMock(DataMapFactory::class, ['setOneToOneRelation', 'setOneToManyRelation', 'setManyToManyRelation'], [], '', false);
        $mockDataMapFactory->expects(self::never())->method('setOneToOneRelation');
        $mockDataMapFactory->expects(self::never())->method('setOneToManyRelation');
        $mockDataMapFactory->expects(self::never())->method('setManyToManyRelation');
        $actualColumnMap = $mockDataMapFactory->_call('setRelations', $columnMap, $columnConfiguration, $type, $elementType);
        self::assertSame($columnMap::RELATION_NONE, $actualColumnMap->getTypeOfRelation());
    }
 
    public function ‪columnConfigurationIsInitializedWithMaxItemsEvaluationForTypeGroupDataProvider(): array
    {
        return [
            'maxitems not set' => ['', 'RELATION_HAS_MANY'],
            'maxitems equals 1' => ['1', 'RELATION_NONE'],
            'maxitems higher than 1' => ['10', 'RELATION_HAS_MANY'],
        ];
    }
 
    public function ‪setRelationsDetectsTypeGroupAndRelationManyToMany($maxitems, $relation): void
    {
        $columnMap = new ‪ColumnMap('foo', 'foo');
        if (empty($maxitems)) {
            $columnConfiguration = [
                'type' => 'group',
            ];
        } else {
            $columnConfiguration = [
                'type' => 'group',
                'maxitems' => $maxitems,
            ];
        }
        $type = null;
        $elementType = null;
        $mockDataMapFactory = $this->getAccessibleMock(DataMapFactory::class, ['setOneToOneRelation', 'setOneToManyRelation', 'setManyToManyRelation'], [], '', false);
        $mockDataMapFactory->expects(self::never())->method('setOneToOneRelation');
        $mockDataMapFactory->expects(self::never())->method('setOneToManyRelation');
        $mockDataMapFactory->expects(self::never())->method('setManyToManyRelation');
        $actualColumnMap = $mockDataMapFactory->_call('setRelations', $columnMap, $columnConfiguration, $type, $elementType);
        self::assertSame($relation, $actualColumnMap->getTypeOfRelation());
    }
 
    public function ‪setRelationsDetectsManyToManyRelationOfTypeSelect(): void
    {
        $mockColumnMap = $this->createMock(ColumnMap::class);
        $columnConfiguration = [
            'type' => 'select',
            'foreign_table' => 'tx_myextension_bar',
            'MM' => 'tx_myextension_mm',
        ];
        $type = ObjectStorage::class;
        $elementType = 'Tx_Myext_Domain_Model_Foo';
        $mockDataMapFactory = $this->getAccessibleMock(DataMapFactory::class, ['setOneToOneRelation', 'setOneToManyRelation', 'setManyToManyRelation'], [], '', false);
        $mockDataMapFactory->expects(self::never())->method('setOneToOneRelation');
        $mockDataMapFactory->expects(self::never())->method('setOneToManyRelation');
        $mockDataMapFactory->expects(self::once())->method('setManyToManyRelation')->willReturn($mockColumnMap);
        $mockDataMapFactory->_call('setRelations', $mockColumnMap, $columnConfiguration, $type, $elementType);
    }
 
    public function ‪setRelationsDetectsManyToManyRelationOfTypeInlineWithIntermediateTable(): void
    {
        $mockColumnMap = $this->createMock(ColumnMap::class);
        $columnConfiguration = [
            'type' => 'inline',
            'foreign_table' => 'tx_myextension_righttable',
            'MM' => 'tx_myextension_mm',
        ];
        $type = ObjectStorage::class;
        $elementType = 'Tx_Myext_Domain_Model_Foo';
        $mockDataMapFactory = $this->getAccessibleMock(DataMapFactory::class, ['setOneToOneRelation', 'setOneToManyRelation', 'setManyToManyRelation'], [], '', false);
        $mockDataMapFactory->expects(self::never())->method('setOneToOneRelation');
        $mockDataMapFactory->expects(self::never())->method('setOneToManyRelation');
        $mockDataMapFactory->expects(self::once())->method('setManyToManyRelation')->willReturn($mockColumnMap);
        $mockDataMapFactory->_call('setRelations', $mockColumnMap, $columnConfiguration, $type, $elementType);
    }
 
    public function ‪columnMapIsInitializedWithManyToManyRelationOfTypeSelect(): void
    {
        $leftColumnsDefinition = [
            'rights' => [
                'type' => 'select',
                'foreign_table' => 'tx_myextension_righttable',
                'foreign_table_where' => 'WHERE 1=1',
                'MM' => 'tx_myextension_mm',
                'MM_table_where' => 'WHERE 2=2',
            ],
        ];
        $mockColumnMap = $this->createMock(ColumnMap::class);
        $mockColumnMap->expects(self::once())->method('setTypeOfRelation')->with(self::equalTo(‪ColumnMap::RELATION_HAS_AND_BELONGS_TO_MANY));
        $mockColumnMap->expects(self::once())->method('setRelationTableName')->with(self::equalTo('tx_myextension_mm'));
        $mockColumnMap->expects(self::once())->method('setChildTableName')->with(self::equalTo('tx_myextension_righttable'));
        $mockColumnMap->expects(self::once())->method('setChildSortByFieldName')->with(self::equalTo('sorting'));
        $mockColumnMap->expects(self::once())->method('setParentKeyFieldName')->with(self::equalTo('uid_local'));
        $mockColumnMap->expects(self::never())->method('setParentTableFieldName');
        $mockColumnMap->expects(self::never())->method('setRelationTableMatchFields');
        $mockColumnMap->expects(self::never())->method('setRelationTableInsertFields');
        $mockDataMapFactory = $this->getAccessibleMock(DataMapFactory::class, ['dummy'], [], '', false);
        $mockDataMapFactory->_call('setManyToManyRelation', $mockColumnMap, $leftColumnsDefinition['rights']);
    }
 
    public function ‪columnMapIsInitializedWithOppositeManyToManyRelationOfTypeSelect(): void
    {
        $rightColumnsDefinition = [
            'lefts' => [
                'type' => 'select',
                'foreign_table' => 'tx_myextension_lefttable',
                'MM' => 'tx_myextension_mm',
                'MM_opposite_field' => 'rights',
            ],
        ];
 
        $mockColumnMap = $this->createMock(ColumnMap::class);
        $mockColumnMap->expects(self::once())->method('setTypeOfRelation')->with(self::equalTo(‪ColumnMap::RELATION_HAS_AND_BELONGS_TO_MANY));
        $mockColumnMap->expects(self::once())->method('setRelationTableName')->with(self::equalTo('tx_myextension_mm'));
        $mockColumnMap->expects(self::once())->method('setChildTableName')->with(self::equalTo('tx_myextension_lefttable'));
        $mockColumnMap->expects(self::once())->method('setChildSortByFieldName')->with(self::equalTo('sorting_foreign'));
        $mockColumnMap->expects(self::once())->method('setParentKeyFieldName')->with(self::equalTo('uid_foreign'));
        $mockColumnMap->expects(self::never())->method('setParentTableFieldName');
        $mockColumnMap->expects(self::never())->method('setRelationTableMatchFields');
        $mockColumnMap->expects(self::never())->method('setRelationTableInsertFields');
        $mockDataMapFactory = $this->getAccessibleMock(DataMapFactory::class, ['dummy'], [], '', false);
        $mockDataMapFactory->_call('setManyToManyRelation', $mockColumnMap, $rightColumnsDefinition['lefts']);
    }
 
    public function ‪columnMapIsInitializedWithManyToManyRelationOfTypeInlineAndIntermediateTable(): void
    {
        $leftColumnsDefinition = [
            'rights' => [
                'type' => 'inline',
                'foreign_table' => 'tx_myextension_righttable',
                'MM' => 'tx_myextension_mm',
                'foreign_sortby' => 'sorting',
            ],
        ];
        $mockColumnMap = $this->createMock(ColumnMap::class);
        $mockColumnMap->expects(self::once())->method('setTypeOfRelation')->with(self::equalTo(‪ColumnMap::RELATION_HAS_AND_BELONGS_TO_MANY));
        $mockColumnMap->expects(self::once())->method('setRelationTableName')->with(self::equalTo('tx_myextension_mm'));
        $mockColumnMap->expects(self::once())->method('setChildTableName')->with(self::equalTo('tx_myextension_righttable'));
        $mockColumnMap->expects(self::once())->method('setChildSortByFieldName')->with(self::equalTo('sorting'));
        $mockColumnMap->expects(self::once())->method('setParentKeyFieldName')->with(self::equalTo('uid_local'));
        $mockColumnMap->expects(self::never())->method('setParentTableFieldName');
        $mockColumnMap->expects(self::never())->method('setRelationTableMatchFields');
        $mockColumnMap->expects(self::never())->method('setRelationTableInsertFields');
        $mockDataMapFactory = $this->getAccessibleMock(DataMapFactory::class, ['getColumnsDefinition'], [], '', false);
        $mockDataMapFactory->expects(self::never())->method('getColumnsDefinition');
        $mockDataMapFactory->_call('setManyToManyRelation', $mockColumnMap, $leftColumnsDefinition['rights']);
    }
 
    public function ‪columnMapIsInitializedWithManyToManyRelationWithoutPidColumn(): void
    {
        $leftColumnsDefinition = [
            'rights' => [
                'type' => 'select',
                'foreign_table' => 'tx_myextension_righttable',
                'foreign_table_where' => 'WHERE 1=1',
                'MM' => 'tx_myextension_mm',
            ],
        ];
        $mockColumnMap = $this->createMock(ColumnMap::class);
        $mockColumnMap->expects(self::once())->method('setRelationTableName')->with(self::equalTo('tx_myextension_mm'));
        $mockColumnMap->expects(self::once())->method('getRelationTableName')->willReturn('tx_myextension_mm');
        $mockColumnMap->expects(self::never())->method('setrelationTablePageIdColumnName');
        $mockDataMapFactory = $this->getAccessibleMock(DataMapFactory::class, ['getControlSection'], [], '', false);
        $mockDataMapFactory->expects(self::once())->method('getControlSection')->with(self::equalTo('tx_myextension_mm'))->willReturn(null);
        $mockDataMapFactory->_call('setManyToManyRelation', $mockColumnMap, $leftColumnsDefinition['rights']);
    }
 
    public function ‪columnMapIsInitializedWithManyToManyRelationWithPidColumn(): void
    {
        $leftColumnsDefinition = [
            'rights' => [
                'type' => 'select',
                'foreign_table' => 'tx_myextension_righttable',
                'foreign_table_where' => 'WHERE 1=1',
                'MM' => 'tx_myextension_mm',
            ],
        ];
        $mockColumnMap = $this->createMock(ColumnMap::class);
        $mockColumnMap->expects(self::once())->method('setRelationTableName')->with(self::equalTo('tx_myextension_mm'));
        $mockColumnMap->expects(self::once())->method('getRelationTableName')->willReturn('tx_myextension_mm');
        $mockColumnMap->expects(self::once())->method('setrelationTablePageIdColumnName')->with(self::equalTo('pid'));
        $mockDataMapFactory = $this->getAccessibleMock(DataMapFactory::class, ['getControlSection'], [], '', false);
        $mockDataMapFactory->expects(self::once())->method('getControlSection')->with(self::equalTo('tx_myextension_mm'))->willReturn(['ctrl' => ['foo' => 'bar']]);
        $mockDataMapFactory->_call('setManyToManyRelation', $mockColumnMap, $leftColumnsDefinition['rights']);
    }
 
    public function ‪columnMapIsInitializedWithFieldEvaluationsForDateTimeFieldsDataProvider(): array
    {
        return [
            'date field' => ['date', 'date'],
            'datetime field' => ['datetime', 'datetime'],
            'time field' => ['time', 'time'],
            'no date/datetime/time field' => ['', null],
        ];
    }
 
    public function ‪columnMapIsInitializedWithFieldEvaluationsForDateTimeFields($type, $expectedValue): void
    {
        $columnDefinition = [
            'type' => 'input',
            'dbType' => $type,
            'eval' => $type,
        ];
 
        $mockColumnMap = $this->getMockBuilder(ColumnMap::class)
            ->onlyMethods(['setDateTimeStorageFormat'])
            ->disableOriginalConstructor()
            ->getMock();
 
        if ($expectedValue !== null) {
            $mockColumnMap->expects(self::once())->method('setDateTimeStorageFormat')->with(self::equalTo($type));
        } else {
            $mockColumnMap->expects(self::never())->method('setDateTimeStorageFormat');
        }
 
        $accessibleDataMapFactory = $this->getAccessibleMock(
            DataMapFactory::class,
            ['dummy'],
            [],
            '',
            false
        );
        $accessibleDataMapFactory->_call('setFieldEvaluations', $mockColumnMap, $columnDefinition);
    }
 
    public function ‪buildDataMapThrowsExceptionIfClassNameIsNotKnown(): void
    {
        $this->expectException(InvalidClassException::class);
        // @TODO expectExceptionCode is 0
        $mockDataMapFactory = $this->getAccessibleMock(DataMapFactory::class, ['getControlSection'], [], '', false);
        $cacheMock = $this->getMockBuilder(VariableFrontend::class)
            ->onlyMethods(['get'])
            ->disableOriginalConstructor()
            ->getMock();
        $cacheMock->method('get')->willReturn(false);
        $mockDataMapFactory->_set('dataMapCache', $cacheMock);
        $mockDataMapFactory->_set('baseCacheIdentifier', 'PackageDependentCacheIdentifier');
        $mockDataMapFactory->buildDataMap('UnknownObject');
    }
 
    public function ‪classNameTableNameMappings(): array
    {
        return [
            'Core classes' => [LogEntry::class, 'tx_belog_domain_model_logentry'],
            'Core classes with namespaces and leading backslash' => [LogEntry::class, 'tx_belog_domain_model_logentry'],
            'Extension classes' => ['ExtbaseTeam\\BlogExample\\Domain\\Model\\Blog', 'tx_blogexample_domain_model_blog'],
            'Extension classes with namespaces and leading backslash' => ['\\ExtbaseTeam\\BlogExample\\Domain\\Model\\Blog', 'tx_blogexample_domain_model_blog'],
        ];
    }
 
    public function ‪resolveTableNameReturnsExpectedTablenames($className, $expected): void
    {
        $dataMapFactory = $this->getAccessibleMock(DataMapFactory::class, ['dummy'], [], '', false);
        self::assertSame($expected, $dataMapFactory->_call('resolveTableName', $className));
    }
 
    public function ‪createColumnMapReturnsAValidColumnMap(): void
    {
        $dataMapFactory = $this->getAccessibleMock(DataMapFactory::class, ['dummy'], [], '', false);
 
        $columnMap = $this->getMockBuilder(ColumnMap::class)
            ->setConstructorArgs(['column', 'property'])
            ->getMock();
        GeneralUtility::addInstance(ColumnMap::class, $columnMap);
 
        self::assertEquals(
            $columnMap,
            $dataMapFactory->_call('createColumnMap', 'column', 'property')
        );
    }
 
    public function ‪tcaConfigurationsContainingTypeAndInternalType(): array
    {
        return [
            [['type' => 'input'], ‪TableColumnType::INPUT, null],
            [['type' => 'text'], ‪TableColumnType::TEXT, null],
            [['type' => 'check'], ‪TableColumnType::CHECK, null],
            [['type' => 'radio'], ‪TableColumnType::RADIO, null],
            [['type' => 'select'], ‪TableColumnType::SELECT, null],
            [['type' => 'category'], ‪TableColumnType::CATEGORY, null],
            [['type' => 'group'], ‪TableColumnType::GROUP, ‪TableColumnSubType::DB],
            [['type' => 'group', 'internal_type' => 'folder'], ‪TableColumnType::GROUP, ‪TableColumnSubType::FOLDER],
            [['type' => 'none'], ‪TableColumnType::NONE, null],
            [['type' => 'language'], ‪TableColumnType::LANGUAGE, null],
            [['type' => 'passthrough'], ‪TableColumnType::PASSTHROUGH, null],
            [['type' => 'user'], ‪TableColumnType::USER, null],
            [['type' => 'flex'], ‪TableColumnType::FLEX, null],
            [['type' => 'inline'], ‪TableColumnType::INLINE, null],
            [['type' => 'slug'], ‪TableColumnType::SLUG, null],
        ];
    }
 
    public function ‪setTypeDetectsTypeAndInternalTypeProperly(array $columnConfiguration, $type, $internalType): void
    {
        $dataMapFactory = $this->getAccessibleMock(DataMapFactory::class, ['dummy'], [], '', false);
 
        $columnMap = $this->getAccessibleMock(ColumnMap::class, ['dummy'], [], '', false);
 
        $dataMapFactory->_call('setType', $columnMap, $columnConfiguration);
 
        self::assertEquals($type, (string)$columnMap->getType());
        self::assertEquals($internalType, (string)$columnMap->getInternalType());
    }
}