MediaWiki\Languages\LanguageFactory Class Reference

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

Collaboration diagram for MediaWiki\Languages\LanguageFactory:

Public Member Functions
	__construct (ServiceOptions $options, LocalisationCache $localisationCache, LanguageNameUtils $langNameUtils, LanguageFallback $langFallback, LanguageConverterFactory $langConverterFactory, HookContainer $hookContainer)
	getLanguage ( $code)
	Get a cached or new language object for a given language code. More...
	getParentLanguage ( $code)
	Get the "parent" language which has a converter to convert a "compatible" language (in another variant) to this language (eg. More...

Public Attributes
const	CONSTRUCTOR_OPTIONS

Private Member Functions
	classFromCode ( $code, $fallback=true)
	newFromCode ( $code, $fallback=false)
	Create a language object for a given language code. More...

Private Attributes
HookContainer	$hookContainer
LanguageConverterFactory	$langConverterFactory
LanguageFallback	$langFallback
LanguageNameUtils	$langNameUtils
MapCacheLRU	$langObjCache
LocalisationCache	$localisationCache
ServiceOptions	$options
array	$parentLangCache = []
const	LANG_CACHE_SIZE = 10
	How many distinct Language objects to retain at most in memory (T40439). More...

Detailed Description

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

Since

1.35

Definition at line 42 of file LanguageFactory.php.

Constructor & Destructor Documentation

__construct()

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

Parameters

ServiceOptions	$options
LocalisationCache	$localisationCache
LanguageNameUtils	$langNameUtils
LanguageFallback	$langFallback
LanguageConverterFactory	$langConverterFactory
HookContainer	$hookContainer

Definition at line 85 of file LanguageFactory.php.

References MediaWiki\Languages\LanguageFactory\$hookContainer, MediaWiki\Languages\LanguageFactory\$langConverterFactory, MediaWiki\Languages\LanguageFactory\$langFallback, MediaWiki\Languages\LanguageFactory\$langNameUtils, MediaWiki\Languages\LanguageFactory\$localisationCache, MediaWiki\Languages\LanguageFactory\$options, and MediaWiki\Config\ServiceOptions\assertRequiredOptions().

Member Function Documentation

classFromCode()

MediaWiki\Languages\LanguageFactory::classFromCode (   $code,   $fallback = true  )

private

Parameters

string	$code
bool	$fallback	Whether we're going through language fallback chain

Returns

string Name of the language class

Definition at line 175 of file LanguageFactory.php.

References $fallback.

Referenced by MediaWiki\Languages\LanguageFactory\newFromCode().

getLanguage()

MediaWiki\Languages\LanguageFactory::getLanguage

(

$code

)

Get a cached or new language object for a given language code.

Parameters

string

$code

Exceptions

MWException

if the language code contains dangerous characters, e.g. HTML special characters or characters illegal in MediaWiki titles.

Returns

Language

Definition at line 111 of file LanguageFactory.php.

References MediaWiki\Languages\LanguageFactory\newFromCode().

Referenced by MediaWiki\Languages\LanguageFactory\getParentLanguage().

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

Parameters

string

$code

Returns

Language|null

Since

1.22

Definition at line 191 of file LanguageFactory.php.

References $lang, LanguageConverter\$languagesWithVariants, and MediaWiki\Languages\LanguageFactory\getLanguage().

newFromCode()

MediaWiki\Languages\LanguageFactory::newFromCode (   $code,   $fallback = false  )

private

Create a language object for a given language code.

Parameters

string	$code
bool	$fallback	Whether we're going through language fallback chain

Exceptions

MWException

if the language code or fallback sequence is invalid

Returns

Language

Definition at line 130 of file LanguageFactory.php.

References $fallback, MediaWiki\Languages\LanguageFactory\$hookContainer, MediaWiki\Languages\LanguageFactory\$langConverterFactory, MediaWiki\Languages\LanguageFactory\$langFallback, MediaWiki\Languages\LanguageFactory\$langNameUtils, MediaWiki\Languages\LanguageFactory\$localisationCache, and MediaWiki\Languages\LanguageFactory\classFromCode().

Referenced by MediaWiki\Languages\LanguageFactory\getLanguage().

Member Data Documentation

$hookContainer

HookContainer MediaWiki\Languages\LanguageFactory::$hookContainer

private

Definition at line 59 of file LanguageFactory.php.

Referenced by MediaWiki\Languages\LanguageFactory\__construct(), and MediaWiki\Languages\LanguageFactory\newFromCode().

$langConverterFactory

LanguageConverterFactory MediaWiki\Languages\LanguageFactory::$langConverterFactory

private

Definition at line 56 of file LanguageFactory.php.

Referenced by MediaWiki\Languages\LanguageFactory\__construct(), and MediaWiki\Languages\LanguageFactory\newFromCode().

$langFallback

LanguageFallback MediaWiki\Languages\LanguageFactory::$langFallback

private

Definition at line 53 of file LanguageFactory.php.

Referenced by MediaWiki\Languages\LanguageFactory\__construct(), and MediaWiki\Languages\LanguageFactory\newFromCode().

$langNameUtils

LanguageNameUtils MediaWiki\Languages\LanguageFactory::$langNameUtils

private

Definition at line 50 of file LanguageFactory.php.

Referenced by MediaWiki\Languages\LanguageFactory\__construct(), and MediaWiki\Languages\LanguageFactory\newFromCode().

$langObjCache

MapCacheLRU MediaWiki\Languages\LanguageFactory::$langObjCache

private

Definition at line 62 of file LanguageFactory.php.

$localisationCache

LocalisationCache MediaWiki\Languages\LanguageFactory::$localisationCache

private

Definition at line 47 of file LanguageFactory.php.

Referenced by MediaWiki\Languages\LanguageFactory\__construct(), and MediaWiki\Languages\LanguageFactory\newFromCode().

$options

ServiceOptions MediaWiki\Languages\LanguageFactory::$options

private

Definition at line 44 of file LanguageFactory.php.

Referenced by MediaWiki\Languages\LanguageFactory\__construct().

$parentLangCache

array MediaWiki\Languages\LanguageFactory::$parentLangCache = []

private

Definition at line 65 of file LanguageFactory.php.

CONSTRUCTOR_OPTIONS

const MediaWiki\Languages\LanguageFactory::CONSTRUCTOR_OPTIONS

Initial value:

= [
        'DummyLanguageCodes',
    ]

Access: internal

For use by ServiceWiring

Definition at line 70 of file LanguageFactory.php.

LANG_CACHE_SIZE

const MediaWiki\Languages\LanguageFactory::LANG_CACHE_SIZE = 10

private

How many distinct Language objects to retain at most in memory (T40439).

Definition at line 75 of file LanguageFactory.php.

---

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

• includes/language/LanguageFactory.php