Base class for language conversion. More...

Inheritance diagram for LanguageConverter:

Public Member Functions
	__construct ($langobj, $maincode, $variants=array(), $variantfallbacks=array(), $flags=array(), $manualLevel=array())
	Constructor.
	armourMath ($text)
	Armour rendered math against conversion.
	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.
	convertLinkToAllVariants ($text)
	Convert link text to all valid variants.
	convertTitle ($title)
	Auto convert a Title object to a readable string in the preferred variant.
	convertTo ($text, $variant)
	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 ()
	Get default variant.
	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.
	getVarSeparatorPattern ()
	Get the cached separator pattern for ConverterRule::parseRules()
	guessVariant ($text, $variant)
	Guess if a text is written in a variant.
	loadDefaultTables ()
	Load default conversion tables.
	loadTables ($fromCache=true)
	Load conversion tables either from the cache or the disk.
	markNoConversion ($text, $noParse=false)
	Enclose a string with the "no conversion" tag.
	parseCachedTable ($code, $subpage= '', $recursive=true)
	Parse the conversion table stored in the cache.
	postLoadTables ()
	Hook for post processing after conversion tables are loaded.
	reloadTables ()
	Reload the conversion tables.
	translate ($text, $variant)
	Translate a string to a variant.
	validateVariant ($variant=null)
	Validate the variant.
Public Attributes
	$mCacheKey
	$mConvRuleTitle = false
	$mDescCodeSep = ':'
	$mDescVarSep = ';'
	$mFlags
	$mHeaderVariant
	$mLangObj
	$mMainLanguageCode
	$mManualLevel
	$mMaxDepth = 10
	$mTables
	$mTablesLoaded = false
	$mUcfirst = false
	$mURLVariant
	$mUserVariant
	$mVariantFallbacks
	$mVariantNames
	$mVariants
	$mVarSeparatorPattern
const	CACHE_VERSION_KEY = 'VERSION 6'
Protected Member Functions
	applyManualConv ($convRule)
	Apply manual conversion rules.
	getHeaderVariant ()
	Determine the language variant from the Accept-Language header.
	getUserVariant ()
	Determine if the user has a variant set.
	recursiveConvertRule ($text, $variant, &$startPos, $depth=0)
	Recursively convert text on the inside.
	recursiveConvertTopLevel ($text, $variant, $depth=0)
	Recursively convert text on the outside.
Private Member Functions
	OnArticleSaveComplete ($article, $user, $text, $summary, $isMinor, $isWatch, $section, $flags, $revision)
	Hook to refresh the cache of conversion tables when MediaWiki:Conversiontable* is updated.

Detailed Description

Base class for language conversion.

Author:: Zhengzhu Feng <[email protected]> fdcn <[email protected]>, shinjiman <[email protected]>, PhiLiP <[email protected]>

Definition at line 31 of file LanguageConverter.php.

Constructor & Destructor Documentation

LanguageConverter::__construct	(	$	langobj,
		$	maincode,
		$	variants = `array()`,
		$	variantfallbacks = `array()`,
		$	flags = `array()`,
		$	manualLevel = `array()`
	)

Constructor.

Parameters:

$langobj	Language: the Language Object
$maincode	String: the main language code of this language
$variants	Array: the supported variants of this language
$variantfallbacks	Array: the fallback language of each variant
$flags	Array: defining the custom strings that maps to the flags
$manualLevel	Array: limit for supported variants

Reimplemented in GanConverter, and ZhConverter.

Definition at line 67 of file LanguageConverter.php.

References $wgDisabledVariants, Language\getLanguageNames(), and wfMemcKey().

Here is the call graph for this function:

Member Function Documentation

LanguageConverter::applyManualConv ( $ convRule ) [protected]

Apply manual conversion rules.

Parameters:

$convRule ConverterRule Object of ConverterRule

Definition at line 487 of file LanguageConverter.php.

References validateVariant().

Referenced by recursiveConvertRule().

Here is the call graph for this function:

Here is the caller graph for this function:

LanguageConverter::armourMath ( $ text )

Armour rendered math against conversion.

Escape special chars in parsed math text. (in most cases are img elements)

Parameters:

$text String: text to armour against conversion

Returns:: String: armoured text where { and } have been converted to { and }

Definition at line 1047 of file LanguageConverter.php.

LanguageConverter::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:

$text	String the text to be converted
$toVariant	bool\|string the target language code

