‪TYPO3CMS  10.4
Public Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Core\Site\Entity\SiteLanguage Class Reference

Public Member Functions

 __construct (int $languageId, string $locale, UriInterface $base, array $configuration)
 
array toArray ()
 
int getLanguageId ()
 
string getLocale ()
 
UriInterface getBase ()
 
string getTitle ()
 
string getNavigationTitle ()
 
string getWebsiteTitle ()
 
string getFlagIdentifier ()
 
string getTypo3Language ()
 
string getTwoLetterIsoCode ()
 
string getHreflang ()
 
string getDirection ()
 
bool enabled ()
 
bool isEnabled ()
 
string getFallbackType ()
 
array getFallbackLanguageIds ()
 

Protected Attributes

int $languageId
 
string $locale
 
UriInterface $base
 
string $title = 'Default'
 
string $navigationTitle = ''
 
string $websiteTitle = ''
 
string $flagIdentifier = ''
 
string $twoLetterIsoCode = 'en'
 
string $hreflang = 'en-US'
 
string $direction = ''
 
string $typo3Language = 'default'
 
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 25 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.

Parameters
int$languageId
string$locale
UriInterface$base
array$configuration

Definition at line 115 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()

bool TYPO3\CMS\Core\Site\Entity\SiteLanguage::enabled ( )

Returns true if the language is available in frontend usage

Returns
‪bool

Definition at line 294 of file SiteLanguage.php.

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

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

◆ getBase()

UriInterface TYPO3\CMS\Core\Site\Entity\SiteLanguage::getBase ( )
Returns
‪UriInterface

Definition at line 214 of file SiteLanguage.php.

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

Referenced by TYPO3\CMS\Seo\HrefLang\HrefLangGenerator\getAbsoluteUrl(), TYPO3\CMS\Backend\Form\FormDataProvider\TcaSlug\getPrefixForSite(), and TYPO3\CMS\Core\Site\Entity\SiteLanguage\toArray().

◆ getDirection()

string TYPO3\CMS\Core\Site\Entity\SiteLanguage::getDirection ( )

Returns the language direction

Returns
‪string

Definition at line 284 of file SiteLanguage.php.

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

Referenced by TYPO3\CMS\Frontend\Http\RequestHandler\processHtmlBasedRenderingSettings(), and TYPO3\CMS\Core\Site\Entity\SiteLanguage\toArray().

◆ getFallbackLanguageIds()

array TYPO3\CMS\Core\Site\Entity\SiteLanguage::getFallbackLanguageIds ( )
Returns
‪array

Definition at line 320 of file SiteLanguage.php.

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

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

◆ getFallbackType()

string TYPO3\CMS\Core\Site\Entity\SiteLanguage::getFallbackType ( )
Returns
‪string

Definition at line 312 of file SiteLanguage.php.

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

Referenced by TYPO3\CMS\Core\Context\LanguageAspectFactory\createFromSiteLanguage(), and TYPO3\CMS\Core\Site\Entity\SiteLanguage\toArray().

◆ getFlagIdentifier()

string TYPO3\CMS\Core\Site\Entity\SiteLanguage::getFlagIdentifier ( )
Returns
‪string

Definition at line 246 of file SiteLanguage.php.

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

Referenced by TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumnItem\renderLanguageFlag(), TYPO3\CMS\Backend\View\PageLayoutView\renderLanguageFlag(), and TYPO3\CMS\Core\Site\Entity\SiteLanguage\toArray().

◆ getHreflang()

string TYPO3\CMS\Core\Site\Entity\SiteLanguage::getHreflang ( )

Returns the RFC 1766 / 3066 language tag

Returns
‪string

Definition at line 274 of file SiteLanguage.php.

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

Referenced by TYPO3\CMS\Frontend\Http\RequestHandler\processHtmlBasedRenderingSettings(), and TYPO3\CMS\Core\Site\Entity\SiteLanguage\toArray().

◆ getLanguageId()

int TYPO3\CMS\Core\Site\Entity\SiteLanguage::getLanguageId ( )
Returns
‪int

Definition at line 198 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\Frontend\Middleware\SiteBaseRedirectResolver\isLanguageEnabled(), TYPO3\CMS\Backend\View\PageLayoutContext\setSiteLanguage(), and TYPO3\CMS\Core\Site\Entity\SiteLanguage\toArray().

