LocalizationControllerTest.php

Go to the documentation of this file.

<?php
declare(strict_types = 1);
 
namespace ‪TYPO3\CMS\Backend\Tests\Functional\Controller\Page;
 
/*
 * 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!
 */
 
use ‪TYPO3\CMS\Backend\Controller\Page\LocalizationController;
use ‪TYPO3\CMS\Core\Core\Bootstrap;
use ‪TYPO3\CMS\Core\DataHandling\DataHandler;
use ‪TYPO3\CMS\Core\Http\ServerRequest;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\TestingFramework\Core\Functional\Framework\DataHandling\ActionService;
 
class ‪LocalizationControllerTest extends \TYPO3\TestingFramework\Core\Functional\FunctionalTestCase
{
    protected ‪$assertionDataSetDirectory = 'typo3/sysext/backend/Tests/Functional/Controller/Page/Localization/CSV/DataSet/';
 
    protected ‪$subject;
 
    protected ‪$actionService;
 
    protected ‪$backendUser;
 
    protected ‪$coreExtensionsToLoad = ['workspaces'];
 
    protected function ‪setUp(): void
    {
        parent::setUp();
 
        $this->backendUser = $this->setUpBackendUserFromFixture(1);
        $this->backendUser->workspace = 0;
 
        ‪Bootstrap::initializeLanguageObject();
        $this->actionService = GeneralUtility::makeInstance(ActionService::class);
 
        $this->importDataSet(__DIR__ . '/Fixtures/pages.xml');
        $this->importDataSet('PACKAGE:typo3/testing-framework/Resources/Core/Functional/Fixtures/sys_language.xml');
        $this->importDataSet(ORIGINAL_ROOT . 'typo3/sysext/backend/Tests/Functional/Controller/Page/Fixtures/tt_content-default-language.xml');
 
        $this->subject = $this->getMockBuilder(LocalizationController::class)
            ->setMethods(['getPageColumns'])
            ->getMock();
    }
 
    public function ‪recordsGetTranslatedFromDefaultLanguage(): void
    {
        $params = [
            'pageId' => 1,
            'srcLanguageId' => 0,
            'destLanguageId' => 1,
            'uidList' => [1, 2, 3],
            'action' => ‪LocalizationController::ACTION_LOCALIZE,
        ];
        $this->callInaccessibleMethod($this->subject, 'process', $params);
        $this->‪assertAssertionDataSet('TranslatedFromDefault');
    }
 
    public function ‪recordsGetTranslatedFromDifferentTranslation(): void
    {
        $this->importDataSet(ORIGINAL_ROOT . 'typo3/sysext/backend/Tests/Functional/Controller/Page/Fixtures/tt_content-danish-language.xml');
 
        $params = [
            'pageId' => 1,
            'srcLanguageId' => 1,
            'destLanguageId' => 2,
            'uidList' => [4, 5, 6], // uids of tt_content-danish-language
            'action' => ‪LocalizationController::ACTION_LOCALIZE,
        ];
        $this->callInaccessibleMethod($this->subject, 'process', $params);
        $this->‪assertAssertionDataSet('TranslatedFromTranslation');
    }
 
    public function ‪recordsGetCopiedFromDefaultLanguage(): void
    {
        $params = [
            'pageId' => 1,
            'srcLanguageId' => 0,
            'destLanguageId' => 2,
            'uidList' => [1, 2, 3],
            'action' => ‪LocalizationController::ACTION_COPY,
        ];
        $this->callInaccessibleMethod($this->subject, 'process', $params);
        $this->‪assertAssertionDataSet('CopiedFromDefault');
    }
 
    public function ‪recordsGetCopiedFromAnotherLanguage(): void
    {
        $this->importDataSet(ORIGINAL_ROOT . 'typo3/sysext/backend/Tests/Functional/Controller/Page/Fixtures/tt_content-danish-language.xml');
 
        $params = [
            'pageId' => 1,
            'srcLanguageId' => 1,
            'destLanguageId' => 2,
            'uidList' => [4, 5, 6], // uids of tt_content-danish-language
            'action' => ‪LocalizationController::ACTION_COPY,
        ];
        $this->callInaccessibleMethod($this->subject, 'process', $params);
        $this->‪assertAssertionDataSet('CopiedFromTranslation');
    }
 
