MediaWiki\Language\ConverterRule Class Reference

The rules used for language conversion, this processes the rules extracted by Parser from the -{ }- wikitext syntax. More...

Public Member Functions
	__construct (LanguageConverter $converter)
	getConvTable ()
	Get conversion table.
	getDisplay ()
	Get display text on markup -{...}-.
	getDisplayFragment (Document $ownerDocument)
	Get display text on markup -{...}- as a DocumentFragment.
	getFlags ()
	Get conversion flags.
	getFragmentInBidtable (Document $ownerDocument, $variants)
	Check if the variant array is in the convert array.
	getRules ()
	Get conversion rules string.
	getRulesAction ()
	Return how to deal with conversion rules.
	getTextInBidtable ( $variants)
	Check if the variant array is in the convert array.
	getTitle ()
	Get converted title.
	getTitleFragment (Document $ownerDocument)
	Get converted title as a DocumentFragment.
	getTitleValue ()
	hasRules ()
	Checks if there are conversion rules.
	parse (string $inner, ?string $variant=null)
	Parse rules and flags.
	parseElement (Element $el, ?string $variant=null)
	Parse rules and flags from MediaWiki DOM Spec.

Detailed Description

The rules used for language conversion, this processes the rules extracted by Parser from the -{ }- wikitext syntax.

Definition at line 28 of file ConverterRule.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\Language\ConverterRule::__construct

(

LanguageConverter

$converter

)

Parameters

LanguageConverter

$converter

Definition at line 60 of file ConverterRule.php.

Member Function Documentation

getConvTable()

MediaWiki\Language\ConverterRule::getConvTable

(

)

Get conversion table.

(bidirectional and unidirectional conversion table)

Returns

array

Definition at line 776 of file ConverterRule.php.

Referenced by MediaWiki\Language\LanguageConverter\applyManualConv().

getDisplay()

MediaWiki\Language\ConverterRule::getDisplay

(

)

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

Returns

string

Definition at line 693 of file ConverterRule.php.

References wfMessage().

getDisplayFragment()

MediaWiki\Language\ConverterRule::getDisplayFragment

(

Document

$ownerDocument

)

Get display text on markup -{...}- as a DocumentFragment.

Parameters

Document

$ownerDocument

An owner document for the returned fragment

Returns

DocumentFragment

Definition at line 710 of file ConverterRule.php.

getFlags()

MediaWiki\Language\ConverterRule::getFlags

(

)

Get conversion flags.

Returns

array

Definition at line 792 of file ConverterRule.php.

getFragmentInBidtable()

MediaWiki\Language\ConverterRule::getFragmentInBidtable	(	Document	$ownerDocument,
			$variants )

Check if the variant array is in the convert array.

Parameters

Document	$ownerDocument	An owner document for the returned fragment
array | string	$variants	Variant language code

Returns

?DocumentFragment Translated text

Definition at line 96 of file ConverterRule.php.

getRules()

MediaWiki\Language\ConverterRule::getRules

(

)

Get conversion rules string.

Returns

string

Definition at line 784 of file ConverterRule.php.

getRulesAction()

MediaWiki\Language\ConverterRule::getRulesAction

(

)

Return how to deal with conversion rules.

Returns

string

Definition at line 767 of file ConverterRule.php.

Referenced by MediaWiki\Language\LanguageConverter\applyManualConv().

getTextInBidtable()

MediaWiki\Language\ConverterRule::getTextInBidtable

(

$variants

)

Check if the variant array is in the convert array.

Parameters

array | string

$variants

Variant language code

Returns

string|false Translated text

Definition at line 80 of file ConverterRule.php.

getTitle()

MediaWiki\Language\ConverterRule::getTitle

(

)

Get converted title.

Returns

string|false

Definition at line 735 of file ConverterRule.php.

getTitleFragment()

MediaWiki\Language\ConverterRule::getTitleFragment

(

Document

$ownerDocument

)

Get converted title as a DocumentFragment.

Parameters

Document

$ownerDocument

An owner document for the returned fragment

Returns

?DocumentFragment

Definition at line 748 of file ConverterRule.php.

getTitleValue()

MediaWiki\Language\ConverterRule::getTitleValue

(

)

Access: internal

Definition at line 759 of file ConverterRule.php.

Referenced by MediaWiki\Language\LanguageConverter\applyManualConv().

hasRules()

MediaWiki\Language\ConverterRule::hasRules

(

)

Checks if there are conversion rules.

Returns

bool

Definition at line 685 of file ConverterRule.php.

parse()

MediaWiki\Language\ConverterRule::parse	(	string	$inner,
		?string	$variant = null )

Parse rules and flags.

Parameters

string	$inner	The contents of the rule between -{ and }-
string | null	$variant	Variant language code

Definition at line 457 of file ConverterRule.php.

parseElement()

MediaWiki\Language\ConverterRule::parseElement	(	Element	$el,
		?string	$variant = null )

Parse rules and flags from MediaWiki DOM Spec.

Parameters

Element	$el	Language converter rule (an Element with a valid data-mw-variant attribute).
?string	$variant	Variant language code

Returns

?string If non-null, the rule display should be converted to the returned variant.

Definition at line 570 of file ConverterRule.php.

---

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

• includes/Language/ConverterRule.php