MediaWiki master
MediaWiki\Language\LanguageFallback Class Reference

Public Member Functions

 __construct ( $siteLangCode, LocalisationCache $localisationCache, LanguageNameUtils $langNameUtils)
 Do not call this directly.
 
 getAll ( $code, $mode=LanguageFallbackMode::MESSAGES)
 Get the ordered list of fallback languages.
 
 getAllIncludingSiteLanguage ( $code)
 Get the ordered list of fallback languages, ending with the fallback language chain for the site language.
 
 getFirst ( $code)
 Get the first fallback for a given language.
 

Public Attributes

const MESSAGES = LanguageFallbackMode::MESSAGES
 Return a fallback chain for messages in getAll.
 
const STRICT = LanguageFallbackMode::STRICT
 Return a strict fallback chain in getAll.
 

Detailed Description

Since
1.35

Definition at line 15 of file LanguageFallback.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Language\LanguageFallback::__construct ( $siteLangCode,
LocalisationCache $localisationCache,
LanguageNameUtils $langNameUtils )

Do not call this directly.

Use MediaWikiServices.

Since
1.35
Parameters
string$siteLangCodeLanguage code of the site, typically $wgLanguageCode
LocalisationCache$localisationCache
LanguageNameUtils$langNameUtils

Definition at line 50 of file LanguageFallback.php.

Member Function Documentation

◆ getAll()

MediaWiki\Language\LanguageFallback::getAll ( $code,
$mode = LanguageFallbackMode::MESSAGES )

Get the ordered list of fallback languages.

Since
1.35
Parameters
string$codeLanguage code
int | LanguageFallbackMode$modeFallback mode, either MESSAGES (which always falls back to 'en'), or STRICT (which only falls back to 'en' when explicitly defined)
Returns
string[] List of language codes
Note
Using an int for $mode was deprecated in MW 1.46

Definition at line 81 of file LanguageFallback.php.

References MediaWiki\Language\STRICT.

Referenced by MediaWiki\Language\LanguageFallback\getAllIncludingSiteLanguage(), and MediaWiki\Language\LanguageFallback\getFirst().

◆ getAllIncludingSiteLanguage()

MediaWiki\Language\LanguageFallback::getAllIncludingSiteLanguage ( $code)

Get the ordered list of fallback languages, ending with the fallback language chain for the site language.

The site fallback list begins with the site language itself.

Since
1.35
Parameters
string$codeLanguage code
Returns
string[][] [ fallbacks, site fallbacks ]

Definition at line 113 of file LanguageFallback.php.

References MediaWiki\Language\LanguageFallback\getAll().

◆ getFirst()

MediaWiki\Language\LanguageFallback::getFirst ( $code)

Get the first fallback for a given language.

Since
1.35
Parameters
string$code
Returns
string|null

Definition at line 67 of file LanguageFallback.php.

References MediaWiki\Language\LanguageFallback\getAll().

Member Data Documentation

◆ MESSAGES

const MediaWiki\Language\LanguageFallback::MESSAGES = LanguageFallbackMode::MESSAGES

Return a fallback chain for messages in getAll.

Since
1.35
Deprecated
since 1.46; use LanguageFallbackMode::MESSAGES

Definition at line 21 of file LanguageFallback.php.

◆ STRICT

const MediaWiki\Language\LanguageFallback::STRICT = LanguageFallbackMode::STRICT

Return a strict fallback chain in getAll.

Since
1.35
Deprecated
since 1.46; use LanguageFallbackMode::STRICT

Definition at line 28 of file LanguageFallback.php.


The documentation for this class was generated from the following file: