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.
	getRuleConvertedStr ($variant)
	Parse rules conversion.
	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.
	getRulesDesc ()
	getTextInBidtable ($variants)
	Check if variants array in convert array.
	getTitle ()
	Get converted title.
	hasRules ()
	parse ($variant=null)
	Parse rules and flags.
	parseFlags ()
	Parse flags with syntax -{FLAG| ...
	parseRules ()
	Generate conversion table.
Public Attributes
	$mBidtable = array()
	$mConverter
	$mConvTable = array()
	$mFlags = array()
	$mRuleDisplay = ''
	$mRules = ''
	$mRulesAction = 'none'
	$mRuleTitle = false
	$mText
	$mUnidtable = array()
	$mVariantFlags = array()

---

Detailed Description

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

Author:

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

Definition at line 27 of file ConverterRule.php.

---

Constructor & Destructor Documentation

ConverterRule::__construct	(	$	text,
		$	converter
	)

Constructor.

Parameters:

string	$text	The text between -{ and }-
LanguageConverter	$converter

Definition at line 46 of file ConverterRule.php.

---

Member Function Documentation

ConverterRule::generateConvTable

(

)

Generate conversion table for all text.

Access:

private

Definition at line 282 of file ConverterRule.php.

References array(), as, and getTextInBidtable().

Referenced by parse().

ConverterRule::getConvTable

(

)

Get conversion table.

(bidirectional and unidirectional conversion table)

Returns:

array

Definition at line 483 of file ConverterRule.php.

ConverterRule::getDisplay

(

)

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

Returns:

string

Definition at line 458 of file ConverterRule.php.

ConverterRule::getFlags

(

)

Get conversion flags.

Returns:

array

Definition at line 499 of file ConverterRule.php.

ConverterRule::getRuleConvertedStr

(

$

variant

)

Parse rules conversion.

Access:

private

Parameters:

string

$variant

Returns:

string

Definition at line 213 of file ConverterRule.php.

References getTextInBidtable().

Referenced by getRuleConvertedTitle(), and parse().

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:

string

$variant

The variant code to display page title in

Returns:

string|bool The converted title or false if just page name

Definition at line 257 of file ConverterRule.php.

References getRuleConvertedStr(), and getTextInBidtable().

Referenced by parse().

ConverterRule::getRules

(

)

Get conversion rules string.

Returns:

string

Definition at line 491 of file ConverterRule.php.

ConverterRule::getRulesAction

(

)

Return how deal with conversion rules.

Returns:

string

Definition at line 474 of file ConverterRule.php.

ConverterRule::getRulesDesc

(

)

Access:

private

Returns:

string

Definition at line 189 of file ConverterRule.php.

References $from, and as.

Referenced by parse().

ConverterRule::getTextInBidtable

(

$

variants

)

Check if variants array in convert array.

Parameters:

array | string

$variants

Variant language code

Returns:

string Translated text

Definition at line 57 of file ConverterRule.php.

References array(), and as.

Referenced by generateConvTable(), getRuleConvertedStr(), and getRuleConvertedTitle().

ConverterRule::getTitle

(

)

Get converted title.

Returns:

string

Definition at line 466 of file ConverterRule.php.

ConverterRule::hasRules

(

)

Todo:

FIXME: code this function :)

Definition at line 450 of file ConverterRule.php.

ConverterRule::parse

(

$

variant = null

)

Parse rules and flags.

Parameters:

string

$variant

Variant language code

Definition at line 340 of file ConverterRule.php.

References $flags, array(), as, generateConvTable(), getRuleConvertedStr(), getRuleConvertedTitle(), getRulesDesc(), parseFlags(), parseRules(), and wfMessage().

ConverterRule::parseFlags

(

)

Parse flags with syntax -{FLAG| ...

}-

Access:

private

Definition at line 74 of file ConverterRule.php.

References $f, $flags, array(), as, and StringUtils\explode().

Referenced by parse().

ConverterRule::parseRules

(

)

Generate conversion table.

Access:

private

Definition at line 137 of file ConverterRule.php.

References $from, array(), and as.

Referenced by parse().

---

Member Data Documentation

ConverterRule::$mBidtable = array()

Definition at line 37 of file ConverterRule.php.

ConverterRule::$mConverter

Definition at line 29 of file ConverterRule.php.

ConverterRule::$mConvTable = array()

Definition at line 36 of file ConverterRule.php.

ConverterRule::$mFlags = array()

Definition at line 34 of file ConverterRule.php.

ConverterRule::$mRuleDisplay = ''

Definition at line 30 of file ConverterRule.php.

ConverterRule::$mRules = ''

Definition at line 32 of file ConverterRule.php.

ConverterRule::$mRulesAction = 'none'

Definition at line 33 of file ConverterRule.php.

ConverterRule::$mRuleTitle = false

Definition at line 31 of file ConverterRule.php.

ConverterRule::$mText

Definition at line 28 of file ConverterRule.php.

ConverterRule::$mUnidtable = array()

Definition at line 38 of file ConverterRule.php.

ConverterRule::$mVariantFlags = array()

Definition at line 35 of file ConverterRule.php.

---

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

• languages/ConverterRule.php