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

Class: Text_Wiki_Parse_Address

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

Class Overview

Text_Wiki_Parse
   |
   --Text_Wiki_Parse_Address

Parses for signatures.


Author(s):

Version:

  • $Id: Address.php 222265 2006-10-23 13:11:27Z mic $

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 22]
Parses for signatures.

This class implements a Text_Wiki rule to find sections of the source text that are signatures. A signature is any line starting with exactly two - signs.

  • Author: Michele Tomaiuolo <tomamic@yahoo.it>
  • Version: $Id: Address.php 222265 2006-10-23 13:11:27Z mic $
  • License: LGPL


[ Top ]


Class Variables

$regex =  '/^--([^-].*)$/m'

[line 35]

The regular expression used to find source text matching this rule.
  • Access: public

Type:   string


[ Top ]



Method Detail

process   [line 54]

A process( array &$matches)

Generates a token entry for the matched text. Token options are:

'start' => The starting point of the signature.

'end' => The ending point of the signature.

  • Return: delimited token number to be used as a placeholder in the source 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.