Base class for language conversion. More...

Inheritance diagram for LanguageConverter:

Collaboration 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.
	convertNamespace ($index, $variant=null)
	Get the namespace display name in the preferred variant.
	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
string	$mCacheKey
	Memcached key name.
	$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 7'
Static Public Attributes
static	$languagesWithVariants
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
	OnPageContentSaveComplete ($page, $user, $content, $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:

Language	$langobj
string	$maincode	The main language code of this language
array	$variants	The supported variants of this language
array	$variantfallbacks	The fallback language of each variant
array	$flags	Defining the custom strings that maps to the flags
array	$manualLevel	Limit for supported variants

Reimplemented in GanConverter, and ZhConverter.

Definition at line 83 of file LanguageConverter.php.

Member Function Documentation

LanguageConverter::applyManualConv ( $ convRule ) [protected]

Apply manual conversion rules.

Parameters:

ConverterRule $convRule

Definition at line 497 of file LanguageConverter.php.

LanguageConverter::armourMath ( $ text )

Armour rendered math against conversion.

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

Parameters:

string $text Text to armour against conversion

Returns:: string Armoured text where { and } have been converted to { and }

Deprecated:: since 1.22 is no longer used

Definition at line 1095 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:

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

Returns:: string The converted text

Definition at line 337 of file LanguageConverter.php.

Referenced by GanConverter\convertCategoryKey(), ZhConverter\convertCategoryKey(), and KkConverter\convertCategoryKey().

LanguageConverter::autoConvertToAllVariants ( $ text )

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

Parameters:

string $text The text to be converted

Returns:: array Variant => converted text

Definition at line 479 of file LanguageConverter.php.

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:

string $text Text to be converted

Returns:: string Converted text

Definition at line 595 of file LanguageConverter.php.

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:

string $key

Returns:: string

Reimplemented in KkConverter, ZhConverter, and GanConverter.

Definition at line 1050 of file LanguageConverter.php.

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

Definition at line 557 of file LanguageConverter.php.

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 538 of file LanguageConverter.php.

LanguageConverter::convertTo	(	$	text,
		$	variant
	)

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

Parameters:

string	$text	Text to be converted
string	$variant	The target variant code

Returns:: string Converted text

Definition at line 607 of file LanguageConverter.php.

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

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

Definition at line 746 of file LanguageConverter.php.

LanguageConverter::getConvRuleTitle ( )

Get the title produced by the conversion rule.

Returns:: string The converted title text

Definition at line 149 of file LanguageConverter.php.

LanguageConverter::getDefaultVariant ( )

Get default variant.

This function would not be affected by user's settings

Returns:: string The default variant code

Definition at line 187 of file LanguageConverter.php.

LanguageConverter::getExtraHashOptions ( )

Returns language specific hash options.

Returns:: string

Definition at line 813 of file LanguageConverter.php.

LanguageConverter::getHeaderVariant ( ) [protected]

Determine the language variant from the Accept-Language header.

Returns:: mixed Variant if one found, false otherwise.

Definition at line 280 of file LanguageConverter.php.

LanguageConverter::getPreferredVariant ( )

Get preferred language variant.

Returns:: string The preferred language code

Definition at line 157 of file LanguageConverter.php.

Referenced by SrConverter\findVariantLink(), ShiConverter\findVariantLink(), IuConverter\findVariantLink(), KuConverter\findVariantLink(), and KkConverter\findVariantLink().

LanguageConverter::getURLVariant ( )

Get the variant specified in the URL.

Returns:: mixed Variant if one found, false otherwise.

Definition at line 223 of file LanguageConverter.php.

LanguageConverter::getUserVariant ( ) [protected]

Determine if the user has a variant set.

Returns:: mixed Variant if one found, false otherwise.

Definition at line 246 of file LanguageConverter.php.

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:

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

Definition at line 138 of file LanguageConverter.php.

LanguageConverter::getVariants ( )

Get all valid variants.

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

Returns:: array Contains all valid variants

Definition at line 123 of file LanguageConverter.php.

LanguageConverter::getVarSeparatorPattern ( )

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

Returns:: string

Definition at line 1106 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 829 of file LanguageConverter.php.

LanguageConverter::loadDefaultTables ( )

Load default conversion tables.

This method must be implemented in derived class.

Access:: private

Exceptions:

MWException

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

Definition at line 840 of file LanguageConverter.php.

LanguageConverter::loadTables ( $ fromCache = true )

Load conversion tables either from the cache or the disk.

Access:: private

Parameters:

bool $fromCache Load from memcached? Defaults to true.

Definition at line 851 of file LanguageConverter.php.

Referenced by SrConverter\translate(), ShiConverter\translate(), IuConverter\translate(), and KuConverter\translate().

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

Definition at line 1032 of file LanguageConverter.php.

LanguageConverter::OnPageContentSaveComplete	(	$	page,
		$	user,
		$	content,
		$	summary,
		$	isMinor,
		$	isWatch,
		$	section,
		$	flags,
		$	revision
	)		`[private]`

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

Parameters:

WikiPage	$page
User	$user	User object for the current user
Content	$content	New page content
string	$summary	Edit summary of the edit
bool	$isMinor	Was the edit marked as minor?
null	$isWatch	Unused.
null	$section	Unused.
int	$flags	Bitfield
Revision \| null	$revision	New Revision object or null

Returns:: bool True

Definition at line 1070 of file LanguageConverter.php.

LanguageConverter::parseCachedTable	(	$	code,
		$	subpage = `''`,
		$	recursive = `true`
	)

Parse the conversion table stored in the cache.

The tables should be in blocks of the following form: -{ word => word ; word => word ; ... }-

To make the tables more manageable, subpages are allowed and will be parsed recursively if $recursive == true.

Parameters:

string	$code	Language code
string	$subpage	Subpage name
bool	$recursive	Parse subpages recursively? Defaults to true.

Returns:: array

Definition at line 925 of file LanguageConverter.php.

LanguageConverter::postLoadTables ( )

Hook for post processing after conversion tables are loaded.

Reimplemented in KkConverter, and ZhConverter.

Definition at line 889 of file LanguageConverter.php.

LanguageConverter::recursiveConvertRule	(	$	text,
		$	variant,
		&$	startPos,
		$	depth = `0`
	)		`[protected]`

Recursively convert text on the inside.

Parameters:

string	$text	Text to be converted
string	$variant	The target variant code
int	$startPos
int	$depth	Depth of recursion

Exceptions:

MWException

Returns:: string Converted text

Definition at line 668 of file LanguageConverter.php.

LanguageConverter::recursiveConvertTopLevel	(	$	text,
		$	variant,
		$	depth = `0`
	)		`[protected]`

Recursively convert text on the outside.

Allow to use nested markups to custom rules.

Parameters:

string	$text	Text to be converted
string	$variant	The target variant code
int	$depth	Depth of recursion

Returns:: string Converted text

Definition at line 626 of file LanguageConverter.php.

LanguageConverter::reloadTables ( )

Reload the conversion tables.

Access:: private

Definition at line 897 of file LanguageConverter.php.

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

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

Definition at line 461 of file LanguageConverter.php.

LanguageConverter::validateVariant ( $ variant = null )

Validate the variant.

Parameters:

string $variant The variant to validate

Returns:: mixed Returns the variant if it is valid, null otherwise

Definition at line 211 of file LanguageConverter.php.

Member Data Documentation

LanguageConverter::$languagesWithVariants [static]

Initial value:

 array(
        'gan',
        'iu',
        'kk',
        'ku',
        'shi',
        'sr',
        'tg',
        'uz',
        'zh',
    )

Definition at line 37 of file LanguageConverter.php.

Referenced by ListVariants\execute(), and Preferences\profilePreferences().

string LanguageConverter::$mCacheKey

Memcached key name.

Definition at line 58 of file LanguageConverter.php.

LanguageConverter::$mConvRuleTitle = false

Definition at line 64 of file LanguageConverter.php.

LanguageConverter::$mDescCodeSep = ':'

Definition at line 62 of file LanguageConverter.php.

LanguageConverter::$mDescVarSep = ';'

Definition at line 62 of file LanguageConverter.php.

LanguageConverter::$mFlags

Definition at line 61 of file LanguageConverter.php.

LanguageConverter::$mHeaderVariant

Definition at line 67 of file LanguageConverter.php.

LanguageConverter::$mLangObj

Definition at line 60 of file LanguageConverter.php.

LanguageConverter::$mMainLanguageCode

Definition at line 49 of file LanguageConverter.php.

LanguageConverter::$mManualLevel

Definition at line 54 of file LanguageConverter.php.

LanguageConverter::$mMaxDepth = 10

Definition at line 68 of file LanguageConverter.php.

LanguageConverter::$mTables

Definition at line 52 of file LanguageConverter.php.

LanguageConverter::$mTablesLoaded = false

Definition at line 51 of file LanguageConverter.php.

LanguageConverter::$mUcfirst = false

Definition at line 63 of file LanguageConverter.php.

LanguageConverter::$mURLVariant

Definition at line 65 of file LanguageConverter.php.

LanguageConverter::$mUserVariant

Definition at line 66 of file LanguageConverter.php.

LanguageConverter::$mVariantFallbacks

Definition at line 50 of file LanguageConverter.php.

LanguageConverter::$mVariantNames

Definition at line 50 of file LanguageConverter.php.

LanguageConverter::$mVariants

Definition at line 50 of file LanguageConverter.php.

LanguageConverter::$mVarSeparatorPattern

Definition at line 69 of file LanguageConverter.php.

const LanguageConverter::CACHE_VERSION_KEY = 'VERSION 7'

Definition at line 71 of file LanguageConverter.php.

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

languages/LanguageConverter.php

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation