Class: Text_Wiki_Rule_break

Source Location: /Text_Wiki-0.16/Text/Wiki/Rule/break.php

Class Overview

Text_Wiki_Rule
   |
   --Text_Wiki_Rule_break

This class implements a Text_Wiki_Rule to mark forced line breaks in the source text.

Author(s):

Paul M. Jones <pmjones at ciaweb.net>

Inherited Variables

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::renderPlain(): Abstract method to render plain text, no markup at all.
Text_Wiki_Rule::renderXhtml(): Abstract method to render XHTML.
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 mark forced line breaks in the source text.

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

[ Top ]

Class Variables

$regex = '/ _\n/'

[line 49]

The regular expression used to parse the source text and find matches conforming to this rule. Used by the parse() method.

See: Text_Wiki_Rule::parse()
Access: public

Type:	string
Overrides:	Array

[ Top ]

Method Detail

process [line 65]

string process(
array
&$matches)

Generates a replacement token for the matched text.

Return: A delimited token 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 ]

renderPlain [line 103]

string renderPlain(
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::renderPlain() (Abstract method to render plain text, no markup at all.)

Parameters:

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

[ Top ]

renderXhtml [line 84]

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() (Abstract method to render XHTML.)

Parameters:

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

[ Top ]