Extension:StringFunctionsEscaped

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manual - list
Crystal Clear action run.png
StringFunctionsEscaped

Release status: stable

Implementation Parser function
Description Defines a superset of string parser functions that allow character escaping in the 'search for' and 'replace with' arguments.
Author(s) Jack D. Pond (jpondtalk)
Latest version 1.0.1 (2010-06-07)
MediaWiki Tested with 1.14,1.15,1.16A, Should work with all
License GNU Version 2
Download
README
Example examples
Parameters

$wgPFEnableStringFunctions

Hooks used
LanguageGetMagic

Translate the StringFunctionsEscaped extension if possible

Check usage and version matrix; code metrics
Bugs: list open list all report


What can this extension do?[edit | edit source]

Wikitext allows the imbedding of certain control characters (newline, tab, etc.). These parser functions allows the developer to find and manipulate standard c-type escape character sequence (\n,\t, etc.) within wikitext.

These parser functions can be used to make infoblox-type templates and/or forms much more WYSIWIG (see examples) for novice/non-technical users.

Usage[edit | edit source]

All parser functions are invoked exactly as their string parser functions would be (except with the '_e' appended). They can be used exactly as their counterparts are, even if there are no embedded special characters.

pos_e: (string position)[edit | edit source]

{{#pos_e:value|key|offset}}

Returns the first position of key inside the given value, or an empty string. If offset is defined, this method will not search the first offset characters.

See: http://php.net/manual/function.strpos.php

rpos_e: (string position, reverse)[edit | edit source]

{{#rpos_e:value|key}}

Returns the last position of key inside the given value, or -1 if the key is not found. When using this to search for the last delimiter, add +1 to the result to retreive position after the last delimiter. This also works when the delimiter is not found, because "-1 + 1" is zero, which is the beginning of the given value.

See: http://php.net/manual/function.strrpos.php

pad_e: (pad string)[edit | edit source]

{{#pad_e:value|length|with|direction}}

Returns the value padded to the certain length with the given with string. If the with string is not given, spaces are used for padding. The direction may be specified as: 'left', 'center' or 'right'.

See: http://php.net/manual/function.str-pad.php

replace_e: (string replace)[edit | edit source]

{{#replace_e:value|from|to}}

Returns the given value with all occurences of 'from' replaced with 'to'.

See: http://php.net/manual/function.str-replace.php

explode_e: (explode string)[edit | edit source]

{{#explode_e:value|delimiter|position}}

Splits the given value into pieces by the given delimiter and returns the position-th piece. Empty string is returned if there are not enough pieces.

Note: Pieces are counted from 0.
Note: A negative value can be used to count pieces from the end, instead of counting from the beginning. The last piece is at position -1.

See: http://php.net/manual/function.explode.php

stripnewlines: (remove multiple newlines)[edit | edit source]

{{#stripnewlines:value}}

Any time there is more than one newline in "value", they are changed to a single newline. This is useful for creating templates with complex but readable wiki text that wont impact on the layout of the calling page.

Download instructions[edit | edit source]

Download the extension from SVN and place it in $IP/extensions/StringFunctionsEscaped/StringFunctionsEscaped.php. Note: $IP stands for the root directory of your MediaWiki installation, the same directory that holds LocalSettings.php.

Installation[edit | edit source]

String functions were integrated into Extension:ParserFunctions extension as of r50997. This revision of Extension:ParserFunctions is designed for MediaWiki 1.16, but updating to the trunk version may work on previous versions. If you are using a prior version of Extension:ParserFunctions, you will also have to include Extension:StringFunctions.

Install and test Extension:ParserFunctions and (if necessary) Extension:StringFunctions prior to installing this extension.

This extension must be included AFTER the invocation of the string parser functions. To install this extension, add the following to LocalSettings.php:

For MediaWiki 1.15.1 and before[edit | edit source]

require_once("$IP/extensions/ParserFunctions/ParserFunctions.php");
require_once("$IP/extensions/StringFunctions/StringFunctions.php");
require_once("$IP/extensions/StringFunctionsEscaped/StringFunctionsEscaped.php");

For MediaWiki 1.16a and after[edit | edit source]

require_once("$IP/extensions/ParserFunctions/ParserFunctions.php");
$wgPFEnableStringFunctions = true;  // Note: this must be after ParserFunctions and before StringFunctionsEscaped
require_once("$IP/extensions/StringFunctionsEscaped/StringFunctionsEscaped.php");

Examples[edit | edit source]

pos_e[edit | edit source]

{{#pos_e:Line 1
Line 2
Line 3|\n|7}}

Returns:

13

rpos_e[edit | edit source]

{{#rpos_e:Line 1
Line 2
Line 3|\n}}

Returns:

13

pad_e[edit | edit source]

~~{{#pad_e:xox|9|\n|center}}~~

Returns:

~~ 


xox 


~~ 

replace_e[edit | edit source]

{{#replace_e:Line 1
Line 2
Line 3|\n|<br>\n}}

Returns:

Line 1<br>
Line 2<br>
Line 3

Which would display as:

Line 1
Line 2
Line 3

Rather than the unescaped:

Line 1 Line 2 Line 3

explode_e[edit | edit source]

{{#explode_e:Line 1
Line 2
Line 3|\n|1}}

Returns:

Line 2

stripnewlines[edit | edit source]

{{#stripnewlines:Line 1

Line 2


Line 3}}

Returns:

Line 1
Line 2 
Line 3

Printed version:

Line 1 Line 2 Line 3

See also[edit | edit source]

Language: English  • 日本語