TYPO3 CMS  TYPO3_6-2
TYPO3\CMS\Fluid\ViewHelpers\TranslateViewHelper Class Reference
Inheritance diagram for TYPO3\CMS\Fluid\ViewHelpers\TranslateViewHelper:
TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper Tx_Fluid_ViewHelpers_TranslateViewHelper

Public Member Functions

 initializeArguments ()
 
 render ()
 
- Public Member Functions inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
 setArguments (array $arguments)
 
 setRenderingContext (\TYPO3\CMS\Fluid\Core\Rendering\RenderingContextInterface $renderingContext)
 
 injectReflectionService (\TYPO3\CMS\Extbase\Reflection\ReflectionService $reflectionService)
 
 isEscapingInterceptorEnabled ()
 
 setViewHelperNode (\TYPO3\CMS\Fluid\Core\Parser\SyntaxTree\ViewHelperNode $node)
 
 setRenderChildrenClosure (\Closure $renderChildrenClosure)
 
 initializeArgumentsAndRender ()
 
 initialize ()
 
 renderChildren ()
 
 prepareArguments ()
 
 validateArguments ()
 
 initializeArguments ()
 
 compile ($argumentsVariableName, $renderChildrenClosureVariableName, &$initializationPhpCode, \TYPO3\CMS\Fluid\Core\Parser\SyntaxTree\AbstractNode $syntaxTreeNode, \TYPO3\CMS\Fluid\Core\Compiler\TemplateCompiler $templateCompiler)
 
 resetState ()
 

Protected Member Functions

 renderTranslation ($id)
 
- Protected Member Functions inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
 registerArgument ($name, $type, $description, $required=FALSE, $defaultValue=NULL)
 
 overrideArgument ($name, $type, $description, $required=FALSE, $defaultValue=NULL)
 
 callRenderMethod ()
 
 buildRenderChildrenClosure ()
 
 hasArgument ($argumentName)
 

Additional Inherited Members

- Static Public Member Functions inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
static renderStatic (array $arguments, \Closure $renderChildrenClosure, \TYPO3\CMS\Fluid\Core\Rendering\RenderingContextInterface $renderingContext)
 
- Protected Attributes inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
 $arguments
 
 $templateVariableContainer
 
 $controllerContext
 
 $renderingContext
 
 $renderChildrenClosure = NULL
 
 $viewHelperVariableContainer
 
 $objectManager
 
 $escapingInterceptorEnabled = TRUE
 

Detailed Description

Translate a key from locallang. The files are loaded from the folder "Resources/Private/Language/".

== Examples ==

<f:translate key="key1" /> <output> value of key "key1" in the current website language </output>

<f:translate key="htmlKey" htmlEscape="false" /> <output> value of key "htmlKey" in the current website language, no htmlspecialchars applied </output>

<f:translate key="LLL:EXT:myext/Resources/Private/Language/locallang.xlf:key1" /> <output> value of key "key1" in the current website language </output>

{f:translate(key: 'argumentsKey', arguments: {0: 'dog', 1: 'fox'}, default: 'default value')} <output> value of key "argumentsKey" in the current website language with "%1" and "%2" are replaced by "dog" and "fox" (printf) if the key is not found, the output is "default value" </output>

{f:translate(key: 'someKey', extensionName: 'SomeExtensionName')} <output> value of key "someKey" in the current website language the locallang file of extension "some_extension_name" will be used </output>

<f:translate id="key1" /> <output> value of id "key1" in the current website language </output>

Definition at line 67 of file TranslateViewHelper.php.

Member Function Documentation

◆ initializeArguments()

TYPO3\CMS\Fluid\ViewHelpers\TranslateViewHelper::initializeArguments ( )

Initializes arguments for Translate ViewHelper

Returns
void

Definition at line 74 of file TranslateViewHelper.php.

References TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper\registerArgument().

◆ render()

TYPO3\CMS\Fluid\ViewHelpers\TranslateViewHelper::render ( )

Wrapper function including a compatibility layer for TYPO3 Flow Translation

Exceptions

Definition at line 90 of file TranslateViewHelper.php.

References TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper\hasArgument(), and TYPO3\CMS\Fluid\ViewHelpers\TranslateViewHelper\renderTranslation().

◆ renderTranslation()

TYPO3\CMS\Fluid\ViewHelpers\TranslateViewHelper::renderTranslation (   $id)
protected

Translate a given key or use the tag body as default.

Parameters
string$idThe locallang id
Returns
string The translated key or tag body if key doesn't exist

Definition at line 106 of file TranslateViewHelper.php.

References TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper\renderChildren(), and TYPO3\CMS\Extbase\Utility\LocalizationUtility\translate().

Referenced by TYPO3\CMS\Fluid\ViewHelpers\TranslateViewHelper\render().