Class: Text_Wiki_Rule_embed

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

Class Overview

Text_Wiki_Rule
   |
   --Text_Wiki_Rule_embed

This class implements a Text_Wiki_Rule to embed the contents of a URL inside the page at render-time. Typically used to get script output.

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 40]
This class implements a Text_Wiki_Rule to embed the contents of a URL inside the page at render-time. Typically used to get script output.

This differs from the 'include' rule, which incorporates results at parse-time; 'embed' output does not get parsed by Text_Wiki, while 'include' ouput does.

This rule is inherently not secure; it allows cross-site scripting to occur if the embedded output has <script> or other similar tags. Be careful.

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

[ Top ]

Class Variables

$regex = '/(\[\[embed )(.+?)(\]\])/i'

[line 54]

The regular expression used to find source text matching this rule.

Access: public

Type:	string
Overrides:	Array

[ Top ]

Method Detail

process [line 72]

A process(
array
&$matches)

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

'text' => The full matched text, not including the tags.

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 92]

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 ]