TYPO3\CMS\Core\Site\Entity\SiteLanguage Class Reference

Public Member Functions
	__construct (int $languageId, string $locale, UriInterface $base, array $configuration)
	toArray ()
	getLanguageId ()
	getLocale ()
	getBase ()
	getTitle ()
	getNavigationTitle ()
	getWebsiteTitle ()
	getFlagIdentifier ()
	getTypo3Language ()
	hasCustomTypo3Language ()
	getHreflang (bool $fetchCustomSetting=false)
	enabled ()
	isEnabled ()
	getFallbackType ()
	getFallbackLanguageIds ()

Protected Attributes
int	$languageId
Locale	$locale
UriInterface	$base
string	$title = 'Default'
string	$navigationTitle = ''
string	$websiteTitle = ''
string	$flagIdentifier = ''
string	$hreflang = ''
string	$typo3Language = ''
string	$fallbackType = 'strict'
array	$fallbackLanguageIds = array( )
bool	$enabled = true
array	$configuration = array( )

Detailed Description

Entity representing a site_language configuration of a site object.

Definition at line 26 of file SiteLanguage.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Core\Site\Entity\SiteLanguage::__construct	(	int	$languageId,
		string	$locale,
		UriInterface	$base,
		array	$configuration
	)

SiteLanguage constructor.

Definition at line 98 of file SiteLanguage.php.

References TYPO3\CMS\Core\Site\Entity\SiteLanguage\$base, TYPO3\CMS\Core\Site\Entity\SiteLanguage\$configuration, TYPO3\CMS\Core\Site\Entity\SiteLanguage\$fallbackLanguageIds, TYPO3\CMS\Core\Site\Entity\SiteLanguage\$languageId, TYPO3\CMS\Core\Site\Entity\SiteLanguage\$locale, and TYPO3\CMS\Core\Site\Entity\SiteLanguage\enabled().

Member Function Documentation

enabled()

TYPO3\CMS\Core\Site\Entity\SiteLanguage::enabled

(

)

Returns true if the language is available in frontend usage

Definition at line 249 of file SiteLanguage.php.

References TYPO3\CMS\Core\Site\Entity\SiteLanguage\$enabled.

Referenced by TYPO3\CMS\Core\Site\Entity\SiteLanguage\__construct(), and TYPO3\CMS\Frontend\Middleware\SiteBaseRedirectResolver\isLanguageEnabled().

getBase()

TYPO3\CMS\Core\Site\Entity\SiteLanguage::getBase

(

)

Definition at line 179 of file SiteLanguage.php.

References TYPO3\CMS\Core\Site\Entity\SiteLanguage\$base.

Referenced by TYPO3\CMS\Core\Routing\RequestContextFactory\fromSiteLanguage(), TYPO3\CMS\Seo\HrefLang\HrefLangGenerator\getAbsoluteUrl(), TYPO3\CMS\Core\Security\ContentSecurityPolicy\PolicyProvider\getDefaultReportingUriBase(), and TYPO3\CMS\Core\Site\Entity\SiteLanguage\toArray().

getFallbackLanguageIds()

TYPO3\CMS\Core\Site\Entity\SiteLanguage::getFallbackLanguageIds

(

)

Definition at line 267 of file SiteLanguage.php.

References TYPO3\CMS\Core\Site\Entity\SiteLanguage\$fallbackLanguageIds.

Referenced by TYPO3\CMS\Core\Context\LanguageAspectFactory\createFromSiteLanguage(), and TYPO3\CMS\Core\Routing\PageSlugCandidateProvider\getCandidatesForPath().

getFallbackType()

TYPO3\CMS\Core\Site\Entity\SiteLanguage::getFallbackType

(

)

Definition at line 262 of file SiteLanguage.php.

References TYPO3\CMS\Core\Site\Entity\SiteLanguage\$fallbackType.

Referenced by TYPO3\CMS\Core\Context\LanguageAspectFactory\createFromSiteLanguage().

getFlagIdentifier()

TYPO3\CMS\Core\Site\Entity\SiteLanguage::getFlagIdentifier

(

)

Definition at line 199 of file SiteLanguage.php.

References TYPO3\CMS\Core\Site\Entity\SiteLanguage\$flagIdentifier.

getHreflang()

TYPO3\CMS\Core\Site\Entity\SiteLanguage::getHreflang

(

bool

$fetchCustomSetting = false

)

Returns the RFC 1766 / 3066 language tag for hreflang tags

