MediaWiki master
MediaWiki\Languages\LanguageFactory Class Reference

Internationalisation code See https://www.mediawiki.org/wiki/Special:MyLanguage/Localisation for more information. More...

Public Member Functions

 __construct (ServiceOptions $options, NamespaceInfo $namespaceInfo, LocalisationCache $localisationCache, LanguageNameUtils $langNameUtils, LanguageFallback $langFallback, LanguageConverterFactory $langConverterFactory, HookContainer $hookContainer, Config $config)
 
 getLanguage ( $code)
 Get a cached or new language object for a given language code with normalization of the language code.
 
 getParentLanguage ( $code)
 Get the "parent" language which has a converter to convert a "compatible" language (in another variant) to this language (eg., zh for zh-cn, but not en for en-gb).
 
 getRawLanguage ( $code)
 Get a cached or new language object for a given language code without normalization of the language code.
 

Public Attributes

const CONSTRUCTOR_OPTIONS
 

Detailed Description

Internationalisation code See https://www.mediawiki.org/wiki/Special:MyLanguage/Localisation for more information.

Since
1.35

Definition at line 44 of file LanguageFactory.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Languages\LanguageFactory::__construct ( ServiceOptions $options,
NamespaceInfo $namespaceInfo,
LocalisationCache $localisationCache,
LanguageNameUtils $langNameUtils,
LanguageFallback $langFallback,
LanguageConverterFactory $langConverterFactory,
HookContainer $hookContainer,
Config $config )
Parameters
ServiceOptions$options
NamespaceInfo$namespaceInfo
LocalisationCache$localisationCache
LanguageNameUtils$langNameUtils
LanguageFallback$langFallback
LanguageConverterFactory$langConverterFactory
HookContainer$hookContainer
Config$config

Definition at line 95 of file LanguageFactory.php.

References MediaWiki\Config\ServiceOptions\assertRequiredOptions().

Member Function Documentation

◆ getLanguage()

MediaWiki\Languages\LanguageFactory::getLanguage ( $code)

Get a cached or new language object for a given language code with normalization of the language code.

If the language code comes from user input, check LanguageNameUtils::isValidCode() before calling this method.

The language code is presumed to be a MediaWiki-internal code, unless you pass a Bcp47Code opaque object, in which case it is presumed to be a standard BCP-47 code. (There are, regrettably, some ambiguous codes where this makes a difference.)

As the Language class itself implements Bcp47Code, this method is an efficient and safe downcast if you pass in a Language object.

Parameters
string | Bcp47Code$code
Returns
Language

Definition at line 139 of file LanguageFactory.php.

Referenced by MediaWiki\User\TempUser\LocalizedNumericSerialMapping\__construct(), CollationCkb\__construct(), UppercaseCollation\__construct(), NumericUppercaseCollation\__construct(), IcuCollation\__construct(), and CustomUppercaseCollation\__construct().

◆ getParentLanguage()

MediaWiki\Languages\LanguageFactory::getParentLanguage ( $code)

Get the "parent" language which has a converter to convert a "compatible" language (in another variant) to this language (eg., zh for zh-cn, but not en for en-gb).

Note
This method does not contain the deprecated and compatibility mappings of Language::getLanguage(string).
Parameters
string | Bcp47Code$codeThe language to convert to; can be an internal MediaWiki language code or a Bcp47Code object (which includes Language, which implements Bcp47Code).
Returns
Language|null A base language which has a converter to the given language, or null if none exists.
Since
1.22

Definition at line 251 of file LanguageFactory.php.

◆ getRawLanguage()

MediaWiki\Languages\LanguageFactory::getRawLanguage ( $code)

Get a cached or new language object for a given language code without normalization of the language code.

If the language code comes from user input, check LanguageNameUtils::isValidCode() before calling this method.

Parameters
string$code
Returns
Language
Since
1.39

Definition at line 166 of file LanguageFactory.php.

Referenced by MediaWiki\Pager\AllMessagesTablePager\__construct().

Member Data Documentation

◆ CONSTRUCTOR_OPTIONS

const MediaWiki\Languages\LanguageFactory::CONSTRUCTOR_OPTIONS
Initial value:
= [
]
const DummyLanguageCodes
Name constant for the DummyLanguageCodes setting, for use with Config::get()
Access: internal
For use by ServiceWiring

Definition at line 78 of file LanguageFactory.php.


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