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

Class: Text_Wiki_Parse_Deflist

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

Class Overview


Parses for definition lists.




Inherited Variables

Inherited Methods

Class Details

[line 39]
Parses for definition lists.

This class implements a Text_Wiki_Parse to find source text marked as a definition list. In short, if a line starts with ':' then it is a definition list item; another ':' on the same line indicates the end of the definition term and the beginning of the definition narrative. The list items must be on sequential lines (no blank lines between them) -- a blank line indicates the beginning of a new list.

[ Top ]

Class Variables

$regex =  '/\n((; ).*\n)(?!(; |\n))/Us'

[line 55]

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

A process( array &$matches)

Generates a replacement for the matched text. Token options are:

'type' => 'list_start' : the start of a definition list 'list_end' : the end of a definition list 'term_start' : the start of a definition term 'term_end' : the end of a definition term 'narr_start' : the start of definition narrative 'narr_end' : the end of definition narrative 'unknown' : unknown type of definition portion

  • Return: series of text and delimited tokens marking the different list text and list elements.
  • 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.