Inheritance diagram for TYPO3\CMS\Form\Service\TranslationService:

Public Member Functions
mixed	translate ( $key, array $arguments=null, string $locallangPathAndFilename=null, string $language=null, $defaultValue='')

array	translateValuesRecursive (array $array, array $translationFiles=[])

array	translateToAllBackendLanguages (string $key, array $arguments=null, array $translationFiles=[])

string	translateFinisherOption (FormRuntime $formRuntime, string $finisherIdentifier, string $optionKey, string $optionValue, array $renderingOptions=[])

string array	translateFormElementValue (RootRenderableInterface $element, array $propertyParts, FormRuntime $formRuntime)

string	translateFormElementError (RootRenderableInterface $element, int $code, array $arguments, string $defaultValue='', FormRuntime $formRuntime)

	setLanguage (string $languageKey)

string	getLanguage ()

Static Public Member Functions
static TranslationService	getInstance ()

Protected Member Functions
string null	processTranslationChain (array $translationKeyChain, string $language=null, array $arguments=null)

	initializeLocalization (string $locallangPathAndFilename)

	setLanguageKeys ()

	loadTypoScriptLabels ()

array	flattenTypoScriptLabelArray (array $labelValues, string $parentKey='')

array	sortArrayWithIntegerKeysDescending (array $array)

ConfigurationManagerInterface	getConfigurationManager ()

SiteLanguage null	getCurrentSiteLanguage ()

array	getAllTypo3BackendLanguages ()

LanguageService	getLanguageService ()

Protected Attributes
array	$LOCAL_LANG = array( )

array	$LOCAL_LANG_UNSET = array( )

string	$languageKey

array	$alternativeLanguageKeys = array( )

TYPO3 CMS Extbase Configuration ConfigurationManagerInterface	$configurationManager

Detailed Description

Advanced translations This class is subjected to change. Do NOT subclass

Scope: frontend / backend

Definition at line 43 of file TranslationService.php.

Member Function Documentation

◆ flattenTypoScriptLabelArray()

array TYPO3\CMS\Form\Service\TranslationService::flattenTypoScriptLabelArray	(	array	$labelValues,
		string	$parentKey = `''`
	)

protected

Flatten TypoScript label array; converting a hierarchical array into a flat array with the keys separated by dots.

Example Input: array('k1' => array('subkey1' => 'val1')) Example Output: array('k1.subkey1' => 'val1')

Parameters

array	$labelValues	‪Hierarchical array of labels
string	$parentKey	‪the name of the parent key in the recursion; is only needed for recursion.

Returns: ‪array flattened array of labels.

Definition at line 652 of file TranslationService.php.

Referenced by TYPO3\CMS\Form\Service\TranslationService\loadTypoScriptLabels().

◆ getAllTypo3BackendLanguages()

array TYPO3\CMS\Form\Service\TranslationService::getAllTypo3BackendLanguages ( )

protected

Returns: ‪array

Definition at line 715 of file TranslationService.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Form\Service\TranslationService\translateToAllBackendLanguages().

◆ getConfigurationManager()

ConfigurationManagerInterface TYPO3\CMS\Form\Service\TranslationService::getConfigurationManager ( )

protected

Returns instance of the configuration manager

Returns: ‪ConfigurationManagerInterface

Definition at line 688 of file TranslationService.php.

References TYPO3\CMS\Form\Service\TranslationService\$configurationManager.

Referenced by TYPO3\CMS\Form\Service\TranslationService\loadTypoScriptLabels().

◆ getCurrentSiteLanguage()

SiteLanguage null TYPO3\CMS\Form\Service\TranslationService::getCurrentSiteLanguage ( )

protected

Returns the currently configured "site language" if a site is configured (= resolved) in the current request.

Returns: ‪SiteLanguage|null

Definition at line 704 of file TranslationService.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Form\Service\TranslationService\setLanguageKeys().

◆ getInstance()

static TranslationService TYPO3\CMS\Form\Service\TranslationService::getInstance ( )

static

Return TranslationService as singleton

Returns: ‪TranslationService

Definition at line 83 of file TranslationService.php.

Referenced by TYPO3\CMS\Form\Hooks\FormElementHooks\afterSubmit(), TYPO3\CMS\Form\Controller\FormManagerController\deleteAction(), TYPO3\CMS\Form\Domain\Finishers\EmailFinisher\executeInternal(), TYPO3\CMS\Form\Controller\FormEditorController\getFormEditorDefinitions(), TYPO3\CMS\Form\Controller\FormManagerController\getFormManagerAppInitialData(), TYPO3\CMS\Form\Controller\FormEditorController\getInsertRenderablesPanelConfiguration(), TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\getTranslationService(), TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter\getUploadErrorMessage(), TYPO3\CMS\Form\ViewHelpers\TranslateElementErrorViewHelper\renderStatic(), TYPO3\CMS\Form\ViewHelpers\TranslateElementPropertyViewHelper\renderStatic(), TYPO3\CMS\Form\Hooks\DataStructureIdentifierHook\translateFinisherDefinitionByIdentifier(), and TYPO3\CMS\Form\Domain\Finishers\AbstractFinisher\translateFinisherOption().

