Class: Text_Wiki_Rule_delimiter

Source Location: /Text_Wiki-0.12.1/Text/Wiki/Rule/delimiter.php

Class Overview

Text_Wiki_Rule
   |
   --Text_Wiki_Rule_delimiter

This class implements a Text_Wiki_Rule to find instances of the delimiter character already embedded in the source text; it extracts them and replaces them with a delimited token, then renders them as the delimiter itself when the target format is XHTML.

Author(s):

Paul M. Jones <pmjones at ciaweb.net>

Methods

Inherited Variables

Class: Text_Wiki_Rule

Text_Wiki_Rule::$regex
Text_Wiki_Rule::$_wiki

Inherited Methods

Class: Text_Wiki_Rule

Text_Wiki_Rule::Text_Wiki_Rule(): Constructor for the rule.
Text_Wiki_Rule::addToken(): Add a token to the Text_Wiki tokens array, and return a delimited token number.
Text_Wiki_Rule::getMacroArgs(): Simple method to extract 'option="value"' portions of wiki markup, typically used only in macros.
Text_Wiki_Rule::parse(): Simple parsing method to apply the rule's regular expression to the source text, pass every match to the process() method, and replace the matched text with the results of the processing.
Text_Wiki_Rule::process(): Simple processing mathod to take matched text and generate replacement text. This is one of the methods you will definitely want to override in your rule class extensions.
Text_Wiki_Rule::renderXhtml(): Simple rendering method to take a set of token options and generate replacement text for it. This is another method you will definitely want to override in your rule subclass extensions.
Text_Wiki_Rule::setToken(): Set or re-set a token with specific information, overwriting any previous rule name and rule options.

Class Details

[line 35]
This class implements a Text_Wiki_Rule to find instances of the delimiter character already embedded in the source text; it extracts them and replaces them with a delimited token, then renders them as the delimiter itself when the target format is XHTML.

Author: Paul M. Jones <pmjones@ciaweb.net>

[ Top ]

Method Detail

Text_Wiki_Rule_delimiter (Constructor) [line 49]

Text_Wiki_Rule_delimiter Text_Wiki_Rule_delimiter(
object
&$obj, string
$name)

Constructor. Overrides the Text_Wiki_Rule constructor so that we can set the $regex property dynamically (we need to include the Text_Wiki $delim character.

Parameters:

object	`&$obj`	—	The calling "parent" Text_Wiki object.
string	`$name`	—	The token name to use for this rule.

[ Top ]

process [line 71]

A process(
array
&$matches)

Generates a token entry for the matched text. Token options are:

'text' => The full matched text.

Return: delimited token number to be used as a placeholder in the source text.
Access: public

Overrides Text_Wiki_Rule::process() (Simple processing mathod to take matched text and generate replacement text. This is one of the methods you will definitely want to override in your rule class extensions.)

Parameters:

array &$matches — The array of matches from parse().

[ Top ]

renderXhtml [line 90]

string renderXhtml(
array
$options)

Renders a token into text matching the requested format.

Return: The text rendered from the token options.
Access: public

Overrides Text_Wiki_Rule::renderXhtml() (Simple rendering method to take a set of token options and generate replacement text for it. This is another method you will definitely want to override in your rule subclass extensions.)

Parameters:

array $options — The "options" portion of the token (second element).

[ Top ]