MediaWiki  master
MagicWordArray Class Reference

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

Collaboration diagram for MagicWordArray:

Public Member Functions

 __construct ( $names=[], MagicWordFactory $factory=null)
 
 add ( $name)
 Add a magic word by name. More...
 
 addArray ( $names)
 Add a number of magic words by name. More...
 
 getBaseRegex ()
 Get the base regex. More...
 
 getHash ()
 Get a 2-d hashtable for this array. More...
 
 getNames ()
 
 getRegex ()
 Get an unanchored regex that does not match parameters. More...
 
 getRegexStart ()
 Get a regex anchored to the start of the string that does not match parameters. More...
 
 getVariableRegex ()
 Get a regex for matching variables with parameters. More...
 
 getVariableStartToEndRegex ()
 Get an anchored regex for matching variables with parameters. More...
 
 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) More...
 
 matchStartAndRemove (&$text)
 Return the ID of the magic word at the start of $text, and remove the prefix from $text. More...
 
 matchStartToEnd ( $text)
 Match some text, without parameter capture Returns the magic word name, or false if there was no capture. More...
 
 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. More...
 
 parseMatch ( $m)
 Parse a match array from preg_match Returns array(magic word ID, parameter value) If there is no parameter value, that element will be false. More...
 

Public Attributes

string [] $names = []
 

Private Attributes

 $baseRegex
 
MagicWordFactory $factory
 
array $hash
 
 $regex
 

Detailed Description

Class for handling an array of magic words.

Definition at line 32 of file MagicWordArray.php.

Constructor & Destructor Documentation

◆ __construct()

MagicWordArray::__construct (   $names = [],
MagicWordFactory  $factory = null 
)
Parameters
string[]$names
MagicWordFactory | null$factory

Definition at line 50 of file MagicWordArray.php.

References $names, and names.

Member Function Documentation

◆ add()

MagicWordArray::add (   $name)

Add a magic word by name.

Parameters
string$name

Definition at line 60 of file MagicWordArray.php.

References $name, names, and null.

◆ addArray()

MagicWordArray::addArray (   $names)

Add a number of magic words by name.

Parameters
string[]$names

Definition at line 70 of file MagicWordArray.php.

References names, and null.

◆ getBaseRegex()

MagicWordArray::getBaseRegex ( )

Get the base regex.

Returns
string[]

Definition at line 100 of file MagicWordArray.php.

References $baseRegex, $name, as, and names.

Referenced by getRegex(), getRegexStart(), and getVariableStartToEndRegex().

◆ getHash()

MagicWordArray::getHash ( )

Get a 2-d hashtable for this array.

Returns
array

Definition at line 79 of file MagicWordArray.php.

References $hash, $name, as, and names.

Referenced by matchStartToEnd().

◆ getNames()

MagicWordArray::getNames ( )
Since
1.20
Returns
string[]

Definition at line 195 of file MagicWordArray.php.

References $names.

◆ getRegex()

MagicWordArray::getRegex ( )

Get an unanchored regex that does not match parameters.

Returns
string[]

Definition at line 134 of file MagicWordArray.php.

References $base, $regex, and getBaseRegex().

Referenced by getVariableRegex(), and matchAndRemove().

◆ getRegexStart()

MagicWordArray::getRegexStart ( )

Get a regex anchored to the start of the string that does not match parameters.

Returns
string[]

Definition at line 162 of file MagicWordArray.php.

References $base, and getBaseRegex().

Referenced by matchStartAndRemove().

◆ getVariableRegex()

MagicWordArray::getVariableRegex ( )

Get a regex for matching variables with parameters.

Returns
string[]

Definition at line 153 of file MagicWordArray.php.

References getRegex().

◆ getVariableStartToEndRegex()

MagicWordArray::getVariableStartToEndRegex ( )

Get an anchored regex for matching variables with parameters.

Returns
string[]

Definition at line 179 of file MagicWordArray.php.

References $base, and getBaseRegex().

Referenced by matchVariableStartToEnd().

◆ matchAndRemove()

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 279 of file MagicWordArray.php.

References $matches, $name, $regex, $res, as, getRegex(), list, null, and parseMatch().

◆ matchStartAndRemove()

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 323 of file MagicWordArray.php.

References $regex, as, getRegexStart(), list, and parseMatch().

◆ matchStartToEnd()

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|bool False on failure

Definition at line 262 of file MagicWordArray.php.

References getHash().

◆ matchVariableStartToEnd()

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 241 of file MagicWordArray.php.

References $regex, as, false, getVariableStartToEndRegex(), and parseMatch().

◆ parseMatch()

MagicWordArray::parseMatch (   $m)

Parse a match array from preg_match Returns array(magic word ID, parameter value) If there is no parameter value, that element will be false.

Parameters
array$m
Exceptions
MWException
Returns
array

Definition at line 209 of file MagicWordArray.php.

References $value, key, list, and null.

Referenced by matchAndRemove(), matchStartAndRemove(), and matchVariableStartToEnd().

Member Data Documentation

◆ $baseRegex

MagicWordArray::$baseRegex
private

Definition at line 42 of file MagicWordArray.php.

Referenced by getBaseRegex().

◆ $factory

MagicWordFactory MagicWordArray::$factory
private

Definition at line 37 of file MagicWordArray.php.

◆ $hash

array MagicWordArray::$hash
private

Definition at line 40 of file MagicWordArray.php.

Referenced by getHash().

◆ $names

string [] MagicWordArray::$names = []

Definition at line 34 of file MagicWordArray.php.

Referenced by __construct(), and getNames().

◆ $regex

MagicWordArray::$regex
private

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