Class: Text_Wiki_Parse_Heading

Source Location: /Text_Wiki_Mediawiki-0.2.0/Text/Wiki/Parse/Mediawiki/Heading.php

Class Overview

Text_Wiki_Parse
   |
   --Text_Wiki_Parse_Heading

Parses for heading text.

Author(s):

Moritz Venn <ritzmo at php.net>
Justin Patrin <papercrane at reversefold.com>
Paul M. Jones <pmjones at php.net>

Version:

Release: @package_version@

Inherited Variables

Inherited Methods

Class Details

[line 36]
Parses for heading text.

This class implements a Text_Wiki_Parse to find source text marked to be a heading element, as defined by text on a line by itself prefixed with a number of plus signs (+). The heading text itself is left in the source, but is prefixed and suffixed with delimited tokens marking the start and end of the heading.

Author: Moritz Venn <ritzmo@php.net>
Author: Justin Patrin <papercrane@reversefold.com>
Author: Paul M. Jones <pmjones@php.net>
Version: Release: @package_version@
See: Text_Wiki_Parse::Text_Wiki_Parse()
Link: http://pear.php.net/package/Text_Wiki
License: LGPL License 2.1

[ Top ]

Class Variables

$conf = array(
'id_prefix' => 'toc'
)

[line 48]

Type:

mixed

[ Top ]

$regex = '/^(={1,6})(.*?)\1(?=\s|$)/m'

[line 46]

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

See: parse()
Access: public

Type:

string

[ Top ]

Method Detail

process [line 62]

string process(
array
&$matches)

Generates a replacement for the matched text. Token options are: 'type' => ['start'|'end'] The starting or ending point of the heading 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 heading text.
Access: public

Parameters:

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

[ Top ]

Class: Text_Wiki_Parse_Heading

Class Overview

Author(s):

Version:

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$conf = array( 'id_prefix' => 'toc' )

$regex = '/^(={1,6})(.*?)\1(?=\s|$)/m'

Method Detail

process [line 62]

Parameters:

$conf = array(
'id_prefix' => 'toc'
)