typo3/sysext/fluid/Classes/ViewHelpers/TranslateViewHelper.php

   1 <?php
   2 namespace TYPO3\CMS\Fluid\ViewHelpers;
   3
   4 /*
   5  * This file is part of the TYPO3 CMS project.
   6  *
   7  * It is free software; you can redistribute it and/or modify it under
   8  * the terms of the GNU General Public License, either version 2
   9  * of the License, or any later version.
  10  *
  11  * For the full copyright and license information, please read the
  12  * LICENSE.txt file that was distributed with this source code.
  13  *
  14  * The TYPO3 project - inspiring people to share!
  15  */
  16
  17 use TYPO3\CMS\Fluid\Core\Rendering\RenderingContextInterface;
  18 use TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper;
  19 use TYPO3\CMS\Fluid\Core\ViewHelper\Exception\InvalidVariableException;
  20 use TYPO3\CMS\Fluid\Core\ViewHelper\Facets\CompilableInterface;
  21
  22 /**
  23  * Translate a key from locallang. The files are loaded from the folder
  24  * "Resources/Private/Language/".
  25  *
  26  * == Examples ==
  27  *
  28  * <code title="Translate key">
  29  * <f:translate key="key1" />
  30  * </code>
  31  * <output>
  32  * value of key "key1" in the current website language
  33  * </output>
  34  *
  35  * <code title="Keep HTML tags">
  36  * <f:translate key="htmlKey" htmlEscape="false" />
  37  * </code>
  38  * <output>
  39  * value of key "htmlKey" in the current website language, no htmlspecialchars applied
  40  * </output>
  41  *
  42  * <code title="Translate key from custom locallang file">
  43  * <f:translate key="LLL:EXT:myext/Resources/Private/Language/locallang.xlf:key1" />
  44  * </code>
  45  * <output>
  46  * value of key "key1" in the current website language
  47  * </output>
  48  *
  49  * <code title="Inline notation with arguments and default value">
  50  * {f:translate(key: 'argumentsKey', arguments: {0: 'dog', 1: 'fox'}, default: 'default value')}
  51  * </code>
  52  * <output>
  53  * value of key "argumentsKey" in the current website language
  54  * with "%1" and "%2" are replaced by "dog" and "fox" (printf)
  55  * if the key is not found, the output is "default value"
  56  * </output>
  57  *
  58  * <code title="Inline notation with extension name">
  59  * {f:translate(key: 'someKey', extensionName: 'SomeExtensionName')}
  60  * </code>
  61  * <output>
  62  * value of key "someKey" in the current website language
  63  * the locallang file of extension "some_extension_name" will be used
  64  * </output>
  65  *
  66  * <code title="Translate id as in TYPO3 Flow">
  67  * <f:translate id="key1" />
  68  * </code>
  69  * <output>
  70  * value of id "key1" in the current website language
  71  * </output>
  72  */
  73 class TranslateViewHelper extends \TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper {
  74
  75         /**
  76          * Initializes arguments for Translate ViewHelper
  77          *
  78          * @return void
  79          */
  80         public function initializeArguments() {
  81                 $this->registerArgument('key', 'string', 'Translation Key');
  82                 $this->registerArgument('id', 'string', 'Translation Key compatible to TYPO3 Flow');
  83                 $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');
  84                 $this->registerArgument('htmlEscape', 'boolean', 'TRUE if the result should be htmlescaped. This won\'t have an effect for the default value');
  85                 $this->registerArgument('arguments', 'array', 'Arguments to be replaced in the resulting string');
  86                 $this->registerArgument('extensionName', 'string', 'UpperCamelCased extension key (for example BlogExample)');
  87         }
  88
  89         /**
  90          * Wrapper function including a compatibility layer for TYPO3 Flow Translation
  91          *
  92          * @throws \TYPO3\CMS\Fluid\Core\ViewHelper\Exception\InvalidVariableException
  93          *
  94          * @return string The translated key or tag body if key doesn't exist
  95          */
  96         public function render() {
  97                 $id = $this->hasArgument('id') ? $this->arguments['id'] : $this->arguments['key'];
  98
  99                 if (strlen($id) > 0) {
 100                         return $this->renderTranslation($id);
 101                 } else {
 102                         throw new \TYPO3\CMS\Fluid\Core\ViewHelper\Exception\InvalidVariableException('An argument "key" or "id" has to be provided', 1351584844);
 103                 }
 104         }
 105
 106         /**
 107          * Translate a given key or use the tag body as default.
 108          *
 109          * @param string $id The locallang id
 110          * @return string The translated key or tag body if key doesn't exist
 111          */
 112         protected function renderTranslation($id) {
 113                 $request = $this->controllerContext->getRequest();
 114                 $extensionName = $this->arguments['extensionName'] === NULL ? $request->getControllerExtensionName() : $this->arguments['extensionName'];
 115                 $value = \TYPO3\CMS\Extbase\Utility\LocalizationUtility::translate($id, $extensionName, $this->arguments['arguments']);
 116                 if ($value === NULL) {
 117                         $value = $this->arguments['default'] !== NULL ? $this->arguments['default'] : $this->renderChildren();
 118                         if (is_array($this->arguments['arguments'])) {
 119                                 $value = vsprintf($value, $this->arguments['arguments']);
 120                         }
 121                 } elseif ($this->arguments['htmlEscape']) {
 122                         $value = htmlspecialchars($value);
 123                 }
 124                 return $value;
 125         }
 126 }