EditDocumentControllerTest.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\Controller;
 
use Prophecy\Argument;
use Prophecy\PhpUnit\ProphecyTrait;
use Psr\EventDispatcher\EventDispatcherInterface;
use ‪TYPO3\CMS\Backend\Controller\EditDocumentController;
use ‪TYPO3\CMS\Backend\Routing\UriBuilder;
use ‪TYPO3\CMS\Backend\Template\ModuleTemplate;
use ‪TYPO3\CMS\Backend\Template\ModuleTemplateFactory;
use ‪TYPO3\CMS\Core\Imaging\IconFactory;
use TYPO3\CMS\Core\Page\PageRenderer;
use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
class ‪EditDocumentControllerTest extends UnitTestCase
{
    use ProphecyTrait;
 
    protected ‪$resetSingletonInstances = true;
 
    public function ‪parseAdditionalGetParametersCreatesCorrectParameterArray(): void
    {
        $typoScript = [
            'tx_myext.' => [
                'controller' => 'test',
                'action' => 'run',
            ],
            'magic' => 'yes',
        ];
        $expectedParameters = [
            'tx_myext' => [
                'controller' => 'test',
                'action' => 'run',
            ],
            'magic' => 'yes',
        ];
        $result = [];
        $uriBuilder = $this->prophesize(UriBuilder::class);
        $iconFactory = $this->prophesize(IconFactory::class);
        $pageRenderer = $this->prophesize(PageRenderer::class);
        $moduleTemplate = $this->prophesize(ModuleTemplate::class);
        $moduleTemplate->setUiBlock(Argument::any())->willReturn($moduleTemplate->reveal());
        $moduleTemplateFactory = $this->prophesize(ModuleTemplateFactory::class);
        $moduleTemplateFactory->create(Argument::any())->willReturn($moduleTemplate->reveal());
 
        $eventDispatcher = $this->prophesize(EventDispatcherInterface::class);
        $mock = \Closure::bind(static function (‪EditDocumentController $editDocumentController) use (&$result, $typoScript) {
            return $editDocumentController->‪parseAdditionalGetParameters($result, $typoScript);
        }, null, EditDocumentController::class);
        $mock(new ‪EditDocumentController(
            $eventDispatcher->reveal(),
            $iconFactory->reveal(),
            $pageRenderer->reveal(),
            $uriBuilder->reveal(),
            $moduleTemplateFactory->reveal()
        ));
 
        self::assertSame($expectedParameters, $result);
    }
 
    public function ‪slugDependentFieldsAreAddedToColumnsOnly(string $result, string $selectedFields, string $tableName, array $configuration): void
    {
        ‪$GLOBALS['TCA'][$tableName]['columns'] = $configuration;
 
        $editDocumentControllerMock = $this->getAccessibleMock(EditDocumentController::class, ['dummy'], [], '', false);
        $editDocumentControllerMock->_set('columnsOnly', $selectedFields);
        $queryParams = [
            'edit' => [
                $tableName => [
                    '123,456' => 'edit',
                ],
            ],
        ];
        $editDocumentControllerMock->_call('addSlugFieldsToColumnsOnly', $queryParams);
 
        self::assertEquals($result, $editDocumentControllerMock->_get('columnsOnly'));
    }
 
    public function ‪slugDependentFieldsAreAddedToColumnsOnlyDataProvider(): array
    {
        return [
            'fields in string' => [
                'fo,bar,slug,title',
                'fo,bar,slug',
                'fake',
                [
                    'slug' => [
                        'config' => [
                            'type' => 'slug',
                            'generatorOptions' => [
                                'fields' => ['title'],
                            ],
                        ],
                    ],
                ],
            ],
            'fields in string and array' => [
                'slug,fo,title,nav_title,title,other_field',
                'slug,fo,title',
                'fake',
                [
                    'slug' => [
                        'config' => [
                            'type' => 'slug',
                            'generatorOptions' => [
                                'fields' => [['nav_title', 'title'], 'other_field'],
                            ],
                        ],
                    ],
                ],
            ],
            'no slug field given' => [
                'slug,fo',
                'slug,fo',
                'fake',
                [
                    'slug' => [
                        'config' => [
                            'type' => 'input',
                            'generatorOptions' => [
                                'fields' => [['nav_title', 'title'], 'other_field'],
                            ],
                        ],
                    ],
                ],
            ],
        ];
    }
 
    public function ‪resolvePreviewRecordIdDataProvider(): array
    {
        return [
            'default useDefaultLanguageRecord' => [
                1,
                [],
            ],
            'explicit useDefaultLanguageRecord' => [
                1,
                ['useDefaultLanguageRecord' => '1'],
            ],
            'useDefaultLanguageRecord = 0' => [
                2,
                ['useDefaultLanguageRecord' => '0'],
            ],
        ];
    }
 
    public function ‪resolvePreviewRecordIdReturnsExpectedUid(int $expected, array $previewConfiguration): void
    {
        $recordArray = ['uid' => 2, 'l10n_parent' => 1];
        $table = 'pages';
        ‪$GLOBALS['TCA'][$table]['ctrl']['transOrigPointerField'] = 'l10n_parent';
 
        $mock = $this->getAccessibleMock(EditDocumentController::class, ['dummy'], [], '', false);
        $result = $mock->_call('resolvePreviewRecordId', $table, $recordArray, $previewConfiguration);
        self::assertSame($expected, $result);
    }
 
    public function ‪resolvePreviewRecordIdForNonTranslatableTableDataProvider(): array
    {
        return [
            'default useDefaultLanguageRecord' => [
                2,
                [],
            ],
            'explicit useDefaultLanguageRecord' => [
                2,
                ['useDefaultLanguageRecord' => '1'],
            ],
            'useDefaultLanguageRecord = 0' => [
                2,
                ['useDefaultLanguageRecord' => '0'],
            ],
        ];
    }
 
    public function ‪resolvePreviewRecordIdReturnsExpectedUidForNonTranslatableTable(int $expected, array $previewConfiguration): void
    {
        $recordArray = ['uid' => 2];
        $table = 'dummy_table';
 
        $mock = $this->getAccessibleMock(EditDocumentController::class, ['dummy'], [], '', false);
        $result = $mock->_call('resolvePreviewRecordId', $table, $recordArray, $previewConfiguration);
        self::assertSame($expected, $result);
    }
}