LanguageConverterIcu Class Reference

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

Inherits LanguageConverterSpecific.

Inherited by BanConverter.

Collaboration diagram for LanguageConverterIcu:

Public Member Functions
	icuTranslate ( $text, $variant)
	Translate a string to a variant using ICU transliterator.
	translate ( $text, $variant)
	Translate a string to a variant.
Public Member Functions inherited from LanguageConverterSpecific
	findVariantLink (&$link, &$nt, $ignoreOtherCond=false)
	A function wrapper:
Public Member Functions inherited from LanguageConverter
	__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.
	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.
	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.

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 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 LanguageConverter
ReplacementArray[]	$mTables = []

Additional Inherited Members
Static Public Attributes inherited from 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 27 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 97 of file LanguageConverterIcu.php.

getTransliterators()

LanguageConverterIcu::getTransliterators ( )

protected

Get the array mapping variants to ICU transliterators.

Returns

Transliterator[]

Definition at line 79 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 62 of file LanguageConverterIcu.php.

loadDefaultTables()

LanguageConverterIcu::loadDefaultTables ( )

protected

Creates empty tables.

mTransliterators will be used instead.

Returns

array

Reimplemented from LanguageConverter.

Definition at line 39 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 LanguageConverter.

Definition at line 47 of file LanguageConverterIcu.php.

Member Data Documentation

$mTransliterators

Transliterator [] LanguageConverterIcu::$mTransliterators

protected

Definition at line 32 of file LanguageConverterIcu.php.

---

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

• includes/language/LanguageConverterIcu.php