LocalizationUtilityTest.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Extbase\Tests\Unit\Utility;

use \TYPO3\CMS\Extbase\Utility\LocalizationUtility;

class LocalizationUtilityTest extends \TYPO3\CMS\Core\Tests\UnitTestCase {

    protected $configurationManagerMock;

    protected $LOCAL_LANG = array(
        'extensionKey' => array(
            'default' => array(
                'key1' => array(
                    array(
                        'source' => 'English label for key1',
                        'target' => 'English label for key1',
                    )
                ),
                'key2' => array(
                    array(
                        'source' => 'English label for key2',
                        'target' => 'English label for key2',
                    )
                ),
                'key3' => array(
                    array(
                        'source' => 'English label for key3',
                        'target' => 'English label for key3',
                    )
                ),
                'key4' => array(
                    array(
                        'source' => 'English label for key4',
                        'target' => 'English label for key4',
                    )
                ),
                'keyWithPlaceholder' => array(
                    array(
                        'source' => 'English label with number %d',
                        'target' => 'English label with number %d',
                    )
                ),
            ),
            'dk' => array(
                'key1' => array(
                    array(
                        'source' => 'English label for key1',
                        'target' => 'Dansk label for key1',
                    )
                ),
                // not translated in dk => no target (llxml)
                'key2' => array(
                    array(
                        'source' => 'English label for key2',
                    )
                ),
                'key3' => array(
                    array(
                        'source' => 'English label for key3',
                    )
                ),
                // not translated in dk => empty target (xliff)
                'key4' => array(
                    array(
                        'source' => 'English label for key4',
                        'target' => '',
                    )
                ),
                // not translated in dk => empty target (xliff)
                'key5' => array(
                    array(
                        'source' => 'English label for key5',
                        'target' => '',
                    )
                ),
                'keyWithPlaceholder' => array(
                    array(
                        'source' => 'English label with number %d',
                    )
                ),
            ),
            // fallback language for labels which are not translated in dk
            'dk_alt' => array(
                'key1' => array(
                    array(
                        'source' => 'English label for key1',
                    )
                ),
                'key2' => array(
                    array(
                        'source' => 'English label for key2',
                        'target' => 'Dansk alternative label for key2',
                    )
                ),
                'key3' => array(
                    array(
                        'source' => 'English label for key3',
                    )
                ),
                // not translated in dk_alt => empty target (xliff)
                'key4' => array(
                    array(
                        'source' => 'English label for key4',
                        'target' => '',
                    )
                ),
                'key5' => array(
                    array(
                        'source' => 'English label for key5',
                        'target' => 'Dansk alternative label for key5',
                    )
                ),
                'keyWithPlaceholder' => array(
                    array(
                        'source' => 'English label with number %d',
                    )
                ),
            ),

        ),
    );

    public function setUp() {
        $reflectionClass = new \ReflectionClass('TYPO3\\CMS\\Extbase\\Utility\\LocalizationUtility');

        $this->configurationManager = $this->getAccessibleMock('TYPO3\\CMS\\Extbase\\Configuration\\ConfigurationManager', array('getConfiguration'));
        $property = $reflectionClass->getProperty('configurationManager');
        $property->setAccessible(TRUE);
        $property->setValue($this->configurationManager);
    }

    public function tearDown() {
        $reflectionClass = new \ReflectionClass('TYPO3\\CMS\\Extbase\\Utility\\LocalizationUtility');

        $property = $reflectionClass->getProperty('configurationManager');
        $property->setAccessible(TRUE);
        $property->setValue(NULL);

        $property = $reflectionClass->getProperty('LOCAL_LANG');
        $property->setAccessible(TRUE);
        $property->setValue(array());

        $property = $reflectionClass->getProperty('languageKey');
        $property->setAccessible(TRUE);
        $property->setValue('default');

        $property = $reflectionClass->getProperty('alternativeLanguageKeys');
        $property->setAccessible(TRUE);
        $property->setValue(array());
    }

