Class: Text_Wiki_Parse_Emphasis

Source Location: /Text_Wiki_Cowiki-0.0.2/Text/Wiki/Parse/Cowiki/Emphasis.php

Class Overview

Text_Wiki_Parse
   |
   --Text_Wiki_Parse_Emphasis

Parses for emphasized text.

Author(s):

Paul M. Jones <pmjones at php.net>

Inherited Variables

Inherited Methods

Class Details

[line 36]
Parses for emphasized text.

This class implements a Text_Wiki_Parse to find source text marked for emphasis (italics) as defined by text surrounded by two single-quotes. On parsing, the text itself is left in place, but the starting and ending instances of two single-quotes are replaced with tokens.

Author: Paul M. Jones <pmjones@php.net>

[ Top ]

Method Detail

Text_Wiki_Parse_Emphasis (Constructor) [line 42]

Text_Wiki_Parse_Emphasis Text_Wiki_Parse_Emphasis(

&$obj)

Setting regex in constructor instead of with var as we need $this->wiki->delim

Parameters:

&$obj —

[ Top ]

process [line 68]

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.

Return: A pair of delimited tokens to be used as a placeholder in the source text surrounding the text to be emphasized.
Access: public

Parameters:

array &$matches — The array of matches from parse().

[ Top ]