◆ getLanguage()

string TYPO3\CMS\Form\Service\TranslationService::getLanguage ( )

Returns: ‪string

Definition at line 527 of file TranslationService.php.

References TYPO3\CMS\Form\Service\TranslationService\$languageKey.

◆ getLanguageService()

LanguageService TYPO3\CMS\Form\Service\TranslationService::getLanguageService ( )

protected

Returns: ‪LanguageService

Definition at line 728 of file TranslationService.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Form\Service\TranslationService\setLanguageKeys().

◆ initializeLocalization()

TYPO3\CMS\Form\Service\TranslationService::initializeLocalization ( string $locallangPathAndFilename )

protected

Parameters

string $locallangPathAndFilename

Definition at line 556 of file TranslationService.php.

References TYPO3\CMS\Form\Service\TranslationService\loadTypoScriptLabels(), and TYPO3\CMS\Form\Service\TranslationService\setLanguageKeys().

Referenced by TYPO3\CMS\Form\Service\TranslationService\translate().

◆ loadTypoScriptLabels()

TYPO3\CMS\Form\Service\TranslationService::loadTypoScriptLabels ( )

protected

Overwrites labels that are set via TypoScript. TS locallang labels have to be configured like: plugin.tx_form._LOCAL_LANG.languageKey.key = value

Definition at line 609 of file TranslationService.php.

References TYPO3\CMS\Form\Service\TranslationService\$languageKey, TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface\CONFIGURATION_TYPE_FRAMEWORK, TYPO3\CMS\Form\Service\TranslationService\flattenTypoScriptLabelArray(), TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface\getConfiguration(), and TYPO3\CMS\Form\Service\TranslationService\getConfigurationManager().

Referenced by TYPO3\CMS\Form\Service\TranslationService\initializeLocalization().

◆ processTranslationChain()

string null TYPO3\CMS\Form\Service\TranslationService::processTranslationChain	(	array	$translationKeyChain,
		string	$language = `null`,
		array	$arguments = `null`
	)

protected

Parameters

array	$translationKeyChain
string	$language
array	$arguments

Returns: ‪string|null

Definition at line 538 of file TranslationService.php.

References TYPO3\CMS\Form\Service\TranslationService\translate().

Referenced by TYPO3\CMS\Form\Service\TranslationService\translateFinisherOption(), TYPO3\CMS\Form\Service\TranslationService\translateFormElementError(), and TYPO3\CMS\Form\Service\TranslationService\translateFormElementValue().

◆ setLanguage()

TYPO3\CMS\Form\Service\TranslationService::setLanguage ( string $languageKey )

Parameters

string $languageKey

Definition at line 518 of file TranslationService.php.

References TYPO3\CMS\Form\Service\TranslationService\$languageKey.

◆ setLanguageKeys()

TYPO3\CMS\Form\Service\TranslationService::setLanguageKeys ( )

protected

Sets the currently active language keys.

Definition at line 580 of file TranslationService.php.

References $GLOBALS, $locales, TYPO3\CMS\Form\Service\TranslationService\getCurrentSiteLanguage(), TYPO3\CMS\Form\Service\TranslationService\getLanguageService(), and TYPO3\CMS\Core\Site\Entity\SiteLanguage\getTypo3Language().

Referenced by TYPO3\CMS\Form\Service\TranslationService\initializeLocalization().

◆ sortArrayWithIntegerKeysDescending()

array TYPO3\CMS\Form\Service\TranslationService::sortArrayWithIntegerKeysDescending ( array $array )

protected

If the array contains numerical keys only, sort it in descending order

Parameters

array $array

Returns: ‪array

Definition at line 675 of file TranslationService.php.

Referenced by TYPO3\CMS\Form\Service\TranslationService\translateFinisherOption(), TYPO3\CMS\Form\Service\TranslationService\translateFormElementError(), TYPO3\CMS\Form\Service\TranslationService\translateFormElementValue(), TYPO3\CMS\Form\Service\TranslationService\translateToAllBackendLanguages(), and TYPO3\CMS\Form\Service\TranslationService\translateValuesRecursive().

◆ translate()

