Class: Text_Wiki_Parse_List

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

Class Overview

Text_Wiki_Parse
   |
   --Text_Wiki_Parse_List

Parses for bulleted and numbered lists.

Author(s):

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

Version:

Release: @package_version@

Inherited Variables

Inherited Methods

Class Details

[line 39]
Parses for bulleted and numbered lists.

This class implements a Text_Wiki_Parse to find source text marked as a bulleted or numbered list. In short, if a line starts with '* ' then it is a bullet list item; if a line starts with '# ' then it is a number list item. Spaces in front of the * or # indicate an indented sub-list. The list items must be on sequential lines, and may be separated by blank lines to improve readability. Using a non-* non-# non-whitespace character at the beginning of a line ends the list.

Author: Moritz Venn <ritzmo@php.net>
Author: Justin Patrin <papercrane@reversefold.com>
Author: Paul M. Jones <pmjones@php.net>
Version: Release: @package_version@
See: Text_Wiki_Parse::Text_Wiki_Parse()
Link: http://pear.php.net/package/Text_Wiki
License: LGPL License 2.1

[ Top ]

Class Variables

$regex = '/\n((?:\|#)+(?!redirect).?\n(?!(?:\*|#)+))/si'

[line 50]

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

A process(
array
&$matches)

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

'type' => 'bullet_start' : the start of a bullet list 'bullet_end' : the end of a bullet list 'number_start' : the start of a number list 'number_end' : the end of a number list 'item_start' : the start of item text (bullet or number) 'item_end' : the end of item text (bullet or number) 'unknown' : unknown type of list or item '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 ]

Class: Text_Wiki_Parse_List

Class Overview

Author(s):

Version:

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$regex = '/\n((?:\*|#)+(?!redirect).*?\n(?!(?:\*|#)+))/si'

Method Detail

process [line 72]

Parameters:

$regex = '/\n((?:\|#)+(?!redirect).?\n(?!(?:\*|#)+))/si'