MediaWiki  master
LanguageConverterIcu Class Reference

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

Inheritance diagram for LanguageConverterIcu:
Collaboration diagram for LanguageConverterIcu:

Public Member Functions

 icuTranslate ( $text, $variant)
 Translate a string to a variant using ICU transliterator. More...
 
 translate ( $text, $variant)
 Translate a string to a variant. More...
 
- Public Member Functions inherited from LanguageConverterSpecific
 findVariantLink (&$link, &$nt, $ignoreOtherCond=false)
 A function wrapper: More...
 
- Public Member Functions inherited from LanguageConverter
 __construct ( $langobj)
 
 autoConvert ( $text, $toVariant=false)
 Dictionary-based conversion. More...
 
 autoConvertToAllVariants ( $text)
 Call translate() to convert text to all valid variants. More...
 
 convert ( $text)
 Convert text to different variants of a language. More...
 
 convertCategoryKey ( $key)
 Convert the sorting key for category links. More...
 
 convertHtml ( $text)
 Perform output conversion on a string, and encode for safe HTML output. More...
 
 convertNamespace ( $index, $variant=null)
 Get the namespace display name in the preferred variant. More...
 
 convertSplitTitle ( $title)
 Auto convert a LinkTarget or PageReference to a readable string in the preferred variant, separating the namespace and the main part of the title. More...
 
 convertTitle ( $title)
 Auto convert a LinkTarget or PageReference to a readable string in the preferred variant. More...
 
 convertTo ( $text, $variant)
 Same as convert() except a extra parameter to custom variant. More...
 
 getConvRuleTitle ()
 Get the title produced by the conversion rule. More...
 
 getDefaultVariant ()
 This function would not be affected by user's settings. More...
 
 getDescCodeSeparator ()
 Get desc code separator. More...
 
 getDescVarSeparator ()
 Get desc var separator. More...
 
 getExtraHashOptions ()
 Returns language specific hash options. More...
 
 getFlags ()
 Get strings that maps to the flags. More...
 
 getMainCode ()
 Get the language code with converter (the "main" language code). More...
 
 getManualLevel ()
 Get manual level limit for supported variants. More...
 
 getPreferredVariant ()
 Get preferred language variant. More...
 
 getURLVariant ()
 Get the variant specified in the URL. More...
 
 getVariantFallbacks ( $variant)
 In case some variant is not defined in the markup, we need to have some fallback. More...
 
 getVariantNames ()
 Get variant names. More...
 
 getVariants ()
 Get all valid variants for current Converter. More...
 
 getVariantsFallbacks ()
 Get language variants fallbacks. More...
 
 getVarSeparatorPattern ()
 Get the cached separator pattern for ConverterRule::parseRules() More...
 
 guessVariant ( $text, $variant)
 Guess if a text is written in a variant. More...
 
 hasVariant ( $variant)
 Strict check if the language has the specific variant. More...
 
 hasVariants ()
 Check if this is a language with variants. More...
 
 markNoConversion ( $text, $noParse=false)
 Enclose a string with the "no conversion" tag. More...
 
 updateConversionTable (LinkTarget $linkTarget)
 Refresh the cache of conversion tables when MediaWiki:Conversiontable* is updated. More...
 
 validateVariant ( $variant=null)
 Validate the variant and return an appropriate strict internal variant code if one exists. More...
 

Protected Member Functions

 getIcuRules ()
 Get the array mapping variants to ICU transliteration rules. More...
 
 getTransliteratorAliases ()
 Get the array mapping variant aliases to main variant. More...
 
 getTransliterators ()
 Get the array mapping variants to ICU transliterators. More...
 
 loadDefaultTables ()
 Creates empty tables. More...
 
- Protected Member Functions inherited from LanguageConverter
 applyManualConv (ConverterRule $convRule)
 Apply manual conversion rules. More...
 
 getAdditionalFlags ()
 Provides additional flags for converter. More...
 
 getAdditionalManualLevel ()
 Provides additional flags for converter. More...
 
 getHeaderVariant ()
 Determine the language variant from the Accept-Language header. More...
 
 getLanguageVariants ()
 Get supported variants of the language. More...
 
 getStaticDefaultVariant ()
 Get static default variant. More...
 
 getUserVariant (User $user)
 Determine if the user has a variant set. More...
 
 loadTables ( $fromCache=true)
 Load conversion tables either from the cache or the disk. More...
 
 postLoadTables ()
 Hook for post processing after conversion tables are loaded. More...
 
 recursiveConvertRule ( $text, $variant, &$startPos, $depth=0)
 Recursively convert text on the inside. More...
 
 recursiveConvertTopLevel ( $text, $variant, $depth=0)
 Recursively convert text on the outside. More...
 

Protected Attributes

Transliterator[] $mTransliterators
 
- Protected Attributes inherited from LanguageConverter
ReplacementArray[] bool[] $mTables = []
 

Additional Inherited Members

- Static Public Attributes inherited from LanguageConverter
static string[] $languagesWithStaticDefaultVariant
 static default variant of languages supporting variants for use with DefaultOptionsLookup.php More...
 
static array $languagesWithVariants
 languages supporting variants More...
 

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.

Referenced by getTransliterators().

◆ getTransliteratorAliases()

LanguageConverterIcu::getTransliteratorAliases ( )
protected

Get the array mapping variant aliases to main variant.

Returns
string[]

Reimplemented in BanConverter.

Definition at line 94 of file LanguageConverterIcu.php.

Referenced by getTransliterators().

◆ getTransliterators()

LanguageConverterIcu::getTransliterators ( )
protected

Get the array mapping variants to ICU transliterators.

Returns
Transliterator[]

Definition at line 76 of file LanguageConverterIcu.php.

References $mTransliterators, getIcuRules(), and getTransliteratorAliases().

Referenced by icuTranslate().

◆ icuTranslate()

LanguageConverterIcu::icuTranslate (   $text,
  $variant 
)

Translate a string to a variant using ICU transliterator.

Parameters
string$textText to convert
string$variantVariant language code
Returns
string Translated text

Definition at line 59 of file LanguageConverterIcu.php.

References getTransliterators().

Referenced by translate().

◆ loadDefaultTables()

LanguageConverterIcu::loadDefaultTables ( )
protected

Creates empty tables.

mTransliterators will be used instead.

Reimplemented from LanguageConverter.

Definition at line 37 of file LanguageConverterIcu.php.

References LanguageConverter\getVariants().

◆ 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$textText to convert
string$variantVariant language code
Returns
string Translated text

Reimplemented from LanguageConverter.

Definition at line 44 of file LanguageConverterIcu.php.

References icuTranslate().

Member Data Documentation

◆ $mTransliterators

Transliterator [] LanguageConverterIcu::$mTransliterators
protected

Definition at line 32 of file LanguageConverterIcu.php.

Referenced by getTransliterators().


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