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

Public Member Functions
	__construct (protected readonly ConfigurationManagerInterface $configurationManager, protected readonly LanguageServiceFactory $languageServiceFactory, protected readonly FrontendInterface $runtimeCache, protected readonly Locales $locales)

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=[])

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

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

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

	setLanguage (string $languageKey)

	getLanguage ()

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

	initializeLocalization (string $locallangPathAndFilename)

	buildLanguageService (string $languageKey, $languageFilePath)

	setLanguageKeys (?string $language)

	loadTypoScriptLabels ()

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

	sortArrayWithIntegerKeysDescending (array $array)

	isEmptyTranslatedValue (mixed $translatedValue)

	getCurrentSiteLanguage ()

Protected Attributes
string	$languageKey = ''

Detailed Description

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

Scope: frontend / backend

Definition at line 44 of file TranslationService.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Form\Service\TranslationService::__construct	(	protected readonly ConfigurationManagerInterface	$configurationManager,
		protected readonly LanguageServiceFactory	$languageServiceFactory,
		protected readonly FrontendInterface	$runtimeCache,
		protected readonly Locales	$locales
	)

Definition at line 53 of file TranslationService.php.

Member Function Documentation

◆ buildLanguageService()

TYPO3\CMS\Form\Service\TranslationService::buildLanguageService	(	string	$languageKey,
			$languageFilePath
	)

protected

Definition at line 494 of file TranslationService.php.

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

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

◆ 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 567 of file TranslationService.php.

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

◆ getCurrentSiteLanguage()

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

protected

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

Definition at line 629 of file TranslationService.php.

References $GLOBALS.

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

◆ getLanguage()

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

Definition at line 458 of file TranslationService.php.

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

◆ initializeLocalization()

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

protected

Definition at line 481 of file TranslationService.php.

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

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

◆ isEmptyTranslatedValue()

TYPO3\CMS\Form\Service\TranslationService::isEmptyTranslatedValue ( mixed $translatedValue )

protected

Check if given translated value is considered "empty".

A translated value is considered "empty" if it's either NULL or an empty string. This helper method exists to perform a less strict check than the native {

See also: ‪empty()} function, because it is too strict in terms of supported translated values. For example, the value "0" is valid, whereas {; ‪empty()} would handle it as "empty" and therefore invalid.

Definition at line 605 of file TranslationService.php.

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

◆ loadTypoScriptLabels()

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

protected

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

Definition at line 531 of file TranslationService.php.

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

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

Returns: ‪string|null

Definition at line 466 of file TranslationService.php.

References TYPO3\CMS\Form\Service\TranslationService\isEmptyTranslatedValue(), and 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 )

Definition at line 450 of file TranslationService.php.

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

◆ setLanguageKeys()

TYPO3\CMS\Form\Service\TranslationService::setLanguageKeys ( ?string $language )

protected

Sets the currently active language keys.

Definition at line 510 of file TranslationService.php.

References $GLOBALS, TYPO3\CMS\Core\Http\fromRequest, and TYPO3\CMS\Form\Service\TranslationService\getCurrentSiteLanguage().

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

◆ sortArrayWithIntegerKeysDescending()

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

protected

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

Definition at line 587 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 \| null	$arguments	‪the arguments of the extension, being passed over to vsprintf
mixed	$defaultValue

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

Definition at line 69 of file TranslationService.php.

References TYPO3\CMS\Form\Service\TranslationService\initializeLocalization(), TYPO3\CMS\Core\Utility\PathUtility\isExtensionPath(), and TYPO3\CMS\Form\Service\TranslationService\setLanguageKeys().

Referenced by TYPO3\CMS\Form\Service\TranslationService\processTranslationChain(), TYPO3\CMS\Form\Service\TranslationService\translateToAllBackendLanguages(), and TYPO3\CMS\Form\Service\TranslationService\translateValuesRecursive().

◆ translateFinisherOption()

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

Exceptions

Definition at line 180 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\isEmptyTranslatedValue(), TYPO3\CMS\Form\Service\TranslationService\processTranslationChain(), and TYPO3\CMS\Form\Service\TranslationService\sortArrayWithIntegerKeysDescending().

◆ translateFormElementError()

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

Exceptions

Definition at line 387 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\isEmptyTranslatedValue(), TYPO3\CMS\Form\Service\TranslationService\processTranslationChain(), and TYPO3\CMS\Form\Service\TranslationService\sortArrayWithIntegerKeysDescending().

◆ translateFormElementValue()

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

Returns: ‪string|array

Exceptions

Definition at line 252 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\isEmptyTranslatedValue(), TYPO3\CMS\Form\Service\TranslationService\processTranslationChain(), and TYPO3\CMS\Form\Service\TranslationService\sortArrayWithIntegerKeysDescending().

◆ translateToAllBackendLanguages()

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

Returns: ‪array the modified array

Definition at line 155 of file TranslationService.php.

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

◆ translateValuesRecursive()

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

Recursively translate values.

Returns: ‪array the modified array

Definition at line 126 of file TranslationService.php.

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

Member Data Documentation

◆ $languageKey

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

protected

Definition at line 51 of file TranslationService.php.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildLanguageService()

◆ flattenTypoScriptLabelArray()

◆ getCurrentSiteLanguage()

◆ getLanguage()

◆ initializeLocalization()

◆ isEmptyTranslatedValue()

◆ loadTypoScriptLabels()

◆ processTranslationChain()

◆ setLanguage()

◆ setLanguageKeys()

◆ sortArrayWithIntegerKeysDescending()

◆ translate()

◆ translateFinisherOption()

◆ translateFormElementError()

◆ translateFormElementValue()

◆ translateToAllBackendLanguages()

◆ translateValuesRecursive()

Member Data Documentation

◆ $languageKey