Inheritance diagram for TYPO3\CMS\Core\Localization\LanguageService:

Public Member Functions
	__construct (Locales $locales, LocalizationFactory $localizationFactory)

	init ($languageKey)

string	getLL ($index)

string	sL ($input)

	loadSingleTableDescription ($table)

array	includeLLFile ($fileRef, $setGlobal=null, $mergeLocalOntoDefault=null)

array	getLabelsWithPrefix ($prefix, $strip='')

‪Public Member Functions inherited from ‪TYPO3\CMS\Core\Compatibility\PublicPropertyDeprecationTrait
bool	__isset (string $propertyName)

mixed	__get (string $propertyName)

	__set (string $propertyName, $propertyValue)

	__unset (string $propertyName)

‪Public Member Functions inherited from ‪TYPO3\CMS\Core\Compatibility\PublicMethodDeprecationTrait
mixed	__call (string $methodName, array $arguments)

Static Public Member Functions
static static	create (string $locale)

static	createFromUserPreferences (?AbstractUserAuthentication $user)

static	createFromSiteLanguage (SiteLanguage $language)

Public Attributes
string	$lang = 'default'

bool	$debugKey = false

Protected Member Functions
string	debugLL ($value)

string	getLLL ($index, $localLanguage)

array	includeLanguageFileRaw ($fileRef)

array	readLLfile ($fileRef)

Protected Attributes
	$deprecatedPublicProperties

	$deprecatedPublicMethods

array	$LL_files_cache = array( )

array	$LL_labels_cache = array( )

array	$languageDependencies = array( )

array	$languageFileCache = array( )

string[][]	$labels = array( )

Locales	$locales

LocalizationFactory	$localizationFactory

Detailed Description

Main API to fetch labels from XLF (label files) based on the current system language of TYPO3. It is able to resolve references to files + their pointers to the proper language. If you see something about "LLL", this class does the trick for you. It is not related for language handling of content, but rather of labels for plugins.

Usually this is injected into $GLOBALS['LANG'] when in backend or CLI context, and populated by the current backend user. Don't rely on $GLOBAL['LANG'] in frontend, as it is only available in certain circumstances! In Frontend, this is also used to translate "labels", see TypoScriptFrontendController->sL() for that.

As TYPO3 internally does not match the proper ISO locale standard, the "locale" here is actually a list of supported language keys, (see Locales class), whereas "english" has the language key "default".

Definition at line 41 of file LanguageService.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Core\Localization\LanguageService::__construct	(	Locales	$locales,
		LocalizationFactory	$localizationFactory
	)

use one of the factory methods instead

Definition at line 106 of file LanguageService.php.

References $GLOBALS, TYPO3\CMS\Core\Localization\LanguageService\$locales, and TYPO3\CMS\Core\Localization\LanguageService\$localizationFactory.

Member Function Documentation

◆ create()

static static TYPO3\CMS\Core\Localization\LanguageService::create ( string $locale )

static

Factory method to create a language service object.

Parameters

string $locale ‪the locale (= the TYPO3-internal locale given)

Returns: ‪static

Definition at line 430 of file LanguageService.php.

Referenced by TYPO3\CMS\Core\Information\Typo3Information\__construct(), TYPO3\CMS\Workspaces\Middleware\WorkspacePreview\getLanguageService(), TYPO3\CMS\RteCKEditor\Controller\BrowseLinksController\initVariables(), TYPO3\CMS\Core\Tests\Functional\Localization\LanguageServiceTest\setUp(), TYPO3\CMS\Core\Tests\Functional\Database\QueryGeneratorTest\setUp(), and TYPO3\CMS\Linkvalidator\Tests\Functional\LinkAnalyzerTest\setUp().

◆ createFromSiteLanguage()

static TYPO3\CMS\Core\Localization\LanguageService::createFromSiteLanguage ( SiteLanguage $language )

static

Definition at line 443 of file LanguageService.php.

References TYPO3\CMS\Core\Site\Entity\SiteLanguage\getTypo3Language().

Referenced by TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController\setOutputLanguage().

◆ createFromUserPreferences()

static TYPO3\CMS\Core\Localization\LanguageService::createFromUserPreferences ( ?AbstractUserAuthentication $user )

static

Definition at line 435 of file LanguageService.php.

Referenced by TYPO3\CMS\Frontend\Http\RequestHandler\getLanguageService(), TYPO3\CMS\Core\Console\CommandRequestHandler\handleRequest(), TYPO3\CMS\Core\Core\Bootstrap\initializeLanguageObject(), TYPO3\CMS\Core\Tests\Functional\Page\PageRendererTest\pageRendererMergesRequireJsPackagesOnConsecutiveCalls(), TYPO3\CMS\Frontend\Middleware\BackendUserAuthenticator\process(), TYPO3\CMS\Backend\Middleware\BackendUserAuthenticator\process(), and TYPO3\CMS\Core\Console\CommandApplication\run().

◆ debugLL()

string TYPO3\CMS\Core\Localization\LanguageService::debugLL ( $value )

protected

Debugs localization key.

Parameters

string $value ‪value to debug

