MediaWiki master
|
A service that provides utilities to do with language names and codes. More...
Public Member Functions | |
__construct (ServiceOptions $options, HookContainer $hookContainer) | |
getFileName ( $prefix, $code, $suffix='.php') | |
Get the name of a file for a certain language code. | |
getJsonMessagesFileName ( $code) | |
getLanguageName ( $code, $inLanguage=self::AUTONYMS, $include=self::ALL) | |
getLanguageNames ( $inLanguage=self::AUTONYMS, $include=self::DEFINED) | |
Get an array of language names, indexed by code. | |
getMessagesFileName ( $code) | |
isKnownLanguageTag (string $tag) | |
Returns true if a language code is an IETF tag known to MediaWiki. | |
isSupportedLanguage (string $code) | |
Checks whether any localisation is available for that language tag in MediaWiki (MessagesXx.php or xx.json exists). | |
isValidBuiltInCode (string $code) | |
Returns true if a language code is of a valid form for the purposes of internal customisation of MediaWiki, via Messages*.php or *.json. | |
isValidCode (string $code) | |
Returns true if a language code string is of a valid form, whether it exists. | |
Public Attributes | |
const | ALL = 'all' |
Return all known languages in getLanguageName(s). | |
const | AUTONYMS = null |
Return autonyms in getLanguageName(s). | |
const | CONSTRUCTOR_OPTIONS |
const | DEFINED = 'mw' |
Return in getLanguageName(s) only the languages that are defined by MediaWiki. | |
const | SUPPORTED = 'mwfile' |
Return in getLanguageName(s) only the languages for which we have at least some localisation. | |
A service that provides utilities to do with language names and codes.
See https://www.mediawiki.org/wiki/Special:MyLanguage/Localisation for more information.
Definition at line 41 of file LanguageNameUtils.php.
MediaWiki\Languages\LanguageNameUtils::__construct | ( | ServiceOptions | $options, |
HookContainer | $hookContainer ) |
ServiceOptions | $options | |
HookContainer | $hookContainer |
Definition at line 93 of file LanguageNameUtils.php.
References MediaWiki\Config\ServiceOptions\assertRequiredOptions().
MediaWiki\Languages\LanguageNameUtils::getFileName | ( | $prefix, | |
$code, | |||
$suffix = '.php' ) |
Get the name of a file for a certain language code.
string | $prefix | Prepend this to the filename |
string | $code | Language code |
string | $suffix | Append this to the filename |
Definition at line 307 of file LanguageNameUtils.php.
MediaWiki\Languages\LanguageNameUtils::getJsonMessagesFileName | ( | $code | ) |
string | $code |
Definition at line 330 of file LanguageNameUtils.php.
References $IP.
MediaWiki\Languages\LanguageNameUtils::getLanguageName | ( | $code, | |
$inLanguage = self::AUTONYMS, | |||
$include = self::ALL ) |
string | $code | The code of the language for which to get the name |
null | string | $inLanguage | Code of language in which to return the name (self::AUTONYMS for autonyms) |
string | $include | See getLanguageNames(), except this function defaults to self::ALL instead of self::DEFINED |
Definition at line 293 of file LanguageNameUtils.php.
MediaWiki\Languages\LanguageNameUtils::getLanguageNames | ( | $inLanguage = self::AUTONYMS, | |
$include = self::DEFINED ) |
Get an array of language names, indexed by code.
null | string | $inLanguage | Code of language in which to return the names Use self::AUTONYMS for autonyms (native names) |
string | $include | One of: self::ALL All available languages self::DEFINED Only if the language is defined in MediaWiki or wgExtraLanguageNames (default) self::SUPPORTED Only if the language is in self::DEFINED and has a message file |
Definition at line 195 of file LanguageNameUtils.php.
MediaWiki\Languages\LanguageNameUtils::getMessagesFileName | ( | $code | ) |
string | $code |
Definition at line 319 of file LanguageNameUtils.php.
References $IP.
MediaWiki\Languages\LanguageNameUtils::isKnownLanguageTag | ( | string | $tag | ) |
Returns true if a language code is an IETF tag known to MediaWiki.
string | $tag |
Definition at line 169 of file LanguageNameUtils.php.
MediaWiki\Languages\LanguageNameUtils::isSupportedLanguage | ( | string | $code | ) |
Checks whether any localisation is available for that language tag in MediaWiki (MessagesXx.php or xx.json exists).
string | $code | Language tag (in lower case) |
Definition at line 106 of file LanguageNameUtils.php.
MediaWiki\Languages\LanguageNameUtils::isValidBuiltInCode | ( | string | $code | ) |
Returns true if a language code is of a valid form for the purposes of internal customisation of MediaWiki, via Messages*.php or *.json.
string | $code |
Definition at line 158 of file LanguageNameUtils.php.
MediaWiki\Languages\LanguageNameUtils::isValidCode | ( | string | $code | ) |
Returns true if a language code string is of a valid form, whether it exists.
This includes codes which are used solely for customisation via the MediaWiki namespace.
string | $code |
Definition at line 136 of file LanguageNameUtils.php.
References MediaWiki\Title\MediaWikiTitleCodec\getTitleInvalidRegex().
const MediaWiki\Languages\LanguageNameUtils::ALL = 'all' |
Return all known languages in getLanguageName(s).
Definition at line 50 of file LanguageNameUtils.php.
const MediaWiki\Languages\LanguageNameUtils::AUTONYMS = null |
Return autonyms in getLanguageName(s).
Definition at line 45 of file LanguageNameUtils.php.
const MediaWiki\Languages\LanguageNameUtils::CONSTRUCTOR_OPTIONS |
Definition at line 80 of file LanguageNameUtils.php.
const MediaWiki\Languages\LanguageNameUtils::DEFINED = 'mw' |
Return in getLanguageName(s) only the languages that are defined by MediaWiki.
Definition at line 55 of file LanguageNameUtils.php.
const MediaWiki\Languages\LanguageNameUtils::SUPPORTED = 'mwfile' |
Return in getLanguageName(s) only the languages for which we have at least some localisation.
Definition at line 60 of file LanguageNameUtils.php.