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

Class: Text_Wiki_Parse_Image

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

Class Overview

Text_Wiki_Parse
   |
   --Text_Wiki_Parse_Image

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


Author(s):

Variables

Methods


Inherited Variables

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. Typically used to get script output.

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.

In the future, we'll add a rule config options to set the base embed path so that it is limited to one directory.



[ Top ]


Class Variables

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

[line 37]

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

Type:   string
Overrides:   Array


[ Top ]



Method Detail

process   [line 57]

A process( array &$matches)

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

'src' => The image source, typically a relative path name.

'opts' => Any macro options following the source.

  • 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:10 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.