MediaWiki master
|
Base class for multi-variant language conversion. More...
Inherits ILanguageConverter.
Inherited by EnConverter, GanConverter, LanguageConverterSpecific, ShConverter, TgConverter, TlyConverter, UzConverter, WuuConverter, and ZhConverter.
Public Member Functions | |
__construct ( $langobj) | |
autoConvert ( $text, $toVariant=false) | |
Dictionary-based conversion. | |
autoConvertToAllVariants ( $text) | |
Call translate() to convert text to all valid variants. | |
convert ( $text) | |
Convert text to different variants of a language. | |
convertCategoryKey ( $key) | |
Convert the sorting key for category links. | |
convertHtml ( $text) | |
Perform output conversion on a string, and encode for safe HTML output. | |
convertNamespace ( $index, $variant=null) | |
Get the namespace display name in the preferred variant. | |
convertSplitTitle ( $title) | |
Automatically converts a LinkTarget or PageReference to a readable string in the preferred variant, separating the namespace and the main part of the title. | |
convertTitle ( $title) | |
Automatically convert a LinkTarget or PageReference to a readable string in the preferred variant. | |
convertTo ( $text, $variant, bool $clearState=true) | |
Same as convert() except a extra parameter to custom variant. | |
findVariantLink (&$link, &$nt, $ignoreOtherCond=false) | |
If a language supports multiple variants, it is possible that non-existing link in one variant actually exists in another variant. | |
getConvRuleTitle () | |
Get the title produced by the conversion rule. | |
getDefaultVariant () | |
This function would not be affected by user's settings. | |
getDescCodeSeparator () | |
Get desc code separator. | |
getDescVarSeparator () | |
Get desc var separator. | |
getExtraHashOptions () | |
Returns language specific hash options. | |
getFlags () | |
Get the strings that map to the flags. | |
getMainCode () | |
Get the language code with converter (the "main" language code). | |
getManualLevel () | |
Get manual level limit for supported variants. | |
getPreferredVariant () | |
Get preferred language variant. | |
getURLVariant () | |
Get the variant specified in the URL. | |
getVariantFallbacks ( $variant) | |
In case some variant is not defined in the markup, we need to have some fallback. | |
getVariantNames () | |
Get variant names. | |
getVariants () | |
Get all valid variants. | |
getVariantsFallbacks () | |
Get language variants fallbacks. | |
getVarSeparatorPattern () | |
Get the cached separator pattern for ConverterRule::parseRules() | |
guessVariant ( $text, $variant) | |
Guess if a text is written in a variant. | |
hasVariant ( $variant) | |
Strict check if the language has the specific variant. | |
hasVariants () | |
Check if this is a language with variants. | |
markNoConversion ( $text, $noParse=false) | |
Enclose a string with the "no conversion" tag. | |
translate ( $text, $variant) | |
Translate a string to a variant. | |
updateConversionTable (LinkTarget $linkTarget) | |
Refresh the cache of conversion tables when MediaWiki:Conversiontable* is updated. | |
validateVariant ( $variant=null) | |
Validate the variant and return an appropriate strict internal variant code if one exists. | |
Static Public Attributes | |
static array< string, string > | $languagesWithStaticDefaultVariant |
static default variant of languages supporting variants for use with DefaultOptionsLookup.php | |
static string[] | $languagesWithVariants |
languages supporting variants | |
Protected Member Functions | |
applyManualConv (ConverterRule $convRule) | |
Apply manual conversion rules. | |
getAdditionalFlags () | |
Provides additional flags for converter. | |
getAdditionalManualLevel () | |
Provides additional flags for converter. | |
getHeaderVariant () | |
Determine the language variant from the Accept-Language header. | |
getLanguageVariants () | |
Get supported variants of the language. | |
getStaticDefaultVariant () | |
Get static default variant. | |
getUserVariant (User $user) | |
Determine if the user has a variant set. | |
loadDefaultTables () | |
Load default conversion tables. | |
loadTables ( $fromCache=true) | |
Load conversion tables either from the cache or the disk. | |
postLoadTables (&$tables) | |
Hook for post-processing after conversion tables are loaded. | |
recursiveConvertRule ( $text, $variant, &$startPos, $depth=0) | |
Recursively convert text on the inside. | |
recursiveConvertTopLevel ( $text, $variant, $depth=0) | |
Recursively convert text on the outside. | |
translateWithoutRomanNumbers ( $text, $variant) | |
Protected Attributes | |
ReplacementArray[] | $mTables = [] |
Base class for multi-variant language conversion.
Definition at line 47 of file LanguageConverter.php.
LanguageConverter::__construct | ( | $langobj | ) |
Language | StubUserLang | $langobj |
Reimplemented in CrhConverter.
Definition at line 121 of file LanguageConverter.php.
|
protected |
Apply manual conversion rules.
ConverterRule | $convRule |
Definition at line 671 of file LanguageConverter.php.
References ConverterRule\getConvTable(), ConverterRule\getRulesAction(), and ConverterRule\getTitle().
LanguageConverter::autoConvert | ( | $text, | |
$toVariant = false ) |
Dictionary-based conversion.
This function would not parse the conversion rules. If you want to parse rules, try to use convert() or convertTo().
string | $text | The text to be converted |
string | false | $toVariant | The target language code |
Implements ILanguageConverter.
Definition at line 459 of file LanguageConverter.php.
LanguageConverter::autoConvertToAllVariants | ( | $text | ) |
Call translate() to convert text to all valid variants.
string | $text | The text to be converted |
Implements ILanguageConverter.
Definition at line 655 of file LanguageConverter.php.
LanguageConverter::convert | ( | $text | ) |
Convert text to different variants of a language.
The automatic conversion is done in autoConvert(). Here we parse the text marked with -{}-, which specifies special conversions of the text that cannot be accomplished in autoConvert().
Syntax of the markup: -{code1:text1;code2:text2;...}- or -{flags|code1:text1;code2:text2;...}- or -{text}- in which case no conversion should take place for text
string | $text | Text to be converted; already html escaped. |
Implements ILanguageConverter.
Definition at line 772 of file LanguageConverter.php.
LanguageConverter::convertCategoryKey | ( | $key | ) |
Convert the sorting key for category links.
This should make different keys that are variants of each other map to the same key.
string | $key |
Implements ILanguageConverter.
Reimplemented in GanConverter, and ZhConverter.
Definition at line 1202 of file LanguageConverter.php.
LanguageConverter::convertHtml | ( | $text | ) |
Perform output conversion on a string, and encode for safe HTML output.
string | $text | Text to be converted |
Implements ILanguageConverter.
Definition at line 1267 of file LanguageConverter.php.
LanguageConverter::convertNamespace | ( | $index, | |
$variant = null ) |
Get the namespace display name in the preferred variant.
int | $index | Namespace id |
string | null | $variant | Variant code or null for preferred variant |
Implements ILanguageConverter.
Definition at line 721 of file LanguageConverter.php.
References NS_MAIN.
LanguageConverter::convertSplitTitle | ( | $title | ) |
Automatically converts a LinkTarget or PageReference to a readable string in the preferred variant, separating the namespace and the main part of the title.
LinkTarget | PageReference | $title |
Implements ILanguageConverter.
Definition at line 702 of file LanguageConverter.php.
LanguageConverter::convertTitle | ( | $title | ) |
Automatically convert a LinkTarget or PageReference to a readable string in the preferred variant.
LinkTarget | PageReference | $title |
Implements ILanguageConverter.
Definition at line 714 of file LanguageConverter.php.
LanguageConverter::convertTo | ( | $text, | |
$variant, | |||
bool | $clearState = true ) |
Same as convert() except a extra parameter to custom variant.
string | $text | Text to be converted; already html escaped |
string | $variant | The target variant code |
bool | $clearState | Whether to clear the converter title before conversion (defaults to true) |
Implements ILanguageConverter.
Definition at line 777 of file LanguageConverter.php.
LanguageConverter::findVariantLink | ( | & | $link, |
& | $nt, | ||
$ignoreOtherCond = false ) |
If a language supports multiple variants, it is possible that non-existing link in one variant actually exists in another variant.
This function tries to find it. See e.g., LanguageZh.php The input parameters may be modified upon return
string | &$link | The name of the link |
Title | &$nt | The title object of the link |
bool | $ignoreOtherCond | To disable other conditions when we need to transclude a template or update a category's link |
Implements ILanguageConverter.
Reimplemented in LanguageConverterSpecific.
Definition at line 918 of file LanguageConverter.php.
References $wgRequest, MediaWiki\Page\PageIdentity\exists(), and NS_MAIN.
|
protected |
Provides additional flags for converter.
By default, it returns empty array and typically should be overridden by implementation of converter.
Reimplemented in SrConverter.
Definition at line 197 of file LanguageConverter.php.
|
protected |
Provides additional flags for converter.
By default, this function returns an empty array and typically should be overridden by the implementation of converter.
Reimplemented in GanConverter, WuuConverter, and ZhConverter.
Definition at line 227 of file LanguageConverter.php.
LanguageConverter::getConvRuleTitle | ( | ) |
Get the title produced by the conversion rule.
Implements ILanguageConverter.
Definition at line 274 of file LanguageConverter.php.
LanguageConverter::getDefaultVariant | ( | ) |
This function would not be affected by user's settings.
Implements ILanguageConverter.
Definition at line 312 of file LanguageConverter.php.
LanguageConverter::getDescCodeSeparator | ( | ) |
Get desc code separator.
By default returns ":", can be overridden by implementation of converter.
Reimplemented in WuuConverter, and ZhConverter.
Definition at line 238 of file LanguageConverter.php.
LanguageConverter::getDescVarSeparator | ( | ) |
Get desc var separator.
By default returns ";", can be overridden by implementation of converter.
Reimplemented in GanConverter, WuuConverter, and ZhConverter.
Definition at line 249 of file LanguageConverter.php.
LanguageConverter::getExtraHashOptions | ( | ) |
Returns language specific hash options.
Implements ILanguageConverter.
Definition at line 992 of file LanguageConverter.php.
|
final |
Get the strings that map to the flags.
Definition at line 170 of file LanguageConverter.php.
|
protected |
Determine the language variant from the Accept-Language header.
Definition at line 409 of file LanguageConverter.php.
References $wgRequest.
|
abstractprotected |
Get supported variants of the language.
Reimplemented in BanConverter, CrhConverter, EnConverter, GanConverter, IuConverter, KuConverter, ShConverter, ShiConverter, SrConverter, TgConverter, TlyConverter, UzConverter, WuuConverter, ZghConverter, and ZhConverter.
|
abstract |
Get the language code with converter (the "main" language code).
Page language code would be the same of the language code with converter. Note that this code might not be included as one of the variant languages.
Reimplemented in BanConverter, CrhConverter, EnConverter, GanConverter, IuConverter, KuConverter, ShConverter, ShiConverter, SrConverter, TgConverter, TlyConverter, UzConverter, WuuConverter, ZghConverter, and ZhConverter.
Referenced by LanguageConverterSpecific\findVariantLink(), and getStaticDefaultVariant().
|
final |
Get manual level limit for supported variants.
Definition at line 207 of file LanguageConverter.php.
LanguageConverter::getPreferredVariant | ( | ) |
Get preferred language variant.
Implements ILanguageConverter.
Definition at line 278 of file LanguageConverter.php.
Referenced by LanguageConverterSpecific\findVariantLink().
|
protected |
Get static default variant.
For use of specify the default variant form when it different from the default "unconverted/mixed-variant form".
Definition at line 143 of file LanguageConverter.php.
References getMainCode().
LanguageConverter::getURLVariant | ( | ) |
Get the variant specified in the URL.
Implements ILanguageConverter.
Definition at line 348 of file LanguageConverter.php.
References $wgRequest.
|
protected |
Determine if the user has a variant set.
User | $user |
Definition at line 372 of file LanguageConverter.php.
References MediaWiki\User\User\isRegistered(), and MediaWiki\User\User\isSafeToLoad().
LanguageConverter::getVariantFallbacks | ( | $variant | ) |
In case some variant is not defined in the markup, we need to have some fallback.
For example, in zh, normally people will define zh-hans and zh-hant, but less so for zh-sg or zh-hk.
When zh-sg is preferred but not defined, we will pick zh-hans in this case. Right now this is only used by zh.
string | $variant | The language code of the variant |
Implements ILanguageConverter.
Definition at line 270 of file LanguageConverter.php.
LanguageConverter::getVariantNames | ( | ) |
Get variant names.
Reimplemented in BanConverter, GanConverter, WuuConverter, and ZhConverter.
Definition at line 258 of file LanguageConverter.php.
|
final |
Get all valid variants.
Implements ILanguageConverter.
Definition at line 264 of file LanguageConverter.php.
|
abstract |
Get language variants fallbacks.
Reimplemented in BanConverter, CrhConverter, EnConverter, GanConverter, IuConverter, KuConverter, ShConverter, ShiConverter, SrConverter, TgConverter, TlyConverter, UzConverter, WuuConverter, ZghConverter, and ZhConverter.
LanguageConverter::getVarSeparatorPattern | ( | ) |
Get the cached separator pattern for ConverterRule::parseRules()
Definition at line 1220 of file LanguageConverter.php.
LanguageConverter::guessVariant | ( | $text, | |
$variant ) |
Guess if a text is written in a variant.
This should be implemented in subclasses.
string | $text | The text to be checked |
string | $variant | Language code of the variant to be checked for |
Implements ILanguageConverter.
Reimplemented in BanConverter, and SrConverter.
Definition at line 998 of file LanguageConverter.php.
LanguageConverter::hasVariant | ( | $variant | ) |
Strict check if the language has the specific variant.
Compare to LanguageConverter::validateVariant() which does a more lenient check and attempts to coerce the given code to a valid one.
string | $variant |
Implements ILanguageConverter.
Definition at line 1263 of file LanguageConverter.php.
LanguageConverter::hasVariants | ( | ) |
Check if this is a language with variants.
Implements ILanguageConverter.
Definition at line 1259 of file LanguageConverter.php.
|
abstractprotected |
Load default conversion tables.
Reimplemented in EnConverter, GanConverter, IuConverter, KuConverter, ShConverter, ShiConverter, SrConverter, TgConverter, TlyConverter, UzConverter, WuuConverter, ZghConverter, ZhConverter, and LanguageConverterIcu.
|
protected |
Load conversion tables either from the cache or the disk.
bool | $fromCache | Whether to load from cache. Defaults to true. |
Definition at line 1014 of file LanguageConverter.php.
LanguageConverter::markNoConversion | ( | $text, | |
$noParse = false ) |
Enclose a string with the "no conversion" tag.
This is used by various functions in the Parser.
string | $text | Text to be tagged for no conversion |
bool | $noParse | Unused |
Implements ILanguageConverter.
Definition at line 1193 of file LanguageConverter.php.
|
protected |
Hook for post-processing after conversion tables are loaded.
ReplacementArray[] | &$tables |
Reimplemented in ZhConverter.
Definition at line 1051 of file LanguageConverter.php.
|
protected |
Recursively convert text on the inside.
string | $text | Text to be converted |
string | $variant | The target variant code |
int | &$startPos | |
int | $depth | Depth of recursion |
Definition at line 851 of file LanguageConverter.php.
References wfMessage().
|
protected |
Recursively convert text on the outside.
Allow to use nested markups to custom rules.
string | $text | Text to be converted |
string | $variant | The target variant code |
int | $depth | Depth of recursion |
Definition at line 798 of file LanguageConverter.php.
LanguageConverter::translate | ( | $text, | |
$variant ) |
Translate a string to a variant.
Doesn't parse rules or do any of that other stuff, for that use convert() or convertTo().
string | $text | Text to convert |
string | $variant | Variant language code |
Implements ILanguageConverter.
Reimplemented in EnConverter, IuConverter, KuConverter, ShiConverter, UzConverter, ZghConverter, ShConverter, SrConverter, and LanguageConverterIcu.
Definition at line 611 of file LanguageConverter.php.
|
protected |
string | $text | Text to convert |
string | $variant | Variant language code |
Definition at line 626 of file LanguageConverter.php.
References $matches.
LanguageConverter::updateConversionTable | ( | LinkTarget | $linkTarget | ) |
Refresh the cache of conversion tables when MediaWiki:Conversiontable* is updated.
LinkTarget | $linkTarget | The LinkTarget of the page being updated |
Implements ILanguageConverter.
Definition at line 1206 of file LanguageConverter.php.
References MediaWiki\Linker\LinkTarget\getDBkey(), MediaWiki\Linker\LinkTarget\getNamespace(), and NS_MEDIAWIKI.
LanguageConverter::validateVariant | ( | $variant = null | ) |
Validate the variant and return an appropriate strict internal variant code if one exists.
Compare to Language::hasVariant() which does a strict test.
string | null | $variant | The variant to validate |
Implements ILanguageConverter.
Definition at line 325 of file LanguageConverter.php.
|
static |
static default variant of languages supporting variants for use with DefaultOptionsLookup.php
Definition at line 79 of file LanguageConverter.php.
|
static |
languages supporting variants
Definition at line 55 of file LanguageConverter.php.
|
protected |
Definition at line 100 of file LanguageConverter.php.