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

Class: Text_Wiki_Parse_Delimiter

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

Class Overview

Text_Wiki_Parse
   |
   --Text_Wiki_Parse_Delimiter

This class implements a Text_Wiki_Parse to find instances of the delimiter character already embedded in the source text; it extracts them and replaces them with a delimited token, then renders them as the delimiter itself when the target format is XHTML.


Author(s):

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 18]
This class implements a Text_Wiki_Parse to find instances of the delimiter character already embedded in the source text; it extracts them and replaces them with a delimited token, then renders them as the delimiter itself when the target format is XHTML.


[ Top ]


Method Detail

process   [line 54]

A process( array &$matches)

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

'text' => The full matched text.

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

Text_Wiki_Parse_delimiter   [line 32]

void Text_Wiki_Parse_delimiter( object &$obj, string $name)

Constructor. Overrides the Text_Wiki_Parse constructor so that we can set the $regex property dynamically (we need to include the Text_Wiki $delim character.

Parameters:

object   &$obj   —  The calling "parent" Text_Wiki object.
string   $name   —  The token name to use for this rule.

[ Top ]


Documentation generated on Mon, 11 Mar 2019 13:56:09 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.