Extension:RegexFunctions

From MediaWiki.org

Manual on MediaWiki Extensions
List of MediaWiki Extensions

RegexFunctions Release status: stable
Implementation	Parser function
Description	Regular expression based parser functions
Author(s)	Ryan Schmidt (SkizzerzTalk)
Last Version	1.2
MediaWiki	1.7+
License	None (Public Domain)
Download	Download snapshot Subversion [Help] Browse source code Usage Changelog
Parameters $wgRegexFunctionsPerPage, $wgRegexFunctionsAllowModifiers, $wgRegexFunctionsAllowE, $wgRegexFunctionsAllowOptions, $wgRegexFunctionsLimit, $wgRegexFunctionsDisable
Hooks used LanguageGetMagic

[edit] Usage

As of now, this extension defines three parser functions, rmatch, rsplit, and rreplace

rmatch

{{#rmatch:string|pattern|return|notfound|offset}}

string (required): The text the function uses for the matching.

pattern (required): The regular expression to use on the text.

return (required): What to return if the match was successful. $# and \# contain the captured text, and $$# and \\# contain the offsets of that text. Use ${#}# or \{#}# if you want a group followed by another number.

notfound (optional): What to return if the match was not successful. Defaults to an empty string.

offset (optional): The offset in bytes to start the match at. Defaults to 0 (the beginning of the text).

rsplit

{{#rsplit:string|pattern|piece}}

string (required): The text the function will split.

pattern (required): The regular expression to use on the text. No text is captured.

piece (optional): The piece to return. Defaults to 0 (the first piece).

rreplace

{{#rreplace:string|pattern|replace}}

string (required): The text the function will replace.

pattern (required): The regular expression to use on the text.

replace (required): The text to replace the matched text with. Both $# and \# will call the capturing groups, use ${#}# or \{#}# if you want a group followed by another number.

[edit] Pattern help

For help on constructing the syntax, please read [1] for general help and [2] for an overview of the modifiers.

[edit] Installation

Please download the files from Subversion and place it in $IP/extensions/RegexFunctions/RegexFunctions.php. Note: $IP stands for the root directory of your MediaWiki installation, the same directory that holds LocalSettings.php. Then, add the following to the bottom of LocalSettings.php:

require_once("$IP/extensions/RegexFunctions/RegexFunctions.php");

[edit] Configuration parameters

$wgRegexFunctionsPerPage

How many functions are allowed per page. Default is 10, but it is recommended that it is set above 3 for usability

$wgRegexFunctionsAllowModifiers

Allows modifiers (e.g./i for case insensitivity). Does not enable the /e modifier in the rreplace function, see the next variable for that. Defaults to true.

$wgRegexFunctionsAllowE

Allows the /e modifier in rreplace, which treats the 'replace' text as PHP code. Don't enable this unless you trust all of your users, as it opens up XSS vectors and other security concerns. Defaults to false.

$wgRegexFunctionsAllowOptions

Allows internal options (e.g. (?U) for ungreedy) inside of the regex itself. Defaults to true.

$wgRegexFunctionsLimit

Limit for the number of pieces in the rsplit function and replaces in the rreplace function. -1 is unlimited. Defaults to -1.

$wgRegexFunctionsDisable

Array of functions you want to disable. Defaults to an empty array.

[edit] Changelog

Version 1.2

Pattern goes through a sanitation process before being passed onto one of the preg_* functions.

Version 1.1

Localization updates

Version 1.0

Initial Release, defines three functions: rmatch, rsplit, and rreplace