MediaWiki  master
ILanguageConverter.php
Go to the documentation of this file.
1 <?php
22 
29 interface ILanguageConverter {
30 
35  public function getVariants();
36 
48  public function getVariantFallbacks( $variant );
49 
54  public function getConvRuleTitle();
55 
60  public function getPreferredVariant();
61 
66  public function getDefaultVariant();
67 
77  public function validateVariant( $variant = null );
78 
84  public function getURLVariant();
85 
96  public function autoConvert( $text, $toVariant = false );
97 
107  public function translate( $text, $variant );
108 
115  public function autoConvertToAllVariants( $text );
116 
126  public function convertSplitTitle( $title );
127 
135  public function convertTitle( $title );
136 
144  public function convertNamespace( $index, $variant = null );
145 
164  public function convert( $text );
165 
175  public function convertTo( $text, $variant );
176 
188  public function findVariantLink( &$link, &$nt, $ignoreOtherCond = false );
189 
195  public function getExtraHashOptions();
196 
207  public function guessVariant( $text, $variant );
208 
217  public function markNoConversion( $text, $noParse = false );
218 
227  public function convertCategoryKey( $key );
228 
235  public function updateConversionTable( LinkTarget $linkTarget );
236 
244  public function hasVariants();
245 
256  public function hasVariant( $variant );
257 
266  public function convertHtml( $text );
267 }
The shared interface for all language converters.
convertNamespace( $index, $variant=null)
Get the namespace display name in the preferred variant.
getVariantFallbacks( $variant)
In case some variant is not defined in the markup, we need to have some fallback.
getDefaultVariant()
This function would not be affected by user's settings.
getExtraHashOptions()
Returns language specific hash options.
convertHtml( $text)
Perform output conversion on a string, and encode for safe HTML output.
updateConversionTable(LinkTarget $linkTarget)
Refresh the cache of conversion tables when MediaWiki:Conversiontable* is updated.
findVariantLink(&$link, &$nt, $ignoreOtherCond=false)
If a language supports multiple variants, it is possible that non-existing link in one variant actual...
convertCategoryKey( $key)
Convert the sorting key for category links.
hasVariants()
Check if this is a language with variants.
validateVariant( $variant=null)
Validate the variant and return an appropriate strict internal variant code if one exists.
guessVariant( $text, $variant)
Guess if a text is written in a variant.
convertSplitTitle( $title)
Auto convert a LinkTarget or PageReference to a readable string in the preferred variant,...
getConvRuleTitle()
Get the title produced by the conversion rule.
convert( $text)
Convert text to different variants of a language.
markNoConversion( $text, $noParse=false)
Enclose a string with the "no conversion" tag.
translate( $text, $variant)
Translate a string to a variant.
convertTitle( $title)
Auto convert a LinkTarget or PageReference to a readable string in the preferred variant.
getPreferredVariant()
Get preferred language variant.
convertTo( $text, $variant)
Same as convert() except a extra parameter to custom variant.
hasVariant( $variant)
Strict check if the language has the specific variant.
getURLVariant()
Get the variant specified in the URL.
autoConvertToAllVariants( $text)
Call translate() to convert text to all valid variants.
getVariants()
Get all valid variants.
autoConvert( $text, $toVariant=false)
Dictionary-based conversion.
Interface for objects (potentially) representing a page that can be viewable and linked to on a wiki.