ConverterRule Class Reference

Parser for rules of language conversion , parse rules in -{ }- tag. More...

List of all members.

Public Member Functions
	__construct ($text, $converter)
	Constructor.
	generateConvTable ()
	Generate conversion table for all text.
	getConvTable ()
	Get conversion table.
	getDisplay ()
	Get display text on markup -{...}-.
	getFlags ()
	Get conversion flags.
	getRuleConvertedTitle ($variant)
	Similar to getRuleConvertedStr(), but this prefers to use original page title if $variant === $this->mConverter->mMainLanguageCode and may return false in this case (so this title conversion rule will be ignored and the original title is shown).
	getRules ()
	Get conversion rules string.
	getRulesAction ()
	Return how deal with conversion rules.
	getTextInBidtable ($variants)
	Check if variants array in convert array.
	getTitle ()
	Get converted title.
	hasRules ()
	parse ($variant=null)
	Parse rules and flags.
Public Attributes
	$mBidtable = array()
	$mConverter
	$mConvTable = array()
	$mFlags = array()
	$mRuleDisplay = ''
	$mRules = ''
	$mRulesAction = 'none'
	$mRuleTitle = false
	$mText
	$mUnidtable = array()
	$mVariantFlags = array()
Private Member Functions
	getRuleConvertedStr ($variant)
	Parse rules conversion.
	getRulesDesc ()
	parseFlags ()
	Parse flags with syntax -{FLAG| ...
	parseRules ()
	Generate conversion table.

---

Detailed Description

Parser for rules of language conversion , parse rules in -{ }- tag.

Author:

fdcn <[email protected]>, PhiLiP <[email protected]>

Definition at line 1149 of file LanguageConverter.php.

---

Constructor & Destructor Documentation

ConverterRule::__construct	(	$	text,
		$	converter
	)

Constructor.

Parameters:

$text	String: the text between -{ and }-
$converter	LanguageConverter object

Definition at line 1168 of file LanguageConverter.php.

---

Member Function Documentation

ConverterRule::generateConvTable

(

)

Generate conversion table for all text.

Access:

private

Definition at line 1405 of file LanguageConverter.php.

ConverterRule::getConvTable

(

)

Get conversion table.

(bidirectional and unidirectional conversion table)

Returns:

array

Definition at line 1605 of file LanguageConverter.php.

ConverterRule::getDisplay

(

)

Get display text on markup -{...}-.

Returns:

string

Definition at line 1580 of file LanguageConverter.php.

ConverterRule::getFlags

(

)

Get conversion flags.

Returns:

array

Definition at line 1621 of file LanguageConverter.php.

ConverterRule::getRuleConvertedStr

(

$

variant

)

[private]

Parse rules conversion.

Parameters:

$variant

Returns:

string

Definition at line 1335 of file LanguageConverter.php.

ConverterRule::getRuleConvertedTitle

(

$

variant

)

Similar to getRuleConvertedStr(), but this prefers to use original page title if $variant === $this->mConverter->mMainLanguageCode and may return false in this case (so this title conversion rule will be ignored and the original title is shown).

Since:

1.22

Parameters:

$variant

The variant code to display page title in

Returns:

String|false The converted title or false if just page name

Definition at line 1380 of file LanguageConverter.php.

ConverterRule::getRules

(

)

Get conversion rules string.

Returns:

string

Definition at line 1613 of file LanguageConverter.php.

ConverterRule::getRulesAction

(

)

Return how deal with conversion rules.

Returns:

string

Definition at line 1596 of file LanguageConverter.php.

ConverterRule::getRulesDesc

(

)

[private]

Returns:

string

Definition at line 1311 of file LanguageConverter.php.

ConverterRule::getTextInBidtable

(

$

variants

)

Check if variants array in convert array.

Parameters:

$variants

Array or string: variant language code

Returns:

String: translated text

Definition at line 1179 of file LanguageConverter.php.

ConverterRule::getTitle

(

)

Get converted title.

Returns:

string

Definition at line 1588 of file LanguageConverter.php.

ConverterRule::hasRules

(

)

Todo:

FIXME: code this function :)

Definition at line 1572 of file LanguageConverter.php.

ConverterRule::parse

(

$

variant = null

)

Parse rules and flags.

Parameters:

$variant

String: variant language code

Definition at line 1463 of file LanguageConverter.php.

ConverterRule::parseFlags

(

)

[private]

Parse flags with syntax -{FLAG| ...

}-

Definition at line 1196 of file LanguageConverter.php.

ConverterRule::parseRules

(

)

[private]

Generate conversion table.

Definition at line 1259 of file LanguageConverter.php.

---

Member Data Documentation

ConverterRule::$mBidtable = array()

Definition at line 1159 of file LanguageConverter.php.

ConverterRule::$mConverter

Definition at line 1151 of file LanguageConverter.php.

ConverterRule::$mConvTable = array()

Definition at line 1158 of file LanguageConverter.php.

ConverterRule::$mFlags = array()

Definition at line 1156 of file LanguageConverter.php.

ConverterRule::$mRuleDisplay = ''

Definition at line 1152 of file LanguageConverter.php.

ConverterRule::$mRules = ''

Definition at line 1154 of file LanguageConverter.php.

ConverterRule::$mRulesAction = 'none'

Definition at line 1155 of file LanguageConverter.php.

ConverterRule::$mRuleTitle = false

Definition at line 1153 of file LanguageConverter.php.

ConverterRule::$mText

Definition at line 1150 of file LanguageConverter.php.

ConverterRule::$mUnidtable = array()

Definition at line 1160 of file LanguageConverter.php.

ConverterRule::$mVariantFlags = array()

Definition at line 1157 of file LanguageConverter.php.

---

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

• languages/LanguageConverter.php