Base class for multi-variant language conversion. More...

Inherits ILanguageConverter.

Inherited by EnConverter, GanConverter, LanguageConverterSpecific, ShConverter, TgConverter, TlyConverter, UzConverter, WuuConverter, and ZhConverter.

Collaboration diagram for LanguageConverter:

[legend]

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 = []

Detailed Description

Base class for multi-variant language conversion.

Definition at line 44 of file LanguageConverter.php.

Constructor & Destructor Documentation

◆ __construct()

LanguageConverter::__construct ( $langobj )

Parameters

Language | StubUserLang $langobj

Reimplemented in CrhConverter.

Definition at line 118 of file LanguageConverter.php.

References deprecatePublicProperty(), deprecatePublicPropertyFallback(), getDescCodeSeparator(), getDescVarSeparator(), getFlags(), getMainCode(), getVariantNames(), getVariants(), and getVariantsFallbacks().

Member Function Documentation

◆ applyManualConv()

LanguageConverter::applyManualConv ( ConverterRule $convRule )

protected

Apply manual conversion rules.

Parameters

ConverterRule $convRule

Definition at line 705 of file LanguageConverter.php.

References ConverterRule\getConvTable(), ConverterRule\getRulesAction(), and ConverterRule\getTitle().

◆ autoConvert()

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

Parameters

string	$text	The text to be converted
string \| false	$toVariant	The target language code

Returns: string The converted text

Implements ILanguageConverter.

Definition at line 493 of file LanguageConverter.php.

References Parser\MARKER_PREFIX.

◆ autoConvertToAllVariants()

LanguageConverter::autoConvertToAllVariants ( $text )

Call translate() to convert text to all valid variants.

Parameters

string $text The text to be converted

Returns: array Variant => converted text

Implements ILanguageConverter.

Definition at line 689 of file LanguageConverter.php.

◆ convert()

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

Warning: Glossary state is maintained between calls. Never feed this method input that hasn't properly been escaped as it may result in an XSS in subsequent calls, even if those subsequent calls properly escape things.

Parameters

string $text Text to be converted; already html escaped.

Returns: string Converted text (html)

Implements ILanguageConverter.

Definition at line 806 of file LanguageConverter.php.

◆ convertCategoryKey()

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.

Parameters

string $key

Returns: string

Implements ILanguageConverter.

Reimplemented in GanConverter, KkConverter, and ZhConverter.

Definition at line 1237 of file LanguageConverter.php.

◆ convertHtml()

LanguageConverter::convertHtml ( $text )

Perform output conversion on a string, and encode for safe HTML output.

Since: 1.35

Parameters

string $text Text to be converted

Returns: string string converted to be safely used in HTML

Implements ILanguageConverter.

Definition at line 1303 of file LanguageConverter.php.

◆ convertNamespace()

LanguageConverter::convertNamespace	(		$index,
			$variant = null )

Get the namespace display name in the preferred variant.

Parameters

int	$index	Namespace id
string \| null	$variant	Variant code or null for preferred variant

Returns: string Namespace name for display

Implements ILanguageConverter.

Definition at line 755 of file LanguageConverter.php.

References NS_MAIN.

◆ convertSplitTitle()

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.

Since: 1.39

Parameters

LinkTarget | PageReference $title

Returns: string[] Three elements: converted namespace text, converted namespace separator, and the converted main part of the title

Implements ILanguageConverter.

Definition at line 736 of file LanguageConverter.php.

◆ convertTitle()

LanguageConverter::convertTitle ( $title )

Automatically convert a LinkTarget or PageReference to a readable string in the preferred variant.

Parameters

LinkTarget | PageReference $title

Returns: string Converted title text

Implements ILanguageConverter.

Definition at line 748 of file LanguageConverter.php.

◆ convertTo()

LanguageConverter::convertTo	(		$text,
			$variant,
		bool	$clearState = true )

Same as convert() except a extra parameter to custom variant.

Parameters

string	$text	Text to be converted; already html escaped
-taint	$text	exec_html
string	$variant	The target variant code
bool	$clearState	Whether to clear the converter title before conversion (defaults to true)

Returns: string Converted text; -taint escaped

Implements ILanguageConverter.

Definition at line 811 of file LanguageConverter.php.

◆ findVariantLink()

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

Parameters

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 954 of file LanguageConverter.php.

References $wgRequest, MediaWiki\Page\PageIdentity\exists(), and NS_MAIN.

◆ getAdditionalFlags()

LanguageConverter::getAdditionalFlags ( )

protected

Provides additional flags for converter.

