- Generated on Mon Feb 20 2017 09:20:16 for MediaWiki by
1.8.8
|
MediaWiki
1.28.0
|
Class for handling an array of magic words. More...
Public Member Functions | |
| __construct ($names=[]) | |
| 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 | |
| array | $names = [] |
Private Attributes | |
| $baseRegex | |
| array | $hash |
| $regex | |
Class for handling an array of magic words.
Definition at line 31 of file MagicWordArray.php.
| MagicWordArray::__construct | ( | $names = [] | ) |
| array | $names |
Definition at line 45 of file MagicWordArray.php.
| MagicWordArray::add | ( | $name | ) |
| MagicWordArray::addArray | ( | $names | ) |
Add a number of magic words by name.
| array | $names |
Definition at line 64 of file MagicWordArray.php.
References names.
| MagicWordArray::getBaseRegex | ( | ) |
Get the base regex.
Definition at line 95 of file MagicWordArray.php.
References $baseRegex, $name, as, MagicWord\get(), and names.
Referenced by getRegex(), getRegexStart(), and getVariableStartToEndRegex().
| MagicWordArray::getHash | ( | ) |
Get a 2-d hashtable for this array.
Definition at line 73 of file MagicWordArray.php.
References $hash, $name, $wgContLang, as, MagicWord\get(), global, and names.
Referenced by matchStartToEnd().
| MagicWordArray::getNames | ( | ) |
| MagicWordArray::getRegex | ( | ) |
Get an unanchored regex that does not match parameters.
Definition at line 120 of file MagicWordArray.php.
References $base, $regex, and getBaseRegex().
Referenced by getVariableRegex(), and matchAndRemove().
| MagicWordArray::getRegexStart | ( | ) |
Get a regex anchored to the start of the string that does not match parameters.
Definition at line 148 of file MagicWordArray.php.
References $base, and getBaseRegex().
Referenced by matchStartAndRemove().
| MagicWordArray::getVariableRegex | ( | ) |
Get a regex for matching variables with parameters.
Definition at line 139 of file MagicWordArray.php.
References getRegex().
| MagicWordArray::getVariableStartToEndRegex | ( | ) |
Get an anchored regex for matching variables with parameters.
Definition at line 165 of file MagicWordArray.php.
References $base, and getBaseRegex().
Referenced by matchVariableStartToEnd().
| 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)
| string | $text |
Definition at line 267 of file MagicWordArray.php.
References $matches, $name, $regex, $res, as, getRegex(), list, and parseMatch().
| 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.
| string | $text |
Definition at line 311 of file MagicWordArray.php.
References $regex, as, getRegexStart(), list, and parseMatch().
| MagicWordArray::matchStartToEnd | ( | $text | ) |
Match some text, without parameter capture Returns the magic word name, or false if there was no capture.
| string | $text |
Definition at line 246 of file MagicWordArray.php.
References $wgContLang, getHash(), and global.
| 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.
| string | $text |
Definition at line 225 of file MagicWordArray.php.
References $regex, as, false, getVariableStartToEndRegex(), and 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.
| array | $m |
| MWException |
Definition at line 195 of file MagicWordArray.php.
Referenced by matchAndRemove(), matchStartAndRemove(), and matchVariableStartToEnd().
|
private |
Definition at line 38 of file MagicWordArray.php.
Referenced by getBaseRegex().
|
private |
Definition at line 36 of file MagicWordArray.php.
Referenced by getHash().
| array MagicWordArray::$names = [] |
Definition at line 33 of file MagicWordArray.php.
Referenced by __construct(), and getNames().
|
private |
Definition at line 40 of file MagicWordArray.php.
Referenced by getRegex(), matchAndRemove(), matchStartAndRemove(), and matchVariableStartToEnd().
1.8.8