Returns: ‪string

Definition at line 142 of file LanguageService.php.

Referenced by TYPO3\CMS\Core\Localization\LanguageService\getLLL(), and TYPO3\CMS\Core\Localization\LanguageService\sL().

◆ getLabelsWithPrefix()

array TYPO3\CMS\Core\Localization\LanguageService::getLabelsWithPrefix	(	$prefix,
		$strip = `''`
	)

Gets labels with a specific fetched from the current locallang file. This is useful for e.g gathering javascript labels.

Parameters

string	$prefix	‪Prefix to select the correct labels
string	$strip	‪Sub-prefix to be removed from label names in the result

Returns: ‪array Processed labels

Deprecated:: ‪will be removed in TYPO3 v11.0

Definition at line 403 of file LanguageService.php.

References $GLOBALS, and TYPO3\CMS\Core\Localization\LanguageService\$labels.

◆ getLL()

string TYPO3\CMS\Core\Localization\LanguageService::getLL ( $index )

Returns the label with key $index from the globally loaded $LOCAL_LANG array. Mostly used from modules with only one LOCAL_LANG file loaded into the global space.

Parameters

string $index ‪Label key

Returns: ‪string

Definition at line 154 of file LanguageService.php.

References $GLOBALS, and TYPO3\CMS\Core\Localization\LanguageService\getLLL().

◆ getLLL()

string TYPO3\CMS\Core\Localization\LanguageService::getLLL	(	$index,
		$localLanguage
	)

protected

Returns the label with key $index from the $LOCAL_LANG array used as the second argument

Parameters

string	$index	‪Label key
array	$localLanguage	‪$LOCAL_LANG array to get label key from

Returns: ‪string

Definition at line 166 of file LanguageService.php.

References TYPO3\CMS\Core\Localization\LanguageService\$lang, and TYPO3\CMS\Core\Localization\LanguageService\debugLL().

Referenced by TYPO3\CMS\Core\Localization\LanguageService\getLL(), and TYPO3\CMS\Core\Localization\LanguageService\sL().

◆ includeLanguageFileRaw()

array TYPO3\CMS\Core\Localization\LanguageService::includeLanguageFileRaw ( $fileRef )

protected

Includes a locallang file (and possibly additional localized version if configured for), and then puts everything into "default", so "default" is kept as fallback

Parameters

string $fileRef ‪$fileRef is a file-reference

Returns: ‪array

Definition at line 344 of file LanguageService.php.

References TYPO3\CMS\Core\Localization\LanguageService\$labels, and TYPO3\CMS\Core\Localization\LanguageService\readLLfile().

Referenced by TYPO3\CMS\Core\Localization\LanguageService\loadSingleTableDescription().

◆ includeLLFile()

array TYPO3\CMS\Core\Localization\LanguageService::includeLLFile	(	$fileRef,
		$setGlobal = `null`,
		$mergeLocalOntoDefault = `null`
	)

Includes locallang file (and possibly additional localized version if configured for) Read language labels will be merged with $LOCAL_LANG (if $setGlobal = TRUE).

Parameters

string	$fileRef	‪$fileRef is a file-reference
bool	$setGlobal	‪Setting in global variable $LOCAL_LANG (or returning the variable), do not set this, will be dropped in TYPO3 v11.0
bool	$mergeLocalOntoDefault	‪do not set this, will be dropped in TYPO3 v11.0

Returns: ‪array returns the loaded label file

Definition at line 297 of file LanguageService.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\ArrayUtility\mergeRecursiveWithOverrule(), and TYPO3\CMS\Core\Localization\LanguageService\readLLfile().

◆ init()

TYPO3\CMS\Core\Localization\LanguageService::init ( $languageKey )

Initializes the language to fetch XLF labels for. $languageService = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(\TYPO3\CMS\Core\Localization\LanguageService::class); $languageService->init($GLOBALS['BE_USER']->uc['lang']);

Exceptions

Definition at line 122 of file LanguageService.php.

Referenced by TYPO3\CMS\Backend\Controller\LoginController\init().

◆ loadSingleTableDescription()

TYPO3\CMS\Core\Localization\LanguageService::loadSingleTableDescription ( $table )

Loading $TCA_DESCR[$table]['columns'] with content from locallang files as defined in $TCA_DESCR[$table]['refs'] $TCA_DESCR is a global var

Parameters

string $table ‪Table name found as key in global array $TCA_DESCR

Definition at line 232 of file LanguageService.php.

References $GLOBALS, and TYPO3\CMS\Core\Localization\LanguageService\includeLanguageFileRaw().

◆ readLLfile()

array TYPO3\CMS\Core\Localization\LanguageService::readLLfile ( $fileRef )

protected

Includes a locallang file and returns the $LOCAL_LANG array found inside.

Parameters

string $fileRef ‪Input is a file-reference to be a 'local_lang' file containing a $LOCAL_LANG array

Returns: ‪array value of $LOCAL_LANG found in the included file, empty if non found

Definition at line 365 of file LanguageService.php.

References TYPO3\CMS\Core\Localization\LanguageService\$lang, and TYPO3\CMS\Core\Utility\ArrayUtility\mergeRecursiveWithOverrule().