By default, it returns empty array and typically should be overridden by implementation of converter.

Returns: array

Reimplemented in SrConverter.

Definition at line 231 of file LanguageConverter.php.

◆ getAdditionalManualLevel()

LanguageConverter::getAdditionalManualLevel ( )

protected

Provides additional flags for converter.

By default, this function returns an empty array and typically should be overridden by the implementation of converter.

Since: 1.36

Returns: array

Reimplemented in GanConverter, WuuConverter, and ZhConverter.

Definition at line 261 of file LanguageConverter.php.

◆ getConvRuleTitle()

LanguageConverter::getConvRuleTitle ( )

Get the title produced by the conversion rule.

Returns: string|false The converted title text

Implements ILanguageConverter.

Definition at line 308 of file LanguageConverter.php.

◆ getDefaultVariant()

LanguageConverter::getDefaultVariant ( )

This function would not be affected by user's settings.

Returns: string The default variant code

Implements ILanguageConverter.

Definition at line 346 of file LanguageConverter.php.

◆ getDescCodeSeparator()

LanguageConverter::getDescCodeSeparator ( )

Get desc code separator.

By default returns ":", can be overridden by implementation of converter.

Since: 1.36

Returns: string

Reimplemented in WuuConverter, and ZhConverter.

Definition at line 272 of file LanguageConverter.php.

Referenced by __construct().

◆ getDescVarSeparator()

LanguageConverter::getDescVarSeparator ( )

Get desc var separator.

By default returns ";", can be overridden by implementation of converter.

Since: 1.36

Returns: string

Reimplemented in GanConverter, WuuConverter, and ZhConverter.

Definition at line 283 of file LanguageConverter.php.

Referenced by __construct().

◆ getExtraHashOptions()

LanguageConverter::getExtraHashOptions ( )

Returns language specific hash options.

Returns: string

Implements ILanguageConverter.

Definition at line 1028 of file LanguageConverter.php.

◆ getFlags()

LanguageConverter::getFlags ( )

final

Get the strings that map to the flags.

Since: 1.36

Returns: array

Definition at line 204 of file LanguageConverter.php.

Referenced by __construct().

◆ getHeaderVariant()

LanguageConverter::getHeaderVariant ( )

protected

Determine the language variant from the Accept-Language header.

Returns: string|null Variant if one found, null otherwise

Definition at line 443 of file LanguageConverter.php.

References $wgRequest.

◆ getLanguageVariants()

LanguageConverter::getLanguageVariants ( )

abstractprotected

Get supported variants of the language.

Since: 1.36

Returns: array

Reimplemented in BanConverter, CrhConverter, EnConverter, GanConverter, IuConverter, KkConverter, KuConverter, ShConverter, ShiConverter, SrConverter, TgConverter, TlyConverter, UzConverter, WuuConverter, and ZhConverter.

◆ getMainCode()

LanguageConverter::getMainCode ( )

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.

Since: 1.36

Returns: string

Reimplemented in BanConverter, CrhConverter, EnConverter, GanConverter, IuConverter, KkConverter, KuConverter, ShConverter, ShiConverter, SrConverter, TgConverter, TlyConverter, UzConverter, WuuConverter, and ZhConverter.

Referenced by __construct(), LanguageConverterSpecific\findVariantLink(), and getStaticDefaultVariant().

◆ getManualLevel()

LanguageConverter::getManualLevel ( )

final

Get manual level limit for supported variants.

Since: 1.36

Returns: array

Definition at line 241 of file LanguageConverter.php.

◆ getPreferredVariant()

LanguageConverter::getPreferredVariant ( )

Get preferred language variant.

Returns: string The preferred language code

Implements ILanguageConverter.

Definition at line 312 of file LanguageConverter.php.

Referenced by LanguageConverterSpecific\findVariantLink().

◆ getStaticDefaultVariant()

LanguageConverter::getStaticDefaultVariant ( )

protected

Get static default variant.

For use of specify the default variant form when it different from the default "unconverted/mixed-variant form".

Since: 1.40

Returns: string

Definition at line 177 of file LanguageConverter.php.

References getMainCode().

◆ getURLVariant()

LanguageConverter::getURLVariant ( )

Get the variant specified in the URL.

Returns: string|null Variant if one found, null otherwise

Implements ILanguageConverter.

Definition at line 382 of file LanguageConverter.php.

References $wgRequest.

◆ getUserVariant()

LanguageConverter::getUserVariant ( User $user )

protected

Determine if the user has a variant set.

Parameters

User $user

Returns: string|null Variant if one found, null otherwise

Definition at line 406 of file LanguageConverter.php.

References MediaWiki\User\User\isRegistered(), and MediaWiki\User\User\isSafeToLoad().

◆ getVariantFallbacks()

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.

Parameters

string $variant The language code of the variant

Returns: string|array The code of the fallback language or the main code if there is no fallback

Implements ILanguageConverter.

Definition at line 304 of file LanguageConverter.php.

◆ getVariantNames()

LanguageConverter::getVariantNames ( )

Get variant names.

Returns: array

Reimplemented in BanConverter, GanConverter, WuuConverter, and ZhConverter.

Definition at line 292 of file LanguageConverter.php.

Referenced by __construct().

◆ getVariants()

LanguageConverter::getVariants ( )

final

Get all valid variants.

Returns: string[] Contains all valid variants

Implements ILanguageConverter.

Definition at line 298 of file LanguageConverter.php.

Referenced by __construct().

◆ getVariantsFallbacks()

LanguageConverter::getVariantsFallbacks ( )

abstract

Get language variants fallbacks.

Since: 1.36

Returns: array

Reimplemented in BanConverter, CrhConverter, EnConverter, GanConverter, IuConverter, KkConverter, KuConverter, ShConverter, ShiConverter, SrConverter, TgConverter, TlyConverter, UzConverter, WuuConverter, and ZhConverter.

Referenced by __construct().

◆ getVarSeparatorPattern()

LanguageConverter::getVarSeparatorPattern ( )

Get the cached separator pattern for ConverterRule::parseRules()

Returns: string

Definition at line 1255 of file LanguageConverter.php.

◆ guessVariant()

LanguageConverter::guessVariant	(		$text,
			$variant )

Guess if a text is written in a variant.

This should be implemented in subclasses.

Parameters

string	$text	The text to be checked
string	$variant	Language code of the variant to be checked for

Returns: bool True if $text appears to be written in $variant, false if not

Author: Nikola Smolenski smole.nosp@m.nsk@.nosp@m.eunet.nosp@m..rs

Since: 1.19

Implements ILanguageConverter.

Reimplemented in BanConverter, and SrConverter.

Definition at line 1034 of file LanguageConverter.php.

◆ hasVariant()

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.

Since: 1.35

Parameters

string $variant

Returns: bool

Implements ILanguageConverter.

Definition at line 1299 of file LanguageConverter.php.

◆ hasVariants()

LanguageConverter::hasVariants ( )

Check if this is a language with variants.

Since: 1.35

Returns: bool

Implements ILanguageConverter.

Definition at line 1295 of file LanguageConverter.php.

◆ loadDefaultTables()

LanguageConverter::loadDefaultTables ( )

abstractprotected

Load default conversion tables.

Returns: array

Reimplemented in EnConverter, GanConverter, IuConverter, KkConverter, KuConverter, ShConverter, ShiConverter, SrConverter, TgConverter, TlyConverter, UzConverter, WuuConverter, ZhConverter, and LanguageConverterIcu.

◆ loadTables()

LanguageConverter::loadTables ( $fromCache = true )

protected

Load conversion tables either from the cache or the disk.

Access: private

Parameters

bool $fromCache Whether to load from cache. Defaults to true.

Definition at line 1050 of file LanguageConverter.php.

◆ markNoConversion()

LanguageConverter::markNoConversion	(		$text,
			$noParse = false )

Enclose a string with the "no conversion" tag.

This is used by various functions in the Parser.

Parameters

string	$text	Text to be tagged for no conversion
bool	$noParse	Unused

Returns: string The tagged text

Implements ILanguageConverter.

Definition at line 1228 of file LanguageConverter.php.

◆ postLoadTables()

LanguageConverter::postLoadTables ( & $tables )

protected

Hook for post-processing after conversion tables are loaded.

Parameters

ReplacementArray[] &$tables

Reimplemented in KkConverter, and ZhConverter.

Definition at line 1086 of file LanguageConverter.php.

◆ recursiveConvertRule()

LanguageConverter::recursiveConvertRule	(		$text,
			$variant,
		&	$startPos,
			$depth = 0 )

protected

Recursively convert text on the inside.

Parameters

string	$text	Text to be converted
string	$variant	The target variant code
int	&$startPos
int	$depth	Depth of recursion

Exceptions

MWException

Returns: string Converted text

Definition at line 887 of file LanguageConverter.php.

References wfMessage().

◆ recursiveConvertTopLevel()

LanguageConverter::recursiveConvertTopLevel	(	$text,
		$variant,
		$depth = 0 )

protected

Recursively convert text on the outside.

