Text_Wiki
[ class tree: Text_Wiki ] [ index: Text_Wiki ] [ all elements ]

Class: Text_Wiki_Parse_Default_Embed

Source Location: /Text_Wiki-1.2.4/Text/Wiki/Parse/Default/Embed.php

Class Overview

Text_Wiki_Parse
   |
   --Text_Wiki_Parse_Default_Embed

Embeds the results of a PHP script at render-time.


Author(s):

Version:

  • Release: @package_version@

Variables

Methods


Inherited Variables

Inherited Methods

Class: Text_Wiki_Parse

Text_Wiki_Parse::__construct()
Constructor for this parser rule.
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 41]
Embeds the results of a PHP script at render-time.

This class implements a Text_Wiki_Parse_Default 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@php.net>
  • Version: Release: @package_version@


[ Top ]


Class Variables

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

[line 43]


Type:   mixed
Overrides:   Array


[ Top ]

$file =  null

[line 47]


Type:   mixed


[ Top ]

$output =  null

[line 49]


Type:   mixed


[ Top ]

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

[line 65]

The regular expression used to find source text matching this rule.
  • Access: public

Type:   string
Overrides:   Array


[ Top ]

$vars =  null

[line 51]


Type:   mixed


[ Top ]



Method Detail

process   [line 83]

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_Parse::process() (Abstract method to generate replacements for matched text.)

Parameters:

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

[ Top ]


Documentation generated on Tue, 12 Mar 2019 21:49:18 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.