A class that extends LanguageConverterSpecific for converts that use ICU rule-based transliterators. More...

Inherits LanguageConverterSpecific.

Inherited by BanConverter.

Collaboration diagram for LanguageConverterIcu:

[legend]

Public Member Functions

icuTranslate ( $text, $variant)

Translate a string to a variant using ICU transliterator.

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

Public Member Functions inherited from LanguageConverterSpecific

findVariantLink (&$link, &$nt, $ignoreOtherCond=false)

A function wrapper:

Public Member Functions inherited from MediaWiki\Language\LanguageConverter

__construct ( $langobj)

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

autoConvertToAllVariants ( $text)

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

Parameters

string $text The text to be converted

Returns: array Variant => converted text

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)

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

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

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

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

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

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
string	$variant	The target variant code
bool	$clearState	Whether to clear the converter title before conversion (defaults to true)

Returns: string Converted text

getConvRuleTitle ()

Get the title produced by the conversion rule.

Returns: string|false The converted title text

getDefaultVariant ()

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

Returns: string The default variant code

getDescCodeSeparator ()

Get desc code separator.

getDescVarSeparator ()

Get desc var separator.

getExtraHashOptions ()

Returns language specific hash options.

Returns: string

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.

Returns: string The preferred language code

getURLVariant ()

Get the variant specified in the URL.

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

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

getVariantNames ()

getVariants ()

Get all valid variants.

Returns: string[] Contains 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.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

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

hasVariants ()

Check if this is a language with variants.

Since: 1.35

Returns: bool

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

updateConversionTable (PageIdentity $page)

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

Protected Member Functions
	getIcuRules ()
	Get the array mapping variants to ICU transliteration rules.

	getTransliteratorAliases ()
	Get the array mapping variant aliases to the main variant.

	getTransliterators ()
	Get the array mapping variants to ICU transliterators.

	loadDefaultTables ()
	Creates empty tables.

Protected Member Functions inherited from MediaWiki\Language\LanguageConverter
	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.

	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
Transliterator[]	$mTransliterators

Protected Attributes inherited from MediaWiki\Language\LanguageConverter
ReplacementArray[]	$mTables = []

Additional Inherited Members
Static Public Attributes inherited from MediaWiki\Language\LanguageConverter
static array< string, string >	$languagesWithStaticDefaultVariant
	static default variant of languages supporting variants for use with DefaultOptionsLookup.php

static string[]	$languagesWithVariants
	languages supporting variants

Detailed Description

A class that extends LanguageConverterSpecific for converts that use ICU rule-based transliterators.

Definition at line 15 of file LanguageConverterIcu.php.

Member Function Documentation

◆ getIcuRules()

LanguageConverterIcu::getIcuRules ( )

abstractprotected

Get the array mapping variants to ICU transliteration rules.

Subclasses must implement this.

Returns: string[]

Reimplemented in BanConverter.

◆ getTransliteratorAliases()

LanguageConverterIcu::getTransliteratorAliases ( )

protected

Get the array mapping variant aliases to the main variant.

Returns: string[]

Reimplemented in BanConverter.

Definition at line 86 of file LanguageConverterIcu.php.

◆ getTransliterators()

LanguageConverterIcu::getTransliterators ( )

protected

Get the array mapping variants to ICU transliterators.

Returns: Transliterator[]

Definition at line 66 of file LanguageConverterIcu.php.

◆ icuTranslate()

LanguageConverterIcu::icuTranslate	(		$text,
			$variant )

Translate a string to a variant using ICU transliterator.

Parameters

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

Returns: string Translated text

Definition at line 49 of file LanguageConverterIcu.php.

◆ loadDefaultTables()

LanguageConverterIcu::loadDefaultTables ( )

protected

Creates empty tables.

mTransliterators will be used instead.

Reimplemented from MediaWiki\Language\LanguageConverter.

Definition at line 25 of file LanguageConverterIcu.php.

◆ translate()

LanguageConverterIcu::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

Reimplemented from MediaWiki\Language\LanguageConverter.

Definition at line 34 of file LanguageConverterIcu.php.

Member Data Documentation

◆ $mTransliterators

Transliterator [] LanguageConverterIcu::$mTransliterators

protected

Definition at line 20 of file LanguageConverterIcu.php.

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

includes/Language/LanguageConverterIcu.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getIcuRules()

◆ getTransliteratorAliases()

◆ getTransliterators()

◆ icuTranslate()

◆ loadDefaultTables()

◆ translate()

Member Data Documentation

◆ $mTransliterators