◆ getLocale()

string TYPO3\CMS\Core\Site\Entity\SiteLanguage::getLocale ( )
Returns
‪string

Definition at line 206 of file SiteLanguage.php.

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

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

◆ getNavigationTitle()

string TYPO3\CMS\Core\Site\Entity\SiteLanguage::getNavigationTitle ( )
Returns
‪string

Definition at line 230 of file SiteLanguage.php.

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

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

◆ getTitle()

string TYPO3\CMS\Core\Site\Entity\SiteLanguage::getTitle ( )
Returns
‪string

Definition at line 222 of file SiteLanguage.php.

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

Referenced by TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumnItem\renderLanguageFlag(), TYPO3\CMS\Backend\View\PageLayoutView\renderLanguageFlag(), and TYPO3\CMS\Core\Site\Entity\SiteLanguage\toArray().

◆ getTwoLetterIsoCode()

string TYPO3\CMS\Core\Site\Entity\SiteLanguage::getTwoLetterIsoCode ( )

Returns the ISO-639-1 language ISO code

Returns
‪string

Definition at line 264 of file SiteLanguage.php.

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

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

◆ getTypo3Language()

string TYPO3\CMS\Core\Site\Entity\SiteLanguage::getTypo3Language ( )
Returns
‪string

Definition at line 254 of file SiteLanguage.php.

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

Referenced by TYPO3\CMS\Core\Localization\LanguageService\createFromSiteLanguage(), TYPO3\CMS\Form\Service\TranslationService\setLanguageKeys(), and TYPO3\CMS\Core\Site\Entity\SiteLanguage\toArray().

◆ getWebsiteTitle()

string TYPO3\CMS\Core\Site\Entity\SiteLanguage::getWebsiteTitle ( )
Returns
‪string

Definition at line 238 of file SiteLanguage.php.

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

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

◆ isEnabled()

bool TYPO3\CMS\Core\Site\Entity\SiteLanguage::isEnabled ( )

Helper so fluid can work with this as well.

Returns
‪bool

Definition at line 304 of file SiteLanguage.php.

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

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

◆ toArray()

array TYPO3\CMS\Core\Site\Entity\SiteLanguage::toArray ( )

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

Returns
‪array

Definition at line 175 of file SiteLanguage.php.

References TYPO3\CMS\Core\Site\Entity\SiteLanguage\enabled(), TYPO3\CMS\Core\Site\Entity\SiteLanguage\getBase(), TYPO3\CMS\Core\Site\Entity\SiteLanguage\getDirection(), TYPO3\CMS\Core\Site\Entity\SiteLanguage\getFallbackLanguageIds(), TYPO3\CMS\Core\Site\Entity\SiteLanguage\getFallbackType(), TYPO3\CMS\Core\Site\Entity\SiteLanguage\getFlagIdentifier(), TYPO3\CMS\Core\Site\Entity\SiteLanguage\getHreflang(), 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(), TYPO3\CMS\Core\Site\Entity\SiteLanguage\getTwoLetterIsoCode(), TYPO3\CMS\Core\Site\Entity\SiteLanguage\getTypo3Language(), 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 105 of file SiteLanguage.php.

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

◆ $direction

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

The direction for this language

Definition at line 80 of file SiteLanguage.php.

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

◆ $enabled

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

Definition at line 100 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 96 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 92 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 = 'en-US'
protected

Language tag for this language defined by RFC 1766 / 3066 for "lang" and "hreflang" attributes

Definition at line 75 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 mapped to the sys_language DB entry.

Definition at line 31 of file SiteLanguage.php.

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

◆ $locale

string 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().

◆ $twoLetterIsoCode

string TYPO3\CMS\Core\Site\Entity\SiteLanguage::$twoLetterIsoCode = 'en'
protected

The iso code for this language (two letter) ISO-639-1

Definition at line 68 of file SiteLanguage.php.

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

◆ $typo3Language

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

Prefix for TYPO3's language files "default" for english, otherwise one of TYPO3's internal language keys. Previously configured via TypoScript config.language = fr

Definition at line 88 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().