9.5/_translate_view_helper_8php_source.html

<?php

namespace ‪TYPO3\CMS\Fluid\ViewHelpers;


/*

 * 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\Extbase\Utility\LocalizationUtility;

use TYPO3Fluid\Fluid\Core\Exception;

use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;

use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractViewHelper;

use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;


class ‪TranslateViewHelper extends AbstractViewHelper

{

    use CompileWithRenderStatic;


    protected ‪$escapeChildren = false;


    public function ‪initializeArguments()

    {

        $this->registerArgument('key', 'string', 'Translation Key');

        $this->registerArgument('id', 'string', 'Translation ID. Same as key.');

        $this->registerArgument('default', 'string', 'If the given locallang key could not be found, this value is used. If this argument is not set, child nodes will be used to render the default');

        $this->registerArgument('arguments', 'array', 'Arguments to be replaced in the resulting string');

        $this->registerArgument('extensionName', 'string', 'UpperCamelCased extension key (for example BlogExample)');

        $this->registerArgument('languageKey', 'string', 'Language key ("dk" for example) or "default" to use for this translation. If this argument is empty, we use the current language');

        $this->registerArgument('alternativeLanguageKeys', 'array', 'Alternative language keys if no translation does exist');

    }


    public static function ‪renderStatic(array $arguments, \Closure $renderChildrenClosure, RenderingContextInterface $renderingContext)

    {

        $key = $arguments['key'];

        $id = $arguments['id'];

        $default = $arguments['default'];

        $extensionName = $arguments['extensionName'];

        $translateArguments = $arguments['arguments'];


        // Use key if id is empty.

        if ($id === null) {

            $id = $key;

        }


        if ((string)$id === '') {

            throw new Exception('An argument "key" or "id" has to be provided', 1351584844);

        }


        $request = $renderingContext->getControllerContext()->getRequest();

        $extensionName = $extensionName ?? $request->getControllerExtensionName();

        try {

            $value = static::translate($id, $extensionName, $translateArguments, $arguments['languageKey'], $arguments['alternativeLanguageKeys']);

        } catch (\InvalidArgumentException $e) {

            $value = null;

        }

        if ($value === null) {

            $value = $default ?? $renderChildrenClosure();

            if (!empty($translateArguments)) {

                $value = vsprintf($value, $translateArguments);

            }

        }

        return $value;

    }


    protected static function ‪translate($id, $extensionName, $arguments, $languageKey, $alternativeLanguageKeys)

    {

        return ‪LocalizationUtility::translate($id, $extensionName, $arguments, $languageKey, $alternativeLanguageKeys);

    }

}