DatabaseRecordTypeValueTest.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\Backend\Tests\Unit\Form\FormDataProvider;
 
use PHPUnit\Framework\Attributes\Test;
use PHPUnit\Framework\MockObject\MockObject;
use ‪TYPO3\CMS\Backend\Form\FormDataProvider\DatabaseRecordTypeValue;
use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
final class ‪DatabaseRecordTypeValueTest extends UnitTestCase
{
    protected ‪DatabaseRecordTypeValue&MockObject ‪$subject;
 
    protected function ‪setUp(): void
    {
        parent::setUp();
        $this->subject = $this->getMockBuilder(DatabaseRecordTypeValue::class)
            ->onlyMethods(['getDatabaseRow'])
            ->getMock();
    }
 
    #[Test]
    public function ‪addDataThrowsExceptionIfTcaTypesAreEmpty(): void
    {
        $input = [
            'tableName' => 'aTable',
            'processedTca' => [
                'types' => [],
            ],
        ];
 
        $this->expectException(\UnexpectedValueException::class);
        $this->expectExceptionCode(1438185331);
 
        $this->subject->addData($input);
    }
 
    #[Test]
    public function ‪addDataKeepsExistingTcaRecordTypeValue(): void
    {
        $input = [
            'recordTypeValue' => 'egon',
            'processedTca' => [
                'types' => [
                    '1' => 'foo',
                ],
            ],
        ];
        $expected = $input;
        self::assertSame($expected, $this->subject->addData($input));
    }
 
    #[Test]
    public function ‪addDataKeepsExistingTcaRecordTypeValueWithValueZero(): void
    {
        $input = [
            'recordTypeValue' => 0,
            'processedTca' => [
                'types' => [
                    '1' => 'foo',
                ],
            ],
        ];
        $expected = $input;
        self::assertSame($expected, $this->subject->addData($input));
    }
 
    #[Test]
    public function ‪addDataSetsRecordTypeValueToHistoricalOneIfTypeZeroIsNotDefined(): void
    {
        $input = [
            'recordTypeValue' => '',
            'processedTca' => [
                'types' => [
                    '1' => 'foo',
                ],
            ],
        ];
        $expected = $input;
        $expected['recordTypeValue'] = '1';
        self::assertSame($expected, $this->subject->addData($input));
    }
 
    #[Test]
    public function ‪addDataSetsRecordTypeValueToZero(): void
    {
        $input = [
            'recordTypeValue' => '',
            'processedTca' => [
                'types' => [
                    '0' => 'foo',
                ],
            ],
        ];
 
        $expected = $input;
        $expected['recordTypeValue'] = '0';
 
        self::assertSame($expected, $this->subject->addData($input));
    }
 
    #[Test]
    public function ‪addDataThrowsExceptionIfTypePointsToANotExistingField(): void
    {
        $input = [
            'tableName' => 'aTable',
            'recordTypeValue' => '',
            'processedTca' => [
                'ctrl' => [
                    'type' => 'notExists',
                ],
                'types' => [
                    '0' => 'foo',
                ],
            ],
            'databaseRow' => [
                'uid' => 23,
            ],
        ];
 
        $this->expectException(\UnexpectedValueException::class);
        $this->expectExceptionCode(1438183881);
 
        $this->subject->addData($input);
    }
 
    #[Test]
    public function ‪addDataSetsRecordTypeValueToValueOfDatabaseField(): void
    {
        $input = [
            'recordTypeValue' => '',
            'processedTca' => [
                'ctrl' => [
                    'type' => 'aField',
                ],
                'types' => [
                    '3' => 'foo',
                ],
            ],
            'databaseRow' => [
                'aField' => 3,
            ],
        ];
 
        $expected = $input;
        $expected['recordTypeValue'] = '3';
 
        self::assertSame($expected, $this->subject->addData($input));
    }
 
    #[Test]
    public function ‪addDataSetsRecordTypeValueToZeroIfValueOfDatabaseFieldIsNotDefinedInTca(): void
    {
        $input = [
            'recordTypeValue' => '',
            'processedTca' => [
                'ctrl' => [
                    'type' => 'aField',
                ],
                'types' => [
                    '0' => 'foo',
                ],
            ],
            'databaseRow' => [
                'aField' => 3,
            ],
        ];
 
        $expected = $input;
        $expected['recordTypeValue'] = '0';
 
        self::assertSame($expected, $this->subject->addData($input));
    }
 
