MediaWiki  master
ILanguageConverter.php
Go to the documentation of this file.
1 <?php
23 
30 interface ILanguageConverter {
31 
36  public function getVariants();
37 
49  public function getVariantFallbacks( $variant );
50 
55  public function getConvRuleTitle();
56 
61  public function getPreferredVariant();
62 
67  public function getDefaultVariant();
68 
78  public function validateVariant( $variant = null );
79 
85  public function getURLVariant();
86 
97  public function autoConvert( $text, $toVariant = false );
98 
108  public function translate( $text, $variant );
109 
116  public function autoConvertToAllVariants( $text );
117 
127  public function convertSplitTitle( $title );
128 
136  public function convertTitle( $title );
137 
145  public function convertNamespace( $index, $variant = null );
146 
165  public function convert( $text );
166 
178  public function convertTo( $text, $variant, bool $clearState = true );
179 
191  public function findVariantLink( &$link, &$nt, $ignoreOtherCond = false );
192 
198  public function getExtraHashOptions();
199 
210  public function guessVariant( $text, $variant );
211 
220  public function markNoConversion( $text, $noParse = false );
221 
230  public function convertCategoryKey( $key );
231 
238  public function updateConversionTable( LinkTarget $linkTarget );
239 
247  public function hasVariants();
248 
259  public function hasVariant( $variant );
260 
269  public function convertHtml( $text );
270 }
Represents a title within MediaWiki.
Definition: Title.php:76
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.
convertTo( $text, $variant, bool $clearState=true)
Same as convert() except a extra parameter to custom variant.
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.
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.
Represents the target of a wiki link.
Definition: LinkTarget.php:30
Interface for objects (potentially) representing a page that can be viewable and linked to on a wiki.