Docs For Class Text_Wiki_Rule

Class: Text_Wiki_Rule_entities

Class Overview

Text_Wiki_Rule
   |
   --Text_Wiki_Rule_entities

This class implements a Text_Wiki_Rule to convert HTML entities in the source text.

Author(s):

Paul M. Jones <pmjones at ciaweb.net>

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 33]
This class implements a Text_Wiki_Rule to convert HTML entities in the source text.

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

Method Detail

parse [line 44]

void parse(
)

Simple parsing method to apply the rule.

Access: public

Overrides 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.)

[ Top ]