Allow to use nested markups to custom rules.

Parameters

string	$text	Text to be converted
string	$variant	The target variant code
int	$depth	Depth of recursion

Returns: string Converted text

Definition at line 832 of file LanguageConverter.php.

◆ translate()

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

Parameters

string	$text	Text to convert
string	$variant	Variant language code

Returns: string Translated text

Implements ILanguageConverter.

Reimplemented in EnConverter, IuConverter, KkConverter, KuConverter, ShiConverter, UzConverter, ShConverter, SrConverter, and LanguageConverterIcu.

Definition at line 645 of file LanguageConverter.php.

◆ translateWithoutRomanNumbers()

LanguageConverter::translateWithoutRomanNumbers	(		$text,
			$variant )

protected

Parameters

string	$text	Text to convert
string	$variant	Variant language code

Returns: string Translated text

Definition at line 660 of file LanguageConverter.php.

References $matches.

◆ updateConversionTable()

LanguageConverter::updateConversionTable ( LinkTarget $linkTarget )

Refresh the cache of conversion tables when MediaWiki:Conversiontable* is updated.

Parameters

LinkTarget $linkTarget The LinkTarget of the page being updated

Implements ILanguageConverter.

Definition at line 1241 of file LanguageConverter.php.

References MediaWiki\Linker\LinkTarget\getDBkey(), MediaWiki\Linker\LinkTarget\getNamespace(), and NS_MEDIAWIKI.

◆ validateVariant()

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.

Parameters

string | null $variant The variant to validate

Returns: string|null Returns an equivalent valid variant code if possible, null otherwise

Implements ILanguageConverter.

Definition at line 359 of file LanguageConverter.php.

Member Data Documentation

◆ $languagesWithStaticDefaultVariant

array<string,string> LanguageConverter::$languagesWithStaticDefaultVariant

static

Initial value:

= [
        'ban' => 'ban',
        'en' => 'en',
        'crh' => 'crh',
        'gan' => 'gan',
        'iu' => 'iu',
        'kk' => 'kk',
        'ku' => 'ku',
        'sh' => 'sh-latn',
        'shi' => 'shi',
        'sr' => 'sr',
        'tg' => 'tg',
        'tly' => 'tly',
        'uz' => 'uz',
        'wuu' => 'wuu',
        'zh' => 'zh',
    ]

static default variant of languages supporting variants for use with DefaultOptionsLookup.php

Since: 1.40

Definition at line 76 of file LanguageConverter.php.

◆ $languagesWithVariants

string [] LanguageConverter::$languagesWithVariants

static

Initial value:

= [
        'ban',
        'en',
        'crh',
        'gan',
        'iu',
        'kk',
        'ku',
        'sh',
        'shi',
        'sr',
        'tg',
        'tly',
        'uz',
        'wuu',
        'zh',
    ]

languages supporting variants

Since: 1.20

Definition at line 52 of file LanguageConverter.php.

◆ $mTables

ReplacementArray [] LanguageConverter::$mTables = []

protected

Definition at line 97 of file LanguageConverter.php.

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

includes/language/LanguageConverter.php

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ applyManualConv()

◆ autoConvert()

◆ autoConvertToAllVariants()

◆ convert()

◆ convertCategoryKey()

◆ convertHtml()

◆ convertNamespace()

◆ convertSplitTitle()

◆ convertTitle()

◆ convertTo()

◆ findVariantLink()

◆ getAdditionalFlags()

◆ getAdditionalManualLevel()

◆ getConvRuleTitle()

◆ getDefaultVariant()

◆ getDescCodeSeparator()

◆ getDescVarSeparator()

◆ getExtraHashOptions()

◆ getFlags()

◆ getHeaderVariant()

◆ getLanguageVariants()

◆ getMainCode()

◆ getManualLevel()

◆ getPreferredVariant()

◆ getStaticDefaultVariant()

◆ getURLVariant()

◆ getUserVariant()

◆ getVariantFallbacks()

◆ getVariantNames()

◆ getVariants()

◆ getVariantsFallbacks()

◆ getVarSeparatorPattern()

◆ guessVariant()

◆ hasVariant()

◆ hasVariants()

◆ loadDefaultTables()

◆ loadTables()

◆ markNoConversion()

◆ postLoadTables()

◆ recursiveConvertRule()

◆ recursiveConvertTopLevel()

◆ translate()

◆ translateWithoutRomanNumbers()

◆ updateConversionTable()

◆ validateVariant()

Member Data Documentation

◆ $languagesWithStaticDefaultVariant

◆ $languagesWithVariants

◆ $mTables