    public function implodeTypoScriptLabelArrayWorks() {
        $reflectionClass = new \ReflectionClass('TYPO3\\CMS\\Extbase\\Utility\\LocalizationUtility');
        $method = $reflectionClass->getMethod('flattenTypoScriptLabelArray');
        $method->setAccessible(TRUE);

        $expected = array(
            'key1' => 'value1',
            'key2' => 'value2',
            'key3.subkey1' => 'subvalue1',
            'key3.subkey2.subsubkey' => 'val'
        );
        $input = array(
            'key1' => 'value1',
            'key2' => 'value2',
            'key3' => array(
                'subkey1' => 'subvalue1',
                'subkey2' => array(
                    'subsubkey' => 'val'
                )
            )
        );
        $result = $method->invoke(NULL, $input);
        $this->assertEquals($expected, $result);
    }

    public function translateForEmptyStringKeyReturnsNull() {
        $this->assertNull(LocalizationUtility::translate('', 'extbase'));
    }

    public function translateForEmptyStringKeyWithArgumentsReturnsNull() {
        $this->assertNull(LocalizationUtility::translate('', 'extbase', array('argument')));
    }

    public function translateDataProvider() {
        return array(
            'get translated key' =>
            array('key1', $this->LOCAL_LANG, 'dk', 'Dansk label for key1'),

            'fallback to English when translation is missing for key' =>
            array('key2', $this->LOCAL_LANG, 'dk', 'English label for key2'),

            'fallback to English for non existing language' =>
            array('key2', $this->LOCAL_LANG, 'xx', 'English label for key2'),

            'replace placeholder with argument' =>
            array('keyWithPlaceholder', $this->LOCAL_LANG, 'en', 'English label with number 100', array(), array(100)),

            'get translated key from primary language' =>
            array('key1', $this->LOCAL_LANG, 'dk', 'Dansk label for key1', array('dk_alt')),

            'fallback to alternative language if translation is missing(llxml)' =>
            array('key2', $this->LOCAL_LANG, 'dk', 'Dansk alternative label for key2', array('dk_alt')),

            'fallback to alternative language if translation is missing(xlif)' =>
            array('key5', $this->LOCAL_LANG, 'dk', 'Dansk alternative label for key5', array('dk_alt')),

            'fallback to English for label not translated in dk and dk_alt(llxml)' =>
            array('key3', $this->LOCAL_LANG, 'dk', 'English label for key3', array('dk_alt')),

            'fallback to English for label not translated in dk and dk_alt(xlif)' =>
            array('key4', $this->LOCAL_LANG, 'dk', 'English label for key4', array('dk_alt')),
        );
    }

    public function translateTest($key, array $LOCAL_LANG, $languageKey, $expected, array $altLanguageKeys = array(), array $arguments = NULL) {
        $reflectionClass = new \ReflectionClass('TYPO3\\CMS\\Extbase\\Utility\\LocalizationUtility');

        $property = $reflectionClass->getProperty('LOCAL_LANG');
        $property->setAccessible(TRUE);
        $property->setValue($LOCAL_LANG);

        $property = $reflectionClass->getProperty('languageKey');
        $property->setAccessible(TRUE);
        $property->setValue($languageKey);

        $property = $reflectionClass->getProperty('alternativeLanguageKeys');
        $property->setAccessible(TRUE);
        $property->setValue($altLanguageKeys);

        $this->assertEquals($expected, LocalizationUtility::translate($key, 'extensionKey', $arguments));
    }