mixed TYPO3\CMS\Form\Service\TranslationService::translate	(		$key,
		array	$arguments = `null`,
		string	$locallangPathAndFilename = `null`,
		string	$language = `null`,
			$defaultValue = `''`
	)

Returns the localized label of the LOCAL_LANG key, $key.

Parameters

mixed	$key	‪The key from the LOCAL_LANG array for which to return the value.
array	$arguments	‪the arguments of the extension, being passed over to vsprintf
string	$locallangPathAndFilename
string	$language
mixed	$defaultValue

Returns: ‪mixed The value from LOCAL_LANG or $defaultValue if no translation was found.

Definition at line 99 of file TranslationService.php.

References TYPO3\CMS\Form\Service\TranslationService\$languageKey, and TYPO3\CMS\Form\Service\TranslationService\initializeLocalization().

Referenced by TYPO3\CMS\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter\getUploadErrorMessage(), TYPO3\CMS\Form\Service\TranslationService\processTranslationChain(), TYPO3\CMS\Form\Service\TranslationService\translateToAllBackendLanguages(), and TYPO3\CMS\Form\Service\TranslationService\translateValuesRecursive().

◆ translateFinisherOption()

string TYPO3\CMS\Form\Service\TranslationService::translateFinisherOption	(	FormRuntime	$formRuntime,
		string	$finisherIdentifier,
		string	$optionKey,
		string	$optionValue,
		array	$renderingOptions = `[]`
	)

Parameters

FormRuntime	$formRuntime
string	$finisherIdentifier
string	$optionKey
string	$optionValue
array	$renderingOptions

Returns: ‪string

Exceptions

Definition at line 242 of file TranslationService.php.

References TYPO3\CMS\Form\Domain\Runtime\FormRuntime\getIdentifier(), TYPO3\CMS\Form\Domain\Runtime\FormRuntime\getRenderingOptions(), TYPO3\CMS\Core\Utility\ArrayUtility\getValueByPath(), TYPO3\CMS\Form\Service\TranslationService\processTranslationChain(), and TYPO3\CMS\Form\Service\TranslationService\sortArrayWithIntegerKeysDescending().

Referenced by TYPO3\CMS\Form\Domain\Finishers\AbstractFinisher\translateFinisherOption().

◆ translateFormElementError()

string TYPO3\CMS\Form\Service\TranslationService::translateFormElementError	(	RootRenderableInterface	$element,
		int	$code,
		array	$arguments,
		string	$defaultValue = `''`,
		FormRuntime	$formRuntime
	)

Parameters

RootRenderableInterface	$element
int	$code
string	$defaultValue
array	$arguments
FormRuntime	$formRuntime

Returns: ‪string

Exceptions

Definition at line 454 of file TranslationService.php.

References TYPO3\CMS\Form\Domain\Model\Renderable\RootRenderableInterface\getIdentifier(), TYPO3\CMS\Form\Domain\Runtime\FormRuntime\getIdentifier(), TYPO3\CMS\Form\Domain\Model\Renderable\RootRenderableInterface\getRenderingOptions(), TYPO3\CMS\Form\Domain\Runtime\FormRuntime\getRenderingOptions(), TYPO3\CMS\Form\Service\TranslationService\processTranslationChain(), and TYPO3\CMS\Form\Service\TranslationService\sortArrayWithIntegerKeysDescending().

Referenced by TYPO3\CMS\Form\ViewHelpers\TranslateElementErrorViewHelper\renderStatic().

◆ translateFormElementValue()

string array TYPO3\CMS\Form\Service\TranslationService::translateFormElementValue	(	RootRenderableInterface	$element,
		array	$propertyParts,
		FormRuntime	$formRuntime
	)

Parameters

RootRenderableInterface	$element
array	$propertyParts
FormRuntime	$formRuntime

Returns: ‪string|array

Exceptions

Definition at line 313 of file TranslationService.php.

References TYPO3\CMS\Form\Domain\Model\Renderable\RootRenderableInterface\getIdentifier(), TYPO3\CMS\Form\Domain\Runtime\FormRuntime\getIdentifier(), TYPO3\CMS\Form\Domain\Model\Renderable\RootRenderableInterface\getLabel(), TYPO3\CMS\Form\Domain\Model\Renderable\RootRenderableInterface\getRenderingOptions(), TYPO3\CMS\Form\Domain\Runtime\FormRuntime\getRenderingOptions(), TYPO3\CMS\Form\Domain\Model\Renderable\RootRenderableInterface\getType(), TYPO3\CMS\Core\Utility\ArrayUtility\getValueByPath(), TYPO3\CMS\Form\Service\TranslationService\processTranslationChain(), and TYPO3\CMS\Form\Service\TranslationService\sortArrayWithIntegerKeysDescending().

