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

Class: Text_Wiki_Parse_Heading

Source Location: /Text_Wiki_Creole-1.0.2/Text/Wiki/Parse/Creole/Heading.php

Class Overview

Text_Wiki_Parse
   |
   --Text_Wiki_Parse_Heading

Parses for heading text.


Author(s):

Version:

  • $Id: Heading.php 228641 2007-02-01 09:57:36Z mic $

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 27]
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 equasl signs (=), determining the heading level. Equal signs at the end of the line are silently removed. 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: Tomaiuolo Michele <tomamic@yahoo.it>
  • Author: Paul M. Jones <pmjones@php.net>
  • Version: $Id: Heading.php 228641 2007-02-01 09:57:36Z mic $
  • License: LGPL


[ Top ]


Class Variables

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

[line 45]


Type:   mixed


[ Top ]

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

[line 43]

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

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 ]


Documentation generated on Mon, 11 Mar 2019 15:40:30 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.