- Generated on Thu Jun 27 2024 14:05:32 for MediaWiki by
1.10.0
|
MediaWiki REL1_40
|
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. | |
| addArray ( $names) | |
| Add a number of magic words by name. | |
| getBaseRegex (bool $capture=true, string $delimiter='/') | |
| Get the base regex. | |
| getHash () | |
| Get a 2-d hashtable for this array. | |
| getNames () | |
| getRegex () | |
| Get an unanchored regex that does not match parameters. | |
| getRegexStart () | |
| Get a regex anchored to the start of the string that does not match parameters. | |
| getVariableRegex () | |
| Get a regex for matching variables with parameters. | |
| getVariableStartToEndRegex () | |
| Get an anchored regex for matching variables with parameters. | |
| 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. | |
| 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. | |
Public Attributes | |
| string[] | $names = [] |
Class for handling an array of magic words.
Definition at line 36 of file MagicWordArray.php.
| MediaWiki\Parser\MagicWordArray::__construct | ( | $names = [], | |
| MagicWordFactory | $factory = null ) |
| string[] | $names | |
| MagicWordFactory | null | $factory |
Definition at line 56 of file MagicWordArray.php.
References MediaWiki\Parser\MagicWordArray\$names, and MediaWiki\MediaWikiServices\getInstance().
| MediaWiki\Parser\MagicWordArray::add | ( | $name | ) |
| MediaWiki\Parser\MagicWordArray::addArray | ( | $names | ) |
Add a number of magic words by name.
| string[] | $names |
Definition at line 76 of file MagicWordArray.php.
References MediaWiki\Parser\MagicWordArray\$names.
| MediaWiki\Parser\MagicWordArray::getBaseRegex | ( | bool | $capture = true, |
| string | $delimiter = '/' ) |
Get the base regex.
| 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. |
Definition at line 112 of file MagicWordArray.php.
| MediaWiki\Parser\MagicWordArray::getHash | ( | ) |
| MediaWiki\Parser\MagicWordArray::getNames | ( | ) |
| MediaWiki\Parser\MagicWordArray::getRegex | ( | ) |
Get an unanchored regex that does not match parameters.
Definition at line 160 of file MagicWordArray.php.
References $base.
| MediaWiki\Parser\MagicWordArray::getRegexStart | ( | ) |
Get a regex anchored to the start of the string that does not match parameters.
Definition at line 192 of file MagicWordArray.php.
References $base.
| MediaWiki\Parser\MagicWordArray::getVariableRegex | ( | ) |
Get a regex for matching variables with parameters.
Definition at line 181 of file MagicWordArray.php.
References wfDeprecated().
| MediaWiki\Parser\MagicWordArray::getVariableStartToEndRegex | ( | ) |
Get an anchored regex for matching variables with parameters.
Definition at line 210 of file MagicWordArray.php.
References $base.
| 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)
| string | &$text |
Definition at line 308 of file MagicWordArray.php.
| 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.
| string | &$text |
Definition at line 363 of file MagicWordArray.php.
| MediaWiki\Parser\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 291 of file MagicWordArray.php.
| 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.
| string | $text |
Definition at line 272 of file MagicWordArray.php.
| MediaWiki\Parser\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 240 of file MagicWordArray.php.
| string [] MediaWiki\Parser\MagicWordArray::$names = [] |
Definition at line 38 of file MagicWordArray.php.
Referenced by MediaWiki\Parser\MagicWordArray\__construct(), and MediaWiki\Parser\MagicWordArray\addArray().
1.10.0