Class: Text_Wiki_Parse_Default_Delimiter

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

Class Overview

Text_Wiki_Parse
   |
   --Text_Wiki_Parse_Default_Delimiter

Parses for Text_Wiki delimiter characters already in the source text.

Author(s):

Paul M. Jones <pmjones at php.net>

Version:

Release: @package_version@

Inherited Variables

Class: Text_Wiki_Parse

Text_Wiki_Parse::$conf
Text_Wiki_Parse::$regex
Text_Wiki_Parse::$rule
Text_Wiki_Parse::$wiki

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 36]
Parses for Text_Wiki delimiter characters already in the source text.

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

[ Top ]

Method Detail

Text_Wiki_Parse_Default_Delimiter (Constructor) [line 68]

Text_Wiki_Parse_Default_Delimiter Text_Wiki_Parse_Default_Delimiter(
object
&$obj, string
$name)

Constructor. Overrides the Text_Wiki_Parse_Default 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 ]

__construct (Constructor) [line 50]

Text_Wiki_Parse_Default_Delimiter __construct(
object
&$obj, string
$name)

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

Overrides Text_Wiki_Parse::__construct() (Constructor for this parser rule.)

Parameters:

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

[ Top ]

process [line 89]

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 ]