Class: Text_Wiki_Rule_freelink

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

Class Overview

Text_Wiki_Rule
   |
   --Text_Wiki_Rule_freelink

This class implements a Text_Wiki_Rule to find source text marked as a wiki freelink, and automatically create a link to that page.

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 41]
This class implements a Text_Wiki_Rule to find source text marked as a wiki freelink, and automatically create a link to that page.

A freelink is any page name not conforming to the standard StudlyCapsStyle for a wiki page name. For example, a page normally named MyHomePage can be renamed and referred to as ((My Home Page)) -- note the spaces in the page name. You can also make a "nice-looking" link without renaming the target page; e.g., ((MyHomePage|My Home Page)). Finally, you can use named anchors on the target page: ((MyHomePage|My Home Page#Section1)).

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

[ Top ]

Method Detail

Text_Wiki_Rule_freelink (Constructor) [line 57]

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

Constructor. We override the Text_Wiki_Rule constructor so we can explicitly comment each part of the $regex property.

Access: public

Parameters:

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

[ Top ]

process [line 101]

A process(
array
&$matches)

Generates a replacement for the matched text. Token options are:

'page' => the wiki page name (e.g., HomePage).

'text' => alternative text to be displayed in place of the wiki page name.

'anchor' => a named anchor on the target wiki page

Return: delimited token to be used as a placeholder in the source text, plus any text priot to the match.
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 144]

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 ]