    public function ‪copyingNewContentFromLanguageIntoExistingLocalizationHasSameOrdering(): void
    {
        $params = [
            'pageId' => 1,
            'srcLanguageId' => 0,
            'destLanguageId' => 1,
            'uidList' => [1, 2, 3],
            'action' => ‪LocalizationController::ACTION_COPY,
        ];
        $this->callInaccessibleMethod($this->subject, 'process', $params);
 
        // Create another content element in default language
        $data = [
            'tt_content' => [
                'NEW123456' => [
                    'sys_language_uid' => 0,
                    'header' => 'Test content 2.5',
                    'pid' => -2,
                    'colPos' => 0,
                ],
            ],
        ];
        $dataHandler = new DataHandler();
        $dataHandler->start($data, []);
        $dataHandler->process_datamap();
        $dataHandler->process_cmdmap();
        $newContentElementUid = $dataHandler->substNEWwithIDs['NEW123456'];
 
        // Copy the new content element
        $params = [
            'pageId' => 1,
            'srcLanguageId' => 0,
            'destLanguageId' => 1,
            'uidList' => [$newContentElementUid],
            'action' => ‪LocalizationController::ACTION_COPY,
        ];
        $this->callInaccessibleMethod($this->subject, 'process', $params);
        $this->‪assertAssertionDataSet('CreatedElementOrdering');
    }
 
    public function ‪defaultLanguageIsFoundAsOriginLanguage(): void
    {
        $this->importDataSet(ORIGINAL_ROOT . 'typo3/sysext/backend/Tests/Functional/Controller/Page/Fixtures/tt_content-danish-language.xml');
 
        // Create another content element in default language
        $data = [
            'tt_content' => [
                'NEW123456' => [
                    'sys_language_uid' => 0,
                    'header' => 'New content element',
                    'pid' => 1,
                    'colPos' => 0,
                ],
            ],
        ];
        $dataHandler = new ‪DataHandler();
        $dataHandler->start($data, []);
        $dataHandler->process_datamap();
        $dataHandler->process_cmdmap();
 
        $request = (new ‪ServerRequest())->withQueryParams([
            'pageId'         => 1, // page uid, the records are stored on
            'languageId'     => 1  // current language id
        ]);
 
        $usedLanguages = (string)$this->subject->getUsedLanguagesInPage($request)->getBody();
        $this->assertThat($usedLanguages, $this->stringContains('"uid":0'));
    }
 
    public function ‪recordLocalizeSummaryRespectsWorkspaceEncapsulationForDeletedRecords(): void
    {
        // Delete record 2 within workspace 1
        $this->backendUser->workspace = 1;
        $this->actionService->deleteRecord('tt_content', 2);
 
        $expectedRecords = [
            '0' => [
                ['uid' => 1],
            ],
            '1' => [
                ['uid' => 3],
            ],
        ];
 
        $localizeSummary = $this->‪getReducedRecordLocalizeSummary();
 
        $this->assertEquals($expectedRecords, $localizeSummary);
    }
 
    public function ‪recordLocalizeSummaryRespectsWorkspaceEncapsulationForMovedRecords(): void
    {
        // Move record 2 to page 2 within workspace 1
        $this->backendUser->workspace = 1;
        $this->actionService->moveRecord('tt_content', 2, 2);
 
        $expectedRecords = [
            '0' => [
                ['uid' => 1],
            ],
            '1' => [
                ['uid' => 3],
            ],
        ];
 
        $localizeSummary = $this->‪getReducedRecordLocalizeSummary();
 
        $this->assertEquals($expectedRecords, $localizeSummary);
    }
 
    protected function ‪getReducedRecordLocalizeSummary(): array
    {
        $request = (new ‪ServerRequest())->withQueryParams([
            'pageId'         => 1, // page uid, the records are stored on
            'destLanguageId' => 1, // destination language uid
            'languageId'     => 0  // source language uid
        ]);
 
        $this->subject->method('getPageColumns')->willReturn([
            0 => 'Column 0',
            1 => 'Column 1',
        ]);
 
        $recordLocalizeSummaryResponse = $this->subject->getRecordLocalizeSummary($request);
 
        // Reduce the fetched record summary to list of uids
        if ($recordLocalizeSummary = json_decode((string)$recordLocalizeSummaryResponse->getBody(), true)) {
            foreach ($recordLocalizeSummary['records'] as $colPos => $records) {
                foreach ($records as $key => $record) {
                    $recordLocalizeSummary['records'][$colPos][$key] = array_intersect_key($record, ['uid' => '']);
                }
            }
        }
 
        return $recordLocalizeSummary['records'];
    }
 
    protected function ‪assertAssertionDataSet(string $dataSetName)
    {
        $fileName = rtrim($this->assertionDataSetDirectory, '/') . '/' . $dataSetName . '.csv';
        $fileName = GeneralUtility::getFileAbsFileName($fileName);
        $this->assertCSVDataSet($fileName);
    }
}