Class: Text_Wiki_Rule_interwiki

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

Class Overview

Text_Wiki_Rule
   |
   --Text_Wiki_Rule_interwiki

This class implements a Text_Wiki_Rule to find source text marked as an Interwiki link. See the regex for a detailed explanation of the text matching procedure; e.g., "InterWikiName:PageName".

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::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 34]
This class implements a Text_Wiki_Rule to find source text marked as an Interwiki link. See the regex for a detailed explanation of the text matching procedure; e.g., "InterWikiName:PageName".

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

[ Top ]

Class Variables

$regex = '([A-Za-z0-9_]+):([\/=&~#A-Za-z0-9_]+)'

[line 37]

Type:	mixed
Overrides:	Array

[ Top ]

Method Detail

parse [line 51]

void parse(
)

Parser. We override the standard parser so we can find both described interwiki links and standalone links.

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 ]

process [line 93]

A process(
array
&$matches)

Generates a replacement for the matched standalone interwiki text.

Token options are:

'site' => The key name for the Text_Wiki interwiki array map, usually the name of the interwiki site.

'page' => The page on the target interwiki to link to.

'text' => The text to display as the link.

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 ]

processDescr [line 131]

A processDescr(
array
&$matches)

Generates a replacement for described interwiki links. Token options are:

'site' => The key name for the Text_Wiki interwiki array map, usually the name of the interwiki site.

'page' => The page on the target interwiki to link to.

'text' => The text to display as the link.

Return: delimited token to be used as a placeholder in the source text, plus any text priot to the match.
Access: public

Parameters:

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

[ Top ]

renderXhtml [line 160]

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 ]