$regex
$regex : string
Regular expression to find matching text for this rule.
Replaces the default Toc parser to search for Heading2 tokens instead.
This class implements a Text_Wiki_Parse to find all heading tokens and build a table of contents. The [[toc]] tag gets replaced with a list of all the level-2 through level-6 headings.
process(array $matches) : string
Generates a replacement for the matched text.
Token options are:
'type' => ['list_start'|'list_end'|'item_start'|'item_end'|'target']
'level' => The heading level (1-6).
'count' => Which entry number this is in the list.
| array | $matches | An array of matches from the parse() method as generated by preg_replace_callback. $matches[0] is the full matched string, $matches[1] is the first matched pattern, $matches[2] is the second matched pattern, and so on. |
A token indicating the TOC collection point.
getConf(string $key, mixed $default = null) : mixed
Simple method to safely get configuration key values.
| string | $key | The configuration key. |
| mixed | $default | If the key does not exist, return this value instead. |
The configuration key value (if it exists) or the default value (if not).
getAttrs(string $text) : array
Extract 'attribute="value"' portions of wiki markup.
This kind of markup is typically used only in macros, but is useful anywhere.
The syntax is pretty strict; there can be no spaces between the option name, the equals, and the first double-quote; the value must be surrounded by double-quotes. You can escape characters in the value with a backslash, and the backslash will be stripped for you.
| string | $text | The "attributes" portion of markup. |
An associative array of key-value pairs where the key is the option name and the value is the option value.