    #[Test]
    public function ‪addDataSetsRecordTypeValueToZeroIfValueOfDatabaseFieldIsEmptyString(): void
    {
        $input = [
            'recordTypeValue' => '',
            'processedTca' => [
                'ctrl' => [
                    'type' => 'aField',
                ],
                'types' => [
                    '0' => 'foo',
                ],
            ],
            'databaseRow' => [
                'aField' => '',
            ],
        ];
 
        $expected = $input;
        $expected['recordTypeValue'] = '0';
 
        self::assertSame($expected, $this->subject->addData($input));
    }
 
    #[Test]
    public function ‪addDataThrowsExceptionIfValueTypesNotExistsAndNoFallbackExists(): void
    {
        $input = [
            'tableName' => 'aTable',
            'recordTypeValue' => '',
            'processedTca' => [
                'ctrl' => [
                    'type' => 'aField',
                ],
                'types' => [
                    '42' => 'foo',
                ],
            ],
            'databaseRow' => [
                'aField' => 23,
            ],
        ];
 
        $this->expectException(\UnexpectedValueException::class);
        $this->expectExceptionCode(1438185437);
 
        $this->subject->addData($input);
    }
 
    #[Test]
    public function ‪addDataThrowsExceptionForForeignTypeConfigurationNotAsSelectOrGroup(): void
    {
        $input = [
            'recordTypeValue' => '',
            'processedTca' => [
                'ctrl' => [
                    'type' => 'localField:foreignField',
                ],
                'columns' => [
                    'localField' => [
                        'config' => [
                            'type' => 'input',
                        ],
                    ],
                ],
                'types' => [
                    '3' => 'foo',
                ],
            ],
        ];
 
        $this->expectException(\UnexpectedValueException::class);
        $this->expectExceptionCode(1325862241);
 
        $this->subject->addData($input);
    }
 
    #[Test]
    public function ‪addDataThrowsExceptionForForeignTypeIfPointerConfigurationHasNoTable(): void
    {
        $input = [
            'tableName' => 'aTable',
            'recordTypeValue' => '',
            'processedTca' => [
                'ctrl' => [
                    'type' => 'localField:foreignField',
                ],
                'columns' => [
                    'localField' => [
                        'config' => [
                            'type' => 'select',
                        ],
                    ],
                ],
                'types' => [
                    '3' => 'foo',
                ],
            ],
            'databaseRow' => [
                'localField' => 3,
            ],
        ];
 
        $this->expectException(\UnexpectedValueException::class);
        $this->expectExceptionCode(1438253614);
 
        $this->subject->addData($input);
    }
 
    #[Test]
    public function ‪addDataSetsTypeValueFromForeignTableRecord(): void
    {
        $input = [
            'recordTypeValue' => '',
            'processedTca' => [
                'ctrl' => [
                    'type' => 'localField:foreignField',
                ],
                'columns' => [
                    'localField' => [
                        'config' => [
                            'type' => 'select',
                            'foreign_table' => 'foreignTable',
                        ],
                    ],
                ],
                'types' => [
                    '3' => 'foo',
                ],
            ],
            'databaseRow' => [
                // Point to record 42 in foreignTable
                'localField' => 42,
            ],
        ];
 
        $foreignRecordResult = [
            'foreignField' => 3,
        ];
 
        $this->subject->expects(self::once())
            ->method('getDatabaseRow')
            ->with('foreignTable', 42, 'foreignField')
            ->willReturn($foreignRecordResult);
 
        $expected = $input;
        $expected['recordTypeValue'] = '3';
 
        self::assertSame($expected, $this->subject->addData($input));
    }
 
    #[Test]
    public function ‪addDataSetsTypeValueFromNestedTcaGroupField(): void
    {
        $input = [
            'recordTypeValue' => '',
            'processedTca' => [
                'ctrl' => [
                    'type' => 'uid_local:type',
                ],
                'columns' => [
                    'uid_local' => [
                        'config' => [
                            'type' => 'group',
                            'size' => 1,
                            'maxitems' => 1,
                            'allowed' => 'sys_file',
                        ],
                    ],
                ],
                'types' => [
                    '2' => 'foo',
                ],
            ],
            'databaseRow' => [
                // Processed group field
                'uid_local' => [
                    [
                        'uid' => 222,
                    ],
                ],
            ],
        ];
 
        $foreignRecordResult = [
            'type' => 2,
        ];
 
        $this->subject->expects(self::once())
            ->method('getDatabaseRow')
            ->with('sys_file', 222, 'type')
            ->willReturn($foreignRecordResult);
 
        $expected = $input;
        $expected['recordTypeValue'] = '2';
 
        self::assertSame($expected, $this->subject->addData($input));
    }
}