Definition at line 237 of file SiteLanguage.php.

References TYPO3\CMS\Core\Site\Entity\SiteLanguage\$hreflang.

getLanguageId()

TYPO3\CMS\Core\Site\Entity\SiteLanguage::getLanguageId

(

)

Definition at line 169 of file SiteLanguage.php.

References TYPO3\CMS\Core\Site\Entity\SiteLanguage\$languageId.

Referenced by TYPO3\CMS\Core\Context\LanguageAspectFactory\createFromSiteLanguage(), TYPO3\CMS\Core\Routing\PageSlugCandidateProvider\getCandidatesForPath(), TYPO3\CMS\Core\Routing\PageRouter\isRouteReallyValidForLanguage(), TYPO3\CMS\Backend\RecordList\DatabaseRecordList\makeLocalizationPanel(), TYPO3\CMS\Backend\View\PageLayoutContext\setSiteLanguage(), and TYPO3\CMS\Core\Site\Entity\SiteLanguage\toArray().

getLocale()

TYPO3\CMS\Core\Site\Entity\SiteLanguage::getLocale

(

)

Definition at line 174 of file SiteLanguage.php.

References TYPO3\CMS\Core\Site\Entity\SiteLanguage\$locale.

Referenced by TYPO3\CMS\Core\Localization\LanguageServiceFactory\createFromSiteLanguage(), TYPO3\CMS\Core\Localization\Locales\setSystemLocaleFromSiteLanguage(), and TYPO3\CMS\Core\Site\Entity\SiteLanguage\toArray().

getNavigationTitle()

TYPO3\CMS\Core\Site\Entity\SiteLanguage::getNavigationTitle

(

)

Definition at line 189 of file SiteLanguage.php.

References TYPO3\CMS\Core\Site\Entity\SiteLanguage\$title.

Referenced by TYPO3\CMS\Core\Site\Entity\SiteLanguage\toArray().

getTitle()

TYPO3\CMS\Core\Site\Entity\SiteLanguage::getTitle

(

)

Definition at line 184 of file SiteLanguage.php.

References TYPO3\CMS\Core\Site\Entity\SiteLanguage\$title.

Referenced by TYPO3\CMS\Core\Site\Entity\SiteLanguage\toArray().

getTypo3Language()

TYPO3\CMS\Core\Site\Entity\SiteLanguage::getTypo3Language

(

)

Returns the XLF label language key, returns "default" when it is "en". "default" is currently still needed for TypoScript label overloading. For locales like "en-US", this method returns "en_US" which can then be used for XLF file prefixes properly.

Definition at line 210 of file SiteLanguage.php.

References TYPO3\CMS\Core\Site\Entity\SiteLanguage\$typo3Language.

getWebsiteTitle()

TYPO3\CMS\Core\Site\Entity\SiteLanguage::getWebsiteTitle

(

)

Definition at line 194 of file SiteLanguage.php.

References TYPO3\CMS\Core\Site\Entity\SiteLanguage\$websiteTitle.

Referenced by TYPO3\CMS\Core\Site\Entity\SiteLanguage\toArray().

hasCustomTypo3Language()

TYPO3\CMS\Core\Site\Entity\SiteLanguage::hasCustomTypo3Language

(

)

Definition at line 229 of file SiteLanguage.php.

isEnabled()

TYPO3\CMS\Core\Site\Entity\SiteLanguage::isEnabled

(

)

Helper so fluid can work with this as well.

Definition at line 257 of file SiteLanguage.php.

References TYPO3\CMS\Core\Site\Entity\SiteLanguage\$enabled.

Referenced by TYPO3\CMS\Core\Error\PageErrorHandler\PageContentErrorHandler\resolveUrl().

toArray()

TYPO3\CMS\Core\Site\Entity\SiteLanguage::toArray

(

)

Returns the SiteLanguage in an array representation for e.g. the usage in TypoScript.

Definition at line 150 of file SiteLanguage.php.

References TYPO3\CMS\Core\Site\Entity\SiteLanguage\getBase(), TYPO3\CMS\Core\Site\Entity\SiteLanguage\getLanguageId(), TYPO3\CMS\Core\Site\Entity\SiteLanguage\getLocale(), TYPO3\CMS\Core\Site\Entity\SiteLanguage\getNavigationTitle(), TYPO3\CMS\Core\Site\Entity\SiteLanguage\getTitle(), and TYPO3\CMS\Core\Site\Entity\SiteLanguage\getWebsiteTitle().

Member Data Documentation

$base

