Class: Text_Wiki_Parse_Include

Source Location: /Text_Wiki-0.24.0/Text/Wiki/Parse/Include.php

Class Overview

Text_Wiki_Parse
   |
   --Text_Wiki_Parse_Include

This class implements a Text_Wiki_Parse to include the results of a

Author(s):

Paul M. Jones <pmjones at ciaweb.net>

Inherited Variables

Class: Text_Wiki_Parse

Text_Wiki_Parse::$rule
Text_Wiki_Parse::$wiki

Inherited Methods

Class: Text_Wiki_Parse

Text_Wiki_Parse::Text_Wiki_Parse(): Constructor for this parser rule.
Text_Wiki_Parse::getAttrs(): Extract 'attribute="value"' portions of wiki markup.
Text_Wiki_Parse::getConf(): Simple method to safely get configuration key values.
Text_Wiki_Parse::parse(): Abstrct method to parse source text for matches.
Text_Wiki_Parse::process(): Abstract method to generate replacements for matched text.

Class Details

[line 25]
This class implements a Text_Wiki_Parse to include the results of a

script directly into the source at parse-time; thus, the output of the script will be parsed by Text_Wiki. This differs from the 'embed' rule, which incorporates the results at render-time, meaning that the 'embed' content is not parsed by Text_Wiki.

DANGER!

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

$conf = array(
'base' => '/path/to/scripts/'
)

[line 27]

Type:	mixed
Overrides:	Array

[ Top ]

$file = null

[line 31]

Type:

mixed

[ Top ]

$output = null

[line 33]

Type:

mixed

[ Top ]

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

[line 48]

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

Access: public

Type:	string
Overrides:	Array

[ Top ]

$vars = null

[line 35]

Type:

mixed

[ Top ]

Method Detail

process [line 64]

The process(
array
&$matches)

Includes the results of the script directly into the source; the output will subsequently be parsed by the remaining Text_Wiki rules.

Return: results of the included script.
Access: public

Overrides Text_Wiki_Parse::process() (Abstract method to generate replacements for matched text.)

Parameters:

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

[ Top ]

Class: Text_Wiki_Parse_Include

Class Overview

Author(s):

Variables

Methods

Inherited Variables

Class: Text_Wiki_Parse

Inherited Methods

Class: Text_Wiki_Parse

Class Details

Class Variables

$conf = array( 'base' => '/path/to/scripts/' )

$file = null

$output = null

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

$vars = null

Method Detail

process [line 64]

Parameters:

$conf = array(
'base' => '/path/to/scripts/'
)