Referenced by TYPO3\CMS\Core\Localization\LanguageService\includeLanguageFileRaw(), TYPO3\CMS\Core\Localization\LanguageService\includeLLFile(), and TYPO3\CMS\Core\Localization\LanguageService\sL().

◆ sL()

string TYPO3\CMS\Core\Localization\LanguageService::sL ( $input )

splitLabel function

All translations are based on $LOCAL_LANG variables. 'language-splitted' labels can therefore refer to a local-lang file + index. Refer to 'Inside TYPO3' for more details

Parameters

string $input ‪Label key/reference

Returns: ‪string

Definition at line 194 of file LanguageService.php.

References TYPO3\CMS\Core\Localization\LanguageService\$lang, $output, TYPO3\CMS\Core\Localization\LanguageService\debugLL(), TYPO3\CMS\Core\Localization\LanguageService\getLLL(), and TYPO3\CMS\Core\Localization\LanguageService\readLLfile().

Member Data Documentation

◆ $debugKey

bool TYPO3\CMS\Core\Localization\LanguageService::$debugKey = false

If TRUE, will show the key/location of labels in the backend.

Definition at line 64 of file LanguageService.php.

◆ $deprecatedPublicMethods

TYPO3\CMS\Core\Localization\LanguageService::$deprecatedPublicMethods

protected

Initial value:

= array( 
        'debugLL' => 'Should never be called directly. use the "debugKey" to actually access the method.',
        'getLLL' => 'Use "getLL()" or "sL()" instead as API methods.',
     )

Definition at line 49 of file LanguageService.php.

◆ $deprecatedPublicProperties

TYPO3\CMS\Core\Localization\LanguageService::$deprecatedPublicProperties

protected

Initial value:

= array( 
        'LL_files_cache' => 'The runtime cache variable is only used for internal purposes, and should never be accessed from the outside. Accessing this property will stop working in TYPO3 v11.0.',
        'LL_labels_cache' => 'The runtime cache variable is only used for internal purposes, and should never be accessed from the outside. Accessing this property will stop working in TYPO3 v11.0.'
     )

Definition at line 44 of file LanguageService.php.

◆ $labels

string [][] TYPO3\CMS\Core\Localization\LanguageService::$labels = array( )

protected

Definition at line 93 of file LanguageService.php.

Referenced by TYPO3\CMS\Core\Localization\LanguageService\getLabelsWithPrefix(), and TYPO3\CMS\Core\Localization\LanguageService\includeLanguageFileRaw().

◆ $lang

string TYPO3\CMS\Core\Localization\LanguageService::$lang = 'default'

This is set to the language that is currently running for the user

Definition at line 58 of file LanguageService.php.

Referenced by TYPO3\CMS\Core\Localization\LanguageService\getLLL(), TYPO3\CMS\Core\Localization\LanguageService\readLLfile(), and TYPO3\CMS\Core\Localization\LanguageService\sL().

◆ $languageDependencies

array TYPO3\CMS\Core\Localization\LanguageService::$languageDependencies = array( )

protected

List of language dependencies for actual language. This is used for local variants of a language that depend on their "main" language, like Brazilian Portuguese or Canadian French.

Definition at line 83 of file LanguageService.php.

◆ $languageFileCache

array TYPO3\CMS\Core\Localization\LanguageService::$languageFileCache = array( )

protected

An internal cache for storing loaded files, see readLLfile()

Definition at line 89 of file LanguageService.php.

◆ $LL_files_cache

array TYPO3\CMS\Core\Localization\LanguageService::$LL_files_cache = array( )

protected

Internal cache for read LL-files

Definition at line 70 of file LanguageService.php.

◆ $LL_labels_cache

array TYPO3\CMS\Core\Localization\LanguageService::$LL_labels_cache = array( )

protected

Internal cache for ll-labels (filled as labels are requested)

Definition at line 76 of file LanguageService.php.

◆ $locales

Locales TYPO3\CMS\Core\Localization\LanguageService::$locales

protected

Definition at line 97 of file LanguageService.php.

Referenced by TYPO3\CMS\Core\Localization\LanguageService\__construct().

◆ $localizationFactory

LocalizationFactory TYPO3\CMS\Core\Localization\LanguageService::$localizationFactory

protected

Definition at line 101 of file LanguageService.php.

Referenced by TYPO3\CMS\Core\Localization\LanguageService\__construct().

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ create()

◆ createFromSiteLanguage()

◆ createFromUserPreferences()

◆ debugLL()

◆ getLabelsWithPrefix()

◆ getLL()

◆ getLLL()

◆ includeLanguageFileRaw()

◆ includeLLFile()

◆ init()

◆ loadSingleTableDescription()

◆ readLLfile()

◆ sL()

Member Data Documentation

◆ $debugKey

◆ $deprecatedPublicMethods

◆ $deprecatedPublicProperties

◆ $labels

◆ $lang

◆ $languageDependencies

◆ $languageFileCache

◆ $LL_files_cache

◆ $LL_labels_cache

◆ $locales

◆ $localizationFactory