The shared interface for all language converters. More...

Inherited by MediaWiki\Language\LanguageConverter, and TrivialLanguageConverter.

Public Member Functions
	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.

	findVariantLink (&$link, &$nt, $ignoreOtherCond=false)
	If a language supports multiple variants, it is possible that non-existing link in one variant actually exists in another variant.

	getConvRuleTitle ()
	Get the title produced by the conversion rule.

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

	getExtraHashOptions ()
	Returns language specific hash options.

	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.

	getVariants ()
	Get all valid variants.

	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.

	translate ( $text, $variant)
	Translate a string to a variant.

	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.

Detailed Description

The shared interface for all language converters.

Access: internal

Definition at line 33 of file ILanguageConverter.php.

Member Function Documentation

◆ autoConvert()

MediaWiki\Language\ILanguageConverter::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

Implemented in MediaWiki\Language\LanguageConverter, and TrivialLanguageConverter.

◆ autoConvertToAllVariants()

MediaWiki\Language\ILanguageConverter::autoConvertToAllVariants ( $text )

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

Parameters

string $text The text to be converted

Returns: array Variant => converted text

Implemented in MediaWiki\Language\LanguageConverter, and TrivialLanguageConverter.

◆ convert()

MediaWiki\Language\ILanguageConverter::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)

Implemented in TrivialLanguageConverter, and MediaWiki\Language\LanguageConverter.

◆ convertCategoryKey()

MediaWiki\Language\ILanguageConverter::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

Implemented in MediaWiki\Language\LanguageConverter, and TrivialLanguageConverter.

◆ convertHtml()

MediaWiki\Language\ILanguageConverter::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

Implemented in MediaWiki\Language\LanguageConverter, and TrivialLanguageConverter.

◆ convertNamespace()

MediaWiki\Language\ILanguageConverter::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

Implemented in MediaWiki\Language\LanguageConverter, and TrivialLanguageConverter.

◆ convertSplitTitle()

MediaWiki\Language\ILanguageConverter::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

Implemented in MediaWiki\Language\LanguageConverter, and TrivialLanguageConverter.

◆ convertTitle()

MediaWiki\Language\ILanguageConverter::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

Implemented in MediaWiki\Language\LanguageConverter, and TrivialLanguageConverter.

◆ convertTo()

MediaWiki\Language\ILanguageConverter::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

Implemented in MediaWiki\Language\LanguageConverter, and TrivialLanguageConverter.

◆ findVariantLink()

MediaWiki\Language\ILanguageConverter::findVariantLink	(	&	$link,
		&	$nt,
			$ignoreOtherCond = false )

If a language supports multiple variants, it is possible that non-existing link in one variant actually exists in another variant.

This function tries to find it. See e.g., LanguageZh.php The input parameters may be modified upon return

Parameters

string	&$link	The name of the link
Title	&$nt	The title object of the link
bool	$ignoreOtherCond	To disable other conditions when we need to transclude a template or update a category's link

Implemented in TrivialLanguageConverter, and MediaWiki\Language\LanguageConverter.

◆ getConvRuleTitle()

MediaWiki\Language\ILanguageConverter::getConvRuleTitle ( )

Get the title produced by the conversion rule.

Returns: string|false The converted title text

Implemented in MediaWiki\Language\LanguageConverter, and TrivialLanguageConverter.

◆ getDefaultVariant()

MediaWiki\Language\ILanguageConverter::getDefaultVariant ( )

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

Returns: string The default variant code

Implemented in MediaWiki\Language\LanguageConverter, and TrivialLanguageConverter.

◆ getExtraHashOptions()

MediaWiki\Language\ILanguageConverter::getExtraHashOptions ( )

Returns language specific hash options.

Returns: string

Implemented in MediaWiki\Language\LanguageConverter, and TrivialLanguageConverter.

◆ getPreferredVariant()

MediaWiki\Language\ILanguageConverter::getPreferredVariant ( )

Get preferred language variant.

Returns: string The preferred language code

Implemented in MediaWiki\Language\LanguageConverter, and TrivialLanguageConverter.

◆ getURLVariant()

MediaWiki\Language\ILanguageConverter::getURLVariant ( )

Get the variant specified in the URL.

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

Implemented in MediaWiki\Language\LanguageConverter, and TrivialLanguageConverter.

◆ getVariantFallbacks()

MediaWiki\Language\ILanguageConverter::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

Implemented in MediaWiki\Language\LanguageConverter, and TrivialLanguageConverter.

◆ getVariants()

MediaWiki\Language\ILanguageConverter::getVariants ( )

Get all valid variants.

Returns: string[] Contains all valid variants

Implemented in MediaWiki\Language\LanguageConverter, and TrivialLanguageConverter.

◆ guessVariant()

MediaWiki\Language\ILanguageConverter::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

Implemented in MediaWiki\Language\LanguageConverter, and TrivialLanguageConverter.

◆ hasVariant()

MediaWiki\Language\ILanguageConverter::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

Implemented in MediaWiki\Language\LanguageConverter, and TrivialLanguageConverter.

◆ hasVariants()

MediaWiki\Language\ILanguageConverter::hasVariants ( )

Check if this is a language with variants.

Since: 1.35

Returns: bool

Implemented in MediaWiki\Language\LanguageConverter, and TrivialLanguageConverter.

◆ markNoConversion()

MediaWiki\Language\ILanguageConverter::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

Implemented in MediaWiki\Language\LanguageConverter, and TrivialLanguageConverter.

◆ translate()

MediaWiki\Language\ILanguageConverter::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

Implemented in MediaWiki\Language\LanguageConverter, and TrivialLanguageConverter.

◆ updateConversionTable()

MediaWiki\Language\ILanguageConverter::updateConversionTable ( LinkTarget $linkTarget )

Refresh the cache of conversion tables when MediaWiki:Conversiontable* is updated.

Parameters

LinkTarget $linkTarget The LinkTarget of the page being updated

Implemented in MediaWiki\Language\LanguageConverter, and TrivialLanguageConverter.

◆ validateVariant()

MediaWiki\Language\ILanguageConverter::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

Implemented in MediaWiki\Language\LanguageConverter, and TrivialLanguageConverter.

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

includes/language/ILanguageConverter.php

Public Member Functions

Detailed Description

Member Function Documentation

◆ autoConvert()

◆ autoConvertToAllVariants()

◆ convert()

◆ convertCategoryKey()

◆ convertHtml()

◆ convertNamespace()

◆ convertSplitTitle()

◆ convertTitle()

◆ convertTo()

◆ findVariantLink()

◆ getConvRuleTitle()

◆ getDefaultVariant()

◆ getExtraHashOptions()

◆ getPreferredVariant()

◆ getURLVariant()

◆ getVariantFallbacks()

◆ getVariants()

◆ guessVariant()

◆ hasVariant()

◆ hasVariants()

◆ markNoConversion()

◆ translate()

◆ updateConversionTable()

◆ validateVariant()