UriInterface TYPO3\CMS\Core\Site\Entity\SiteLanguage::$base

protected

The Base URL for this language

Definition at line 43 of file SiteLanguage.php.

Referenced by TYPO3\CMS\Core\Site\Entity\SiteLanguage\__construct(), and TYPO3\CMS\Core\Site\Entity\SiteLanguage\getBase().

$configuration

array TYPO3\CMS\Core\Site\Entity\SiteLanguage::$configuration = array( )

protected

Additional parameters configured for this site language

Definition at line 93 of file SiteLanguage.php.

Referenced by TYPO3\CMS\Core\Site\Entity\SiteLanguage\__construct().

$enabled

bool TYPO3\CMS\Core\Site\Entity\SiteLanguage::$enabled = true

protected

Definition at line 88 of file SiteLanguage.php.

Referenced by TYPO3\CMS\Core\Site\Entity\SiteLanguage\enabled(), and TYPO3\CMS\Core\Site\Entity\SiteLanguage\isEnabled().

$fallbackLanguageIds

array TYPO3\CMS\Core\Site\Entity\SiteLanguage::$fallbackLanguageIds = array( )

protected

Definition at line 84 of file SiteLanguage.php.

Referenced by TYPO3\CMS\Core\Site\Entity\SiteLanguage\__construct(), and TYPO3\CMS\Core\Site\Entity\SiteLanguage\getFallbackLanguageIds().

$fallbackType

string TYPO3\CMS\Core\Site\Entity\SiteLanguage::$fallbackType = 'strict'

protected

Definition at line 80 of file SiteLanguage.php.

Referenced by TYPO3\CMS\Core\Site\Entity\SiteLanguage\getFallbackType().

$flagIdentifier

string TYPO3\CMS\Core\Site\Entity\SiteLanguage::$flagIdentifier = ''

protected

The flag key (like "gb" or "fr") used to be used in TYPO3's Backend.

Definition at line 63 of file SiteLanguage.php.

Referenced by TYPO3\CMS\Core\Site\Entity\SiteLanguage\getFlagIdentifier().

$hreflang

string TYPO3\CMS\Core\Site\Entity\SiteLanguage::$hreflang = ''

protected

Language tag for this language defined by RFC 1766 / 3066 for "hreflang" attribute

Definition at line 69 of file SiteLanguage.php.

Referenced by TYPO3\CMS\Core\Site\Entity\SiteLanguage\getHreflang().

$languageId

int TYPO3\CMS\Core\Site\Entity\SiteLanguage::$languageId

protected

The language id.

Definition at line 32 of file SiteLanguage.php.

Referenced by TYPO3\CMS\Core\Site\Entity\SiteLanguage\__construct(), and TYPO3\CMS\Core\Site\Entity\SiteLanguage\getLanguageId().

$locale

Locale TYPO3\CMS\Core\Site\Entity\SiteLanguage::$locale

protected

Locale, like 'de-CH' or 'en-GB'

Definition at line 37 of file SiteLanguage.php.

Referenced by TYPO3\CMS\Core\Site\Entity\SiteLanguage\__construct(), and TYPO3\CMS\Core\Site\Entity\SiteLanguage\getLocale().

$navigationTitle

string TYPO3\CMS\Core\Site\Entity\SiteLanguage::$navigationTitle = ''

protected

Label to be used within language menus

Definition at line 53 of file SiteLanguage.php.

$title

string TYPO3\CMS\Core\Site\Entity\SiteLanguage::$title = 'Default'

protected

Label to be used within TYPO3 to identify the language

Definition at line 48 of file SiteLanguage.php.

Referenced by TYPO3\CMS\Core\Site\Entity\SiteLanguage\getNavigationTitle(), and TYPO3\CMS\Core\Site\Entity\SiteLanguage\getTitle().

$typo3Language

string TYPO3\CMS\Core\Site\Entity\SiteLanguage::$typo3Language = ''

protected

Prefix for TYPO3's language files. If empty, this is fetched from $locale

Definition at line 76 of file SiteLanguage.php.

Referenced by TYPO3\CMS\Core\Site\Entity\SiteLanguage\getTypo3Language().

$websiteTitle

string TYPO3\CMS\Core\Site\Entity\SiteLanguage::$websiteTitle = ''

protected

Localized title of the site to be used in title tag.

Definition at line 58 of file SiteLanguage.php.

Referenced by TYPO3\CMS\Core\Site\Entity\SiteLanguage\getWebsiteTitle().