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


Classes:
Text_Wiki
Text_Wiki_Parse
Text_Wiki_Parse_Anchor
Text_Wiki_Parse_Blockquote
Text_Wiki_Parse_Bold
Text_Wiki_Parse_Break
Text_Wiki_Parse_Center
Text_Wiki_Parse_Code
Text_Wiki_Parse_Colortext
Text_Wiki_Parse_Deflist
Text_Wiki_Parse_Delimiter
Text_Wiki_Parse_Embed
Text_Wiki_Parse_emphasis
Text_Wiki_Parse_Freelink
Text_Wiki_Parse_Heading
Text_Wiki_Parse_Horiz
Text_Wiki_Parse_Html
Text_Wiki_Parse_Image
Text_Wiki_Parse_Include
Text_Wiki_Parse_Interwiki
Text_Wiki_Parse_Italic
Text_Wiki_Parse_List
Text_Wiki_Parse_Newline
Text_Wiki_Parse_Paragraph
Text_Wiki_Parse_Phplookup
Text_Wiki_Parse_Prefilter
Text_Wiki_Parse_Raw
Text_Wiki_Parse_Revise
Text_Wiki_Parse_Strong
Text_Wiki_Parse_Superscript
Text_Wiki_Parse_Table
Text_Wiki_Parse_Tighten
Text_Wiki_Parse_Toc
Text_Wiki_Parse_Tt
Text_Wiki_Parse_Url
Text_Wiki_Parse_Wikilink
Text_Wiki_Render_Latex
Text_Wiki_Render_Latex_Anchor
Text_Wiki_Render_Latex_Prefilter
Text_Wiki_Render_Plain_Anchor
Text_Wiki_Render_Plain_Prefilter
Text_Wiki_Render_Xhtml_Anchor
Text_Wiki_Render_Xhtml_Prefilter
Text_Wiki
   Text_Wiki_Parse_Function
Files:
Anchor.php
Anchor.php
Anchor.php
Anchor.php
Blockquote.php
Blockquote.php
Blockquote.php
Blockquote.php
Bold.php
Bold.php
Bold.php
Bold.php
Break.php
Break.php
Break.php
Break.php
Center.php
Center.php
Center.php
Center.php
Code.php
Code.php
Code.php
Code.php
Colortext.php
Colortext.php
Colortext.php
Colortext.php
Deflist.php
Deflist.php
Deflist.php
Deflist.php
Delimiter.php
Delimiter.php
Delimiter.php
Delimiter.php
Embed.php
Embed.php
Embed.php
Embed.php
Emphasis.php
Emphasis.php
Emphasis.php
Emphasis.php
Freelink.php
Freelink.php
Freelink.php
Freelink.php
Function.php
Function.php
Function.php
Function.php
Heading.php
Heading.php
Heading.php
Heading.php
Horiz.php
Horiz.php
Horiz.php
Horiz.php
Html.php
Html.php
Html.php
Html.php
Image.php
Image.php
Image.php
Image.php
Include.php
Include.php
Include.php
Include.php
Interwiki.php
Interwiki.php
Interwiki.php
Interwiki.php
Italic.php
Italic.php
Italic.php
Italic.php
Latex.php
List.php
List.php
List.php
List.php
Newline.php
Newline.php
Newline.php
Newline.php
Paragraph.php
Paragraph.php
Paragraph.php
Paragraph.php
Parse.php
Phplookup.php
Phplookup.php
Phplookup.php
Phplookup.php
Plain.php
Prefilter.php
Prefilter.php
Prefilter.php
Prefilter.php
Raw.php
Raw.php
Raw.php
Raw.php
Render.php
Revise.php
Revise.php
Revise.php
Revise.php
Strong.php
Strong.php
Strong.php
Strong.php
Superscript.php
Superscript.php
Superscript.php
Superscript.php
Table.php
Table.php
Table.php
Table.php
Tighten.php
Tighten.php
Tighten.php
Tighten.php
Toc.php
Toc.php
Toc.php
Toc.php
Tt.php
Tt.php
Tt.php
Tt.php
Url.php
Url.php
Url.php
Url.php
Wiki.php
Wikilink.php
Wikilink.php
Wikilink.php
Wikilink.php
Xhtml.php

Class: Text_Wiki_Parse_Embed

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

Class Overview

Text_Wiki_Parse
   |
   --Text_Wiki_Parse_Embed

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


Author(s):

Variables

Methods

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 23]
This class implements a Text_Wiki_Parse 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.



[ Top ]

Class Variables

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

[line 25]


Type:   mixed
Overrides:   Array


[ Top ]

$file =  null

[line 29]


Type:   mixed


[ Top ]

$output =  null

[line 31]


Type:   mixed


[ Top ]

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

[line 47]

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

Type:   string
Overrides:   Array


[ Top ]

$vars =  null

[line 33]


Type:   mixed


[ Top ]


Method Detail

process   [line 65]

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 Mon, 11 Mar 2019 13:56:09 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.