Returns:: String the converted text

Reimplemented in KkConverter, KuConverter, IuConverter, ShiConverter, and SrConverter.

Definition at line 312 of file LanguageConverter.php.

References $changed, $output, $wgParser, Sanitizer\decodeTagAttributes(), Html\expandAttributes(), StringUtils\explode(), getPreferredVariant(), guessVariant(), loadTables(), translate(), wfProfileIn(), and wfProfileOut().

Referenced by GanConverter\convertCategoryKey(), ZhConverter\convertCategoryKey(), recursiveConvertRule(), and recursiveConvertTopLevel().

Here is the call graph for this function:

Here is the caller graph for this function:

LanguageConverter::autoConvertToAllVariants ( $ text )

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

Parameters:

$text String: the text to be converted

Returns:: Array: variant => converted text

Definition at line 454 of file LanguageConverter.php.

References loadTables(), translate(), wfProfileIn(), and wfProfileOut().

Referenced by convertLinkToAllVariants(), and findVariantLink().

Here is the call graph for this function:

Here is the caller graph for this function:

LanguageConverter::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 can not 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

Parameters:

$text String: text to be converted

Returns:: String: converted text

Definition at line 565 of file LanguageConverter.php.

References convertTo(), and getPreferredVariant().

Here is the call graph for this function:

LanguageConverter::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:

$key string

Returns:: string

Reimplemented in KkConverter, ZhConverter, and GanConverter.

Definition at line 1003 of file LanguageConverter.php.

LanguageConverter::convertLinkToAllVariants ( $ text )

Convert link text to all valid variants.

In the first, this function only convert text outside the "-{" "}-" markups. Since the "{" and "}" are not allowed in titles, the text will get all converted always. So I removed this feature and deprecated the function.

Parameters:

$text String: the text to be converted

Returns:: Array: variant => converted text

Deprecated:: since 1.17 Use autoConvertToAllVariants() instead

Definition at line 478 of file LanguageConverter.php.

References autoConvertToAllVariants().

Here is the call graph for this function:

LanguageConverter::convertTitle ( $ title )

Auto convert a Title object to a readable string in the preferred variant.

Parameters:

$title Title a object of Title

Returns:: String: converted title text

Definition at line 528 of file LanguageConverter.php.

References $title, getPreferredVariant(), translate(), and wfMessage().

Here is the call graph for this function:

LanguageConverter::convertTo	(	$	text,
		$	variant
	)

Same as convert() except a extra parameter to custom variant.

Parameters:

$text	String: text to be converted
$variant	String: the target variant code

Returns:: String: converted text

Definition at line 577 of file LanguageConverter.php.

References $wgDisableLangConversion, guessVariant(), and recursiveConvertTopLevel().

Referenced by convert().

Here is the call graph for this function:

Here is the caller graph for this function:

LanguageConverter::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

Parameters:

$link	String: the name of the link
$nt	Mixed: the title object of the link
$ignoreOtherCond	Boolean: to disable other conditions when we need to transclude a template or update a category's link

Returns:: Null, the input parameters may be modified upon return

Reimplemented in KkConverter, KuConverter, IuConverter, ShiConverter, and SrConverter.

Definition at line 709 of file LanguageConverter.php.

References $wgDisableLangConversion, $wgDisableTitleConversion, $wgUser, autoConvertToAllVariants(), and Title\newFromText().

Here is the call graph for this function:

LanguageConverter::getConvRuleTitle ( )

Get the title produced by the conversion rule.

Returns:: String: The converted title text

Definition at line 134 of file LanguageConverter.php.

LanguageConverter::getDefaultVariant ( )

Get default variant.

This function would not be affected by user's settings or headers

Returns:: String: the default variant code

Definition at line 172 of file LanguageConverter.php.

References $wgDefaultLanguageVariant, getURLVariant(), and validateVariant().

Here is the call graph for this function:

LanguageConverter::getExtraHashOptions ( )

Returns language specific hash options.

Returns:: string

Definition at line 775 of file LanguageConverter.php.

References getPreferredVariant().

Here is the call graph for this function:

LanguageConverter::getHeaderVariant ( ) [protected]

Determine the language variant from the Accept-Language header.

Returns:: Mixed: variant if one found, false otherwise.

Definition at line 255 of file LanguageConverter.php.

References $language, $languages, getVariantFallbacks(), and validateVariant().

Referenced by getPreferredVariant().

