LocalizationUtilityTest.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\Utility;
 
use Prophecy\Argument;
use Prophecy\PhpUnit\ProphecyTrait;
use Prophecy\Prophecy\ObjectProphecy;
use ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
use ‪TYPO3\CMS\Core\Cache\CacheManager;
use ‪TYPO3\CMS\Core\Cache\Frontend\FrontendInterface;
use ‪TYPO3\CMS\Core\Localization\LanguageService;
use ‪TYPO3\CMS\Core\Localization\LanguageStore;
use ‪TYPO3\CMS\Core\Localization\Locales;
use ‪TYPO3\CMS\Core\Localization\LocalizationFactory;
use TYPO3\CMS\Core\Package\PackageManager;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface;
use ‪TYPO3\CMS\Extbase\Utility\LocalizationUtility;
use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
class ‪LocalizationUtilityTest extends UnitTestCase
{
    use ProphecyTrait;
 
    protected ObjectProphecy ‪$configurationManagerInterfaceProphecy;
 
    protected array ‪$LOCAL_LANG = [];
 
    protected string ‪$languageFilePath = '';
 
    protected function ‪setUp(): void
    {
        parent::setUp();
        $this->languageFilePath = $this->‪getLanguageFilePath('core');
        $this->LOCAL_LANG = [
            $this->languageFilePath => [
                'default' => [
                    'key1' => [
                        [
                            'source' => 'English label for key1',
                            'target' => 'English label for key1',
                        ],
                    ],
                    'key2' => [
                        [
                            'source' => 'English label for key2',
                            'target' => 'English label for key2',
                        ],
                    ],
                    'key3' => [
                        [
                            'source' => 'English label for key3',
                            'target' => 'English label for key3',
                        ],
                    ],
                    'key4' => [
                        [
                            'source' => 'English label for key4',
                            'target' => 'English label for key4',
                        ],
                    ],
                    'keyWithPlaceholder' => [
                        [
                            'source' => 'English label with number %d',
                            'target' => 'English label with number %d',
                        ],
                    ],
                    'keyWithPlaceholderAndNoArguments' => [
                        [
                            'source' => '%d/%m/%Y',
                            'target' => '%d/%m/%Y',
                        ],
                    ],
                ],
                'dk' => [
                    'key1' => [
                        [
                            'source' => 'English label for key1',
                            'target' => 'Dansk label for key1',
                        ],
                    ],
                    // not translated in dk => no target (llxml)
                    'key2' => [
                        [
                            'source' => 'English label for key2',
                        ],
                    ],
                    'key3' => [
                        [
                            'source' => 'English label for key3',
                        ],
                    ],
                    // not translated in dk => empty target (xliff)
                    'key4' => [
                        [
                            'source' => 'English label for key4',
                            'target' => '',
                        ],
                    ],
                    // not translated in dk => empty target (xliff)
                    'key5' => [
                        [
                            'source' => 'English label for key5',
                            'target' => '',
                        ],
                    ],
                    'keyWithPlaceholder' => [
                        [
                            'source' => 'English label with number %d',
                        ],
                    ],
                    'keyWithPlaceholderAndNoArguments' => [
                        [
                            'source' => '%d/%m/%Y',
                            'target' => '%d-%m-%Y',
                        ],
                    ],
                ],
                // fallback language for labels which are not translated in dk
                'dk_alt' => [
                    'key1' => [
                        [
                            'source' => 'English label for key1',
                        ],
                    ],
                    'key2' => [
                        [
                            'source' => 'English label for key2',
                            'target' => 'Dansk alternative label for key2',
                        ],
                    ],
                    'key3' => [
                        [
                            'source' => 'English label for key3',
                        ],
                    ],
                    // not translated in dk_alt => empty target (xliff)
                    'key4' => [
                        [
                            'source' => 'English label for key4',
                            'target' => '',
                        ],
                    ],
                    'key5' => [
                        [
                            'source' => 'English label for key5',
                            'target' => 'Dansk alternative label for key5',
                        ],
                    ],
                    'keyWithPlaceholder' => [
                        [
                            'source' => 'English label with number %d',
                        ],
                    ],
                ],
 
            ],
        ];
 
        $reflectionClass = new \ReflectionClass(LocalizationUtility::class);
 
        $this->configurationManagerInterfaceProphecy = $this->prophesize(ConfigurationManagerInterface::class);
        $property = $reflectionClass->getProperty('configurationManager');
        $property->setAccessible(true);
        $property->setValue(null, $this->configurationManagerInterfaceProphecy->reveal());
 
        $localizationFactoryProphecy = $this->prophesize(LocalizationFactory::class);
        GeneralUtility::setSingletonInstance(LocalizationFactory::class, $localizationFactoryProphecy->reveal());
        $localizationFactoryProphecy->getParsedData(Argument::cetera(), 'foo')->willReturn([]);
    }
 