Referenced by TYPO3\CMS\Form\ViewHelpers\TranslateElementPropertyViewHelper\renderStatic().

◆ translateToAllBackendLanguages()

array TYPO3\CMS\Form\Service\TranslationService::translateToAllBackendLanguages	(	string	$key,
		array	$arguments = `null`,
		array	$translationFiles = `[]`
	)

Parameters

string	$key
array	$arguments
array	$translationFiles

Returns: ‪array the modified array

Definition at line 211 of file TranslationService.php.

References TYPO3\CMS\Form\Service\TranslationService\getAllTypo3BackendLanguages(), TYPO3\CMS\Form\Service\TranslationService\sortArrayWithIntegerKeysDescending(), and TYPO3\CMS\Form\Service\TranslationService\translate().

Referenced by TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\getAllBackendTranslationsForTranslationKey().

◆ translateValuesRecursive()

array TYPO3\CMS\Form\Service\TranslationService::translateValuesRecursive	(	array	$array,
		array	$translationFiles = `[]`
	)

Recursively translate values.

Parameters

array	$array
array	$translationFiles

Returns: ‪array the modified array

Definition at line 179 of file TranslationService.php.

References TYPO3\CMS\Form\Service\TranslationService\sortArrayWithIntegerKeysDescending(), and TYPO3\CMS\Form\Service\TranslationService\translate().

Referenced by TYPO3\CMS\Form\Controller\FormManagerController\deleteAction(), TYPO3\CMS\Form\Controller\FormEditorController\getFormEditorDefinitions(), TYPO3\CMS\Form\Controller\FormManagerController\getFormManagerAppInitialData(), TYPO3\CMS\Form\Controller\FormEditorController\getInsertRenderablesPanelConfiguration(), TYPO3\CMS\Form\Hooks\DataStructureIdentifierHook\translateFinisherDefinitionByIdentifier(), TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\translatePredefinedDefaults(), and TYPO3\CMS\Form\Domain\Configuration\ConfigurationService\translateSelectOptions().

Member Data Documentation

◆ $alternativeLanguageKeys

array TYPO3\CMS\Form\Service\TranslationService::$alternativeLanguageKeys = array( )

protected

Pointer to alternative fall-back language to use

Definition at line 71 of file TranslationService.php.

◆ $configurationManager

TYPO3 CMS Extbase Configuration ConfigurationManagerInterface TYPO3\CMS\Form\Service\TranslationService::$configurationManager

protected

Definition at line 75 of file TranslationService.php.

Referenced by TYPO3\CMS\Form\Service\TranslationService\getConfigurationManager().

◆ $languageKey

string TYPO3\CMS\Form\Service\TranslationService::$languageKey

protected

Key of the language to use

Definition at line 65 of file TranslationService.php.

Referenced by TYPO3\CMS\Form\Service\TranslationService\getLanguage(), TYPO3\CMS\Form\Service\TranslationService\loadTypoScriptLabels(), TYPO3\CMS\Form\Service\TranslationService\setLanguage(), and TYPO3\CMS\Form\Service\TranslationService\translate().

◆ $LOCAL_LANG

array TYPO3\CMS\Form\Service\TranslationService::$LOCAL_LANG = array( )

protected

Local Language content

Definition at line 50 of file TranslationService.php.

◆ $LOCAL_LANG_UNSET

array TYPO3\CMS\Form\Service\TranslationService::$LOCAL_LANG_UNSET = array( )

protected

Contains those LL keys, which have been set to (empty) in TypoScript. This is necessary, as we cannot distinguish between a nonexisting translation and a label that has been cleared by TS. In both cases ['key'][0]['target'] is "".

Definition at line 59 of file TranslationService.php.

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ flattenTypoScriptLabelArray()

◆ getAllTypo3BackendLanguages()

◆ getConfigurationManager()

◆ getCurrentSiteLanguage()

◆ getInstance()

◆ getLanguage()

◆ getLanguageService()

◆ initializeLocalization()

◆ loadTypoScriptLabels()

◆ processTranslationChain()

◆ setLanguage()

◆ setLanguageKeys()

◆ sortArrayWithIntegerKeysDescending()

◆ translate()

◆ translateFinisherOption()

◆ translateFormElementError()

◆ translateFormElementValue()

◆ translateToAllBackendLanguages()

◆ translateValuesRecursive()

Member Data Documentation

◆ $alternativeLanguageKeys

◆ $configurationManager

◆ $languageKey

◆ $LOCAL_LANG

◆ $LOCAL_LANG_UNSET