Class: Text_Wiki_Parse_Deflist

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

Class Overview

Text_Wiki_Parse
   |
   --Text_Wiki_Parse_Deflist

Parses for definition lists.

Author(s):

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

Inherited Variables

Inherited Methods

Class Details

[line 34]
Parses for definition lists.

This class implements a Text_Wiki_Parse to find source text marked as a definition list. If a line starts with ';' or ':' it is considered a part of a definition list. ';' indicates the term to be defined and ':' indicates its definition. As in Mediawiki we also allow definition lists to only consist of one item-type.

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

[ Top ]

Class Variables

$regex = '/\n((?:\;|\:)+.*?\n(?!(?:\;|\:)+))/s'

[line 44]

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

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 'level' => the indent level (0 for the first level, 1 for the second, etc) 'count' => the list item number at this level. not needed for xhtml, but very useful for PDF and RTF.

Return: series of text and delimited tokens marking the different list text and list elements.
Access: public

Parameters:

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

[ Top ]