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

Class: Text_Wiki_Parse_Colortext

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

Class Overview

Text_Wiki_Parse
   |
   --Text_Wiki_Parse_Colortext

This class implements a Text_Wiki_Parse to find source text marked for coloring.


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 16]
This class implements a Text_Wiki_Parse to find source text marked for coloring.


[ Top ]


Class Variables

$regex =  "/\#\#(.+?)\|(.+?)\#\#/"

[line 31]

The regular expression used to parse the source text and find matches conforming to this rule. Used by the parse() method.

Type:   string
Overrides:   Array


[ Top ]



Method Detail

process   [line 53]

string process( array &$matches)

Generates a replacement for the matched text. Token options are:

'type' => ['start'|'end'] The starting or ending point of the emphasized text. The text itself is left in the source.

'color' => the color indicator

  • Return: A pair of delimited tokens to be used as a placeholder in the source text surrounding the text to be emphasized.
  • 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:08 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.