MediaWiki\Parser\MagicWordArray Class Reference

Class for handling an array of magic words. More...

Public Member Functions
	__construct ( $names=[], MagicWordFactory $factory=null)
	add ( $name)
	Add a magic word by name.
	getBaseRegex (bool $capture=true, string $delimiter='/')
	Get the base regex.
	getHash ()
	Get a 2-d hashtable for this array.
	getNames ()
	matchAndRemove (&$text)
	Returns an associative array, ID => param value, for all items that match Removes the matched items from the input string (passed by reference)
	matchStartAndRemove (&$text)
	Return the ID of the magic word at the start of $text, and remove the prefix from $text.
	matchStartToEnd ( $text)
	Match some text, without parameter capture Returns the magic word name, or false if there was no capture.
	matchVariableStartToEnd ( $text)
	Match some text, with parameter capture Returns an array with the magic word name in the first element and the parameter in the second element.

Public Attributes
string[]	$names = []

Detailed Description

Class for handling an array of magic words.

Definition at line 36 of file MagicWordArray.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\Parser\MagicWordArray::__construct	(		$names = [],
		MagicWordFactory	$factory = null )

Parameters

string[]	$names
MagicWordFactory | null	$factory

Definition at line 56 of file MagicWordArray.php.

References MediaWiki\Parser\MagicWordArray\$names, and MediaWiki\MediaWikiServices\getInstance().

Member Function Documentation

add()

MediaWiki\Parser\MagicWordArray::add

(

$name

)

Add a magic word by name.

Parameters

string

$name

Definition at line 66 of file MagicWordArray.php.

getBaseRegex()

MediaWiki\Parser\MagicWordArray::getBaseRegex	(	bool	$capture = true,
		string	$delimiter = '/' )

Get the base regex.

Parameters

bool	$capture	Set to false to suppress the capture groups, which can cause unexpected conflicts when this regexp is embedded in other regexps with similar constructs.
string	$delimiter	The delimiter which will be used for the eventual regexp.

Returns

string[]

Access: internal

Definition at line 102 of file MagicWordArray.php.

getHash()

MediaWiki\Parser\MagicWordArray::getHash

(

)

Get a 2-d hashtable for this array.

Returns

array

Definition at line 75 of file MagicWordArray.php.

getNames()

MediaWiki\Parser\MagicWordArray::getNames

(

)

Since

1.20

Returns

string[]

Definition at line 201 of file MagicWordArray.php.

matchAndRemove()

MediaWiki\Parser\MagicWordArray::matchAndRemove

(

&

$text

)

Returns an associative array, ID => param value, for all items that match Removes the matched items from the input string (passed by reference)

Parameters

string

&$text

Returns

array

Definition at line 283 of file MagicWordArray.php.

References $matches.

matchStartAndRemove()

MediaWiki\Parser\MagicWordArray::matchStartAndRemove

(

&

$text

)

Return the ID of the magic word at the start of $text, and remove the prefix from $text.

Return false if no match found and $text is not modified. Does not match parameters.

Parameters

string

&$text

Returns

int|bool False on failure

Definition at line 338 of file MagicWordArray.php.

matchStartToEnd()

MediaWiki\Parser\MagicWordArray::matchStartToEnd

(

$text

)

Match some text, without parameter capture Returns the magic word name, or false if there was no capture.

Parameters

string

$text

Returns

string|false False on failure

Definition at line 266 of file MagicWordArray.php.

matchVariableStartToEnd()

MediaWiki\Parser\MagicWordArray::matchVariableStartToEnd

(

$text

)

Match some text, with parameter capture Returns an array with the magic word name in the first element and the parameter in the second element.

Both elements are false if there was no match.

Parameters

string

$text

Returns

array

Definition at line 247 of file MagicWordArray.php.

Member Data Documentation

$names

string [] MediaWiki\Parser\MagicWordArray::$names = []

Definition at line 38 of file MagicWordArray.php.

Referenced by MediaWiki\Parser\MagicWordArray\__construct().

---

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

• includes/parser/MagicWordArray.php