    public function loadTypoScriptLabelsProvider() {
        return array(
            'override labels with typoscript' => array(
                'LOCAL_LANG' => array(
                    'extensionKey' => array(
                        'dk' => array(
                            'key1' => array(
                                array(
                                    'source' => 'English label for key1',
                                    'target' => 'Dansk label for key1 extensionKey',
                                )
                            ),
                            'key2' => array(
                                array(
                                    'source' => 'English label for key2',
                                )
                            ),
                            'key3.subkey1' => array(
                                array(
                                    'source' => 'English label for key3',
                                )
                            ),
                        ),
                    ),
                    'extensionKey1' => array(
                        'dk' => array(
                            'key1' => array(
                                array(
                                    'source' => 'English label for key1',
                                    'target' => 'Dansk label for key1 extensionKey1',
                                )
                            ),
                            'key2' => array(
                                array(
                                    'source' => 'English label for key2',
                                )
                            ),
                            'key3.subkey1' => array(
                                array(
                                    'source' => 'English label for key3',
                                )
                            ),
                        ),
                    ),
                ),
                'typoscript LOCAL_LANG' => array(
                    '_LOCAL_LANG' => array(
                        'dk' => array(
                            'key1' => 'key1 value from TS extensionKey',
                            'key3' => array(
                                'subkey1' => 'key3.subkey1 value from TS extensionKey',
                                // this key doesn't exist in xml files
                                'subkey2' => array(
                                    'subsubkey' => 'key3.subkey2.subsubkey value from TS extensionKey'
                                )
                            )
                        )
                    )
                ),
                'language key' => 'dk',
                'expected' => array(
                    'key1' => array(
                        array(
                            'source' => 'English label for key1',
                            'target' => 'key1 value from TS extensionKey',
                        )
                    ),
                    'key2' => array(
                        array(
                            'source' => 'English label for key2',
                        )
                    ),
                    'key3.subkey1' => array(
                        array(
                            'source' => 'English label for key3',
                            'target' => 'key3.subkey1 value from TS extensionKey',
                        )
                    ),
                    'key3.subkey2.subsubkey' => array(
                        array(
                            'target' => 'key3.subkey2.subsubkey value from TS extensionKey',
                        )
                    ),
                ),
            )
        );
    }

    public function loadTypoScriptLabels(array $LOCAL_LANG, array $typoScriptLocalLang, $languageKey, array $expected) {
        $reflectionClass = new \ReflectionClass('TYPO3\\CMS\\Extbase\\Utility\\LocalizationUtility');

        $property = $reflectionClass->getProperty('LOCAL_LANG');
        $property->setAccessible(TRUE);
        $property->setValue($LOCAL_LANG);

        $property = $reflectionClass->getProperty('languageKey');
        $property->setAccessible(TRUE);
        $property->setValue($languageKey);

        $configurationType = \TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface::CONFIGURATION_TYPE_FRAMEWORK;
        $this->configurationManager->expects($this->at(0))->method('getConfiguration')->with($configurationType, 'extensionKey', NULL)->will($this->returnValue($typoScriptLocalLang));

        $method = $reflectionClass->getMethod('loadTypoScriptLabels');
        $method->setAccessible(TRUE);
        $method->invoke(NULL, 'extensionKey');

        $property = $reflectionClass->getProperty('LOCAL_LANG');
        $property->setAccessible(TRUE);
        $result = $property->getValue();

        $this->assertEquals($expected, $result['extensionKey'][$languageKey]);
    }

    public function clearLabelWithTypoScript() {
        $reflectionClass = new \ReflectionClass('TYPO3\\CMS\\Extbase\\Utility\\LocalizationUtility');

        $property = $reflectionClass->getProperty('LOCAL_LANG');
        $property->setAccessible(TRUE);
        $property->setValue($this->LOCAL_LANG);

        $property = $reflectionClass->getProperty('languageKey');
        $property->setAccessible(TRUE);
        $property->setValue('dk');

        $typoScriptLocalLang = array(
            '_LOCAL_LANG' => array(
                'dk' => array(
                    'key1' => '',
                )
            )
        );

        $configurationType = \TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface::CONFIGURATION_TYPE_FRAMEWORK;
        $this->configurationManager->expects($this->at(0))->method('getConfiguration')->with($configurationType, 'extensionKey', NULL)->will($this->returnValue($typoScriptLocalLang));

        $method = $reflectionClass->getMethod('loadTypoScriptLabels');
        $method->setAccessible(TRUE);
        $method->invoke(NULL, 'extensionKey');

        $result = LocalizationUtility::translate('key1', 'extensionKey');
        $this->assertNotNull($result);
        $this->assertEquals('', $result);
    }
}