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

Class: Text_Wiki_Parse_Heading

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

Class Overview


Parses for heading text.




Inherited Variables

Inherited Methods

Class Details

[line 37]
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.

[ Top ]

Class Variables

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

[line 55]

Type:   mixed

[ Top ]

$regex =  '/^(\++) (.*)/m'

[line 53]

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

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


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

[ Top ]

Documentation generated on Mon, 11 Mar 2019 14:52:58 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.