Here is the call graph for this function:

Here is the caller graph for this function:

LanguageConverter::getPreferredVariant ( )

Get preferred language variant.

Returns:: String: the preferred language code

Definition at line 142 of file LanguageConverter.php.

References $wgDefaultLanguageVariant, $wgUser, getHeaderVariant(), getURLVariant(), getUserVariant(), and validateVariant().

Referenced by autoConvert(), convert(), convertTitle(), SrConverter\findVariantLink(), ShiConverter\findVariantLink(), IuConverter\findVariantLink(), KuConverter\findVariantLink(), KkConverter\findVariantLink(), and getExtraHashOptions().

Here is the call graph for this function:

Here is the caller graph for this function:

LanguageConverter::getURLVariant ( )

Get the variant specified in the URL.

Returns:: Mixed: variant if one found, false otherwise.

Definition at line 204 of file LanguageConverter.php.

References validateVariant().

Referenced by getDefaultVariant(), and getPreferredVariant().

Here is the call graph for this function:

Here is the caller graph for this function:

LanguageConverter::getUserVariant ( ) [protected]

Determine if the user has a variant set.

Returns:: Mixed: variant if one found, false otherwise.

Definition at line 226 of file LanguageConverter.php.

References $wgUser, and validateVariant().

Referenced by getPreferredVariant().

Here is the call graph for this function:

Here is the caller graph for this function:

LanguageConverter::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:

$variant String: the language code of the variant

Returns:: String|array: The code of the fallback language or the main code if there is no fallback

Definition at line 123 of file LanguageConverter.php.

Referenced by getHeaderVariant().

Here is the caller graph for this function:

LanguageConverter::getVariants ( )

Get all valid variants.

Call this instead of using $this->mVariants directly.

Returns:: Array: contains all valid variants

Definition at line 108 of file LanguageConverter.php.

LanguageConverter::getVarSeparatorPattern ( )

Get the cached separator pattern for ConverterRule::parseRules()

Definition at line 1057 of file LanguageConverter.php.

LanguageConverter::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 <[email protected]>

Since:: 1.19

Reimplemented in SrConverter.

Definition at line 790 of file LanguageConverter.php.

Referenced by autoConvert(), and convertTo().

Here is the caller graph for this function:

LanguageConverter::loadDefaultTables ( )

Load default conversion tables.

This method must be implemented in derived class.

Access:: private

Reimplemented in KuConverter, TestConverter, TgConverter, IuConverter, ShiConverter, SrConverter, ZhConverter, KkConverter, and GanConverter.

Definition at line 800 of file LanguageConverter.php.

Referenced by loadTables().

Here is the caller graph for this function:

LanguageConverter::loadTables ( $ fromCache = true )

Load conversion tables either from the cache or the disk.

Access:: private

Parameters:

$fromCache Boolean: load from memcached? Defaults to true.

Definition at line 810 of file LanguageConverter.php.

References $wgMemc, CACHE_VERSION_KEY, loadDefaultTables(), parseCachedTable(), postLoadTables(), wfProfileIn(), and wfProfileOut().

Referenced by autoConvert(), autoConvertToAllVariants(), reloadTables(), ShiConverter\translate(), IuConverter\translate(), and translate().

Here is the call graph for this function:

Here is the caller graph for this function:

LanguageConverter::markNoConversion	(	$	text,
		$	noParse = `false`
	)

Enclose a string with the "no conversion" tag.

This is used by various functions in the Parser.

Parameters:

$text	String: text to be tagged for no conversion
$noParse	Boolean: unused

Returns:: String: the tagged text

Reimplemented in KkConverter, KuConverter, IuConverter, ShiConverter, SrConverter, ZhConverter, and GanConverter.

Definition at line 985 of file LanguageConverter.php.

LanguageConverter::OnArticleSaveComplete	(	$	article,
		$	user,
		$	text,
		$	summary,
		$	isMinor,
		$	isWatch,
		$	section,
		$	flags,
		$	revision
	)		`[private]`

Hook to refresh the cache of conversion tables when MediaWiki:Conversiontable* is updated.

Parameters:

$article	Article object
$user	Object: User object for the current user
$text	String: article text (?)
$summary	String: edit summary of the edit
$isMinor	Boolean: was the edit marked as minor?
$isWatch	Boolean: did the user watch this page or not?
$section	Unused
$flags	Bitfield
$revision	Object: new Revision object or null