    protected function ‪tearDown(): void
    {
        $reflectionClass = new \ReflectionClass(LocalizationUtility::class);
 
        $property = $reflectionClass->getProperty('configurationManager');
        $property->setAccessible(true);
        $property->setValue(null, null);
 
        $property = $reflectionClass->getProperty('LOCAL_LANG');
        $property->setAccessible(true);
        $property->setValue(null, []);
 
        GeneralUtility::purgeInstances();
 
        parent::tearDown();
    }
 
    protected function ‪getLanguageFilePath(string $extensionName): string
    {
        return  'EXT:' . $extensionName . '/Resources/Private/Language/locallang.xlf';
    }
 
    public function ‪implodeTypoScriptLabelArrayWorks(): void
    {
        $reflectionClass = new \ReflectionClass(LocalizationUtility::class);
        $method = $reflectionClass->getMethod('flattenTypoScriptLabelArray');
        $method->setAccessible(true);
 
        $expected = [
            'key1' => 'value1',
            'key2' => 'value2',
            'key3' => 'value3',
            'key3.subkey1' => 'subvalue1',
            'key3.subkey2.subsubkey' => 'val',
        ];
        $input = [
            'key1' => 'value1',
            'key2' => 'value2',
            'key3' => [
                '_typoScriptNodeValue' => 'value3',
                'subkey1' => 'subvalue1',
                'subkey2' => [
                    'subsubkey' => 'val',
                ],
            ],
        ];
        $result = $method->invoke(null, $input);
        self::assertEquals($expected, $result);
    }
 
    public function ‪translateForEmptyStringKeyReturnsNull(): void
    {
        self::assertNull(‪LocalizationUtility::translate('', 'extbase'));
    }
 
    public function ‪translateForEmptyStringKeyWithArgumentsReturnsNull(): void
    {
        self::assertNull(‪LocalizationUtility::translate('', 'extbase', ['argument']));
    }
 
    public function ‪translateDataProvider(): array
    {
        return [
            'get translated key' =>
            ['key1', 'dk', 'Dansk label for key1'],
 
            'fallback to English when translation is missing for key' =>
            ['key2', 'dk', 'English label for key2'],
 
            'fallback to English for non existing language' =>
            ['key2', 'xx', 'English label for key2'],
 
            'replace placeholder with argument' =>
            ['keyWithPlaceholder', 'default', 'English label with number 100', [], [100]],
 
            'placeholder and empty arguments in default' =>
            ['keyWithPlaceholderAndNoArguments', 'default', '%d/%m/%Y', [], []],
 
            'placeholder and empty arguments in translation' =>
            ['keyWithPlaceholderAndNoArguments', 'dk', '%d-%m-%Y', [], []],
 
            'get translated key from primary language' =>
            ['key1', 'dk', 'Dansk label for key1', ['dk_alt']],
 
            'fallback to alternative language if translation is missing(llxml)' =>
            ['key2', 'dk', 'Dansk alternative label for key2', ['dk_alt']],
 
            'fallback to alternative language if translation is missing(xlif)' =>
            ['key5', 'dk', 'Dansk alternative label for key5', ['dk_alt']],
 
            'fallback to English for label not translated in dk and dk_alt(llxml)' =>
            ['key3', 'dk', 'English label for key3', ['dk_alt']],
 
            'fallback to English for label not translated in dk and dk_alt(xlif)' =>
            ['key4', 'dk', 'English label for key4', ['dk_alt']],
        ];
    }
 
    public function ‪translateTestWithBackendUserLanguage($key, $languageKey, $expected, array $altLanguageKeys = [], array $arguments = null): void
    {
        $this->configurationManagerInterfaceProphecy
            ->getConfiguration('Framework', 'core', null)
            ->willReturn([]);
 
        $reflectionClass = new \ReflectionClass(LocalizationUtility::class);
 
        $property = $reflectionClass->getProperty('LOCAL_LANG');
        $property->setAccessible(true);
        $property->setValue(null, $this->LOCAL_LANG);
 
        $backendUserAuthenticationProphecy = $this->prophesize(BackendUserAuthentication::class);
        $backendUserAuthentication = $backendUserAuthenticationProphecy->reveal();
        $backendUserAuthentication->user = [
            'lang' => $languageKey,
        ];
        ‪$GLOBALS['BE_USER'] = $backendUserAuthentication;
        ‪$GLOBALS['LANG'] = ‪$this->LOCAL_LANG;
 
        self::assertEquals($expected, ‪LocalizationUtility::translate($key, 'core', $arguments, null, $altLanguageKeys));
    }
 
    public function ‪translateTestWithExplicitLanguageParameters($key, $languageKey, $expected, array $altLanguageKeys = [], array $arguments = null): void
    {
        $packageManagerProphecy = $this->prophesize(PackageManager::class);
        $this->configurationManagerInterfaceProphecy
            ->getConfiguration('Framework', 'core', null)
            ->willReturn([]);
 
        $reflectionClass = new \ReflectionClass(LocalizationUtility::class);
 
        $property = $reflectionClass->getProperty('LOCAL_LANG');
        $property->setAccessible(true);
        $property->setValue(null, $this->LOCAL_LANG);
        $cacheManagerProphecy = $this->prophesize(CacheManager::class);
        $cacheFrontendProphecy = $this->prophesize(FrontendInterface::class);
        $cacheManagerProphecy->getCache('l10n')->willReturn($cacheFrontendProphecy->reveal());
        $cacheFrontendProphecy->get(Argument::cetera())->willReturn(false);
        $cacheFrontendProphecy->set(Argument::cetera())->willReturn(null);
        ‪$GLOBALS['LANG'] = new ‪LanguageService(new ‪Locales(), new ‪LocalizationFactory(new ‪LanguageStore($packageManagerProphecy->reveal()), $cacheManagerProphecy->reveal()), $cacheFrontendProphecy->reveal());
        self::assertEquals($expected, ‪LocalizationUtility::translate($key, 'core', $arguments, $languageKey, $altLanguageKeys));
    }
 
    public function ‪loadTypoScriptLabelsProvider(): array
    {
        return [
            'override labels with typoscript' => [
                'LOCAL_LANG' => [
                    $this->‪getLanguageFilePath('core') => [
                        'dk' => [
                            'key1' => [
                                [
                                    'source' => 'English label for key1',
                                    'target' => 'Dansk label for key1 core',
                                ],
                            ],
                            'key2' => [
                                [
                                    'source' => 'English label for key2',
                                ],
                            ],
                            'key3.subkey1' => [
                                [
                                    'source' => 'English label for key3',
                                ],
                            ],
                        ],
                    ],
                    $this->‪getLanguageFilePath('backend') => [
                        'dk' => [
                            'key1' => [
                                [
                                    'source' => 'English label for key1',
                                    'target' => 'Dansk label for key1 backend',
                                ],
                            ],
                            'key2' => [
                                [
                                    'source' => 'English label for key2',
                                ],
                            ],
                            'key3.subkey1' => [
                                [
                                    'source' => 'English label for key3',
                                ],
                            ],
                        ],
                    ],
                ],
                'typoscript LOCAL_LANG' => [
                    '_LOCAL_LANG' => [
                        'dk' => [
                            'key1' => 'key1 value from TS core',
                            'key3' => [
                                'subkey1' => 'key3.subkey1 value from TS core',
                                // this key doesn't exist in xml files
                                'subkey2' => [
                                    'subsubkey' => 'key3.subkey2.subsubkey value from TS core',
                                ],
                            ],
                        ],
                    ],
                ],
                'language key' => 'dk',
                'expected' => [
                    'key1' => [
                        [
                            'source' => 'English label for key1',
                            'target' => 'key1 value from TS core',
                        ],
                    ],
                    'key2' => [
                        [
                            'source' => 'English label for key2',
                        ],
                    ],
                    'key3.subkey1' => [
                        [
                            'source' => 'English label for key3',
                            'target' => 'key3.subkey1 value from TS core',
                        ],
                    ],
                    'key3.subkey2.subsubkey' => [
                        [
                            'target' => 'key3.subkey2.subsubkey value from TS core',
                        ],
                    ],
                ],
            ],
        ];
    }
 
    public function ‪loadTypoScriptLabels(array ‪$LOCAL_LANG, array $typoScriptLocalLang, $languageKey, array $expected): void
    {
        $reflectionClass = new \ReflectionClass(LocalizationUtility::class);
 
        $property = $reflectionClass->getProperty('LOCAL_LANG');
        $property->setAccessible(true);
        $property->setValue(null, ‪$LOCAL_LANG);
 
        $configurationType = ‪ConfigurationManagerInterface::CONFIGURATION_TYPE_FRAMEWORK;
        $this->configurationManagerInterfaceProphecy
            ->getConfiguration($configurationType, 'core', null)
            ->shouldBeCalled()
            ->willReturn($typoScriptLocalLang);
 
        $method = $reflectionClass->getMethod('loadTypoScriptLabels');
        $method->setAccessible(true);
        $method->invoke(null, 'core', $this->languageFilePath);
 
        $property = $reflectionClass->getProperty('LOCAL_LANG');
        $property->setAccessible(true);
        $result = $property->getValue();
 
        self::assertEquals($expected, $result[$this->languageFilePath][$languageKey]);
    }
 
    public function ‪clearLabelWithTypoScript(): void
    {
        $packageManagerProphecy = $this->prophesize(PackageManager::class);
        $reflectionClass = new \ReflectionClass(LocalizationUtility::class);
 
        $property = $reflectionClass->getProperty('LOCAL_LANG');
        $property->setAccessible(true);
        $property->setValue(null, $this->LOCAL_LANG);
 
        $typoScriptLocalLang = [
            '_LOCAL_LANG' => [
                'dk' => [
                    'key1' => '',
                ],
            ],
        ];
 
        $configurationType = ‪ConfigurationManagerInterface::CONFIGURATION_TYPE_FRAMEWORK;
        $this->configurationManagerInterfaceProphecy
            ->getConfiguration($configurationType, 'core', null)
            ->shouldBeCalled()
            ->willReturn($typoScriptLocalLang);
 
        $method = $reflectionClass->getMethod('loadTypoScriptLabels');
        $method->setAccessible(true);
        $method->invoke(null, 'core', $this->languageFilePath);
 
        $cacheManagerProphecy = $this->prophesize(CacheManager::class);
        $cacheFrontendProphecy = $this->prophesize(FrontendInterface::class);
        $cacheManagerProphecy->getCache('l10n')->willReturn($cacheFrontendProphecy->reveal());
        $cacheFrontendProphecy->get(Argument::cetera())->willReturn(false);
        $cacheFrontendProphecy->set(Argument::cetera())->willReturn(null);
        ‪$GLOBALS['LANG'] = new ‪LanguageService(new ‪Locales(), new ‪LocalizationFactory(new ‪LanguageStore($packageManagerProphecy->reveal()), $cacheManagerProphecy->reveal()), $cacheFrontendProphecy->reveal());
 
        $result = ‪LocalizationUtility::translate('key1', 'core', null, 'dk');
        self::assertNotNull($result);
        self::assertEquals('', $result);
    }
 
    public function ‪translateThrowsExceptionWithEmptyExtensionNameIfKeyIsNotPrefixedWithLLL(): void
    {
        $this->expectException(\InvalidArgumentException::class);
        $this->expectExceptionCode(1498144052);
        ‪LocalizationUtility::translate('foo/bar', '');
    }
 
    public function ‪translateWillReturnLabelsFromTsEvenIfNoXlfFileExists(): void
    {
        $packageManagerProphecy = $this->prophesize(PackageManager::class);
        $reflectionClass = new \ReflectionClass(LocalizationUtility::class);
 
        $typoScriptLocalLang = [
            '_LOCAL_LANG' => [
                'dk' => [
                    'key1' => 'I am a new key and there is no xlf file',
                ],
            ],
        ];
 
        $configurationType = ‪ConfigurationManagerInterface::CONFIGURATION_TYPE_FRAMEWORK;
        $this->configurationManagerInterfaceProphecy
            ->getConfiguration($configurationType, 'core', null)
            ->shouldBeCalled()
            ->willReturn($typoScriptLocalLang);
 
        $method = $reflectionClass->getMethod('loadTypoScriptLabels');
        $method->setAccessible(true);
        $method->invoke(null, 'core', ''); // setting the language file path to an empty string here
 
        $cacheManagerProphecy = $this->prophesize(CacheManager::class);
        $cacheFrontendProphecy = $this->prophesize(FrontendInterface::class);
        $cacheManagerProphecy->getCache('l10n')->willReturn($cacheFrontendProphecy->reveal());
        $cacheFrontendProphecy->get(Argument::cetera())->willReturn(false);
        $cacheFrontendProphecy->set(Argument::cetera())->willReturn(null);
        ‪$GLOBALS['LANG'] = new ‪LanguageService(new ‪Locales(), new ‪LocalizationFactory(new ‪LanguageStore($packageManagerProphecy->reveal()), $cacheManagerProphecy->reveal()), $cacheFrontendProphecy->reveal());
 
        $result = ‪LocalizationUtility::translate('key1', 'core', null, 'dk');
        self::assertNotNull($result);
        self::assertEquals('I am a new key and there is no xlf file', $result);
    }
}