Class: Text_Wiki_Rule_list

Source Location: /Text_Wiki-0.12.1/Text/Wiki/Rule/list.php

Class Overview

Text_Wiki_Rule
   |
   --Text_Wiki_Rule_list

This class implements a Text_Wiki_Rule to find source text marked as

Author(s):

Paul M. Jones <pmjones at ciaweb.net>

Inherited Variables

Inherited Methods

Class: Text_Wiki_Rule

Text_Wiki_Rule::Text_Wiki_Rule(): Constructor for the rule.
Text_Wiki_Rule::addToken(): Add a token to the Text_Wiki tokens array, and return a delimited token number.
Text_Wiki_Rule::getMacroArgs(): Simple method to extract 'option="value"' portions of wiki markup, typically used only in macros.
Text_Wiki_Rule::parse(): Simple parsing method to apply the rule's regular expression to the source text, pass every match to the process() method, and replace the matched text with the results of the processing.
Text_Wiki_Rule::process(): Simple processing mathod to take matched text and generate replacement text. This is one of the methods you will definitely want to override in your rule class extensions.
Text_Wiki_Rule::renderXhtml(): Simple rendering method to take a set of token options and generate replacement text for it. This is another method you will definitely want to override in your rule subclass extensions.
Text_Wiki_Rule::setToken(): Set or re-set a token with specific information, overwriting any previous rule name and rule options.

Class Details

[line 37]
This class implements a Text_Wiki_Rule 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 (no blank lines between them) -- a blank line indicates the beginning of a new list.

Author: Paul M. Jones <pmjones@ciaweb.net>

[ Top ]

Class Variables

$regex = '/\n((\|#) .\n)(?! {0,}(\*|#))/Us'

[line 53]

The regular expression used to parse the source text and find matches conforming to this rule. Used by the parse() method.

See: Text_Wiki_Rule::parse()
Access: public

Type:	string
Overrides:	Array

[ Top ]

Method Detail

process [line 84]

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

Overrides Text_Wiki_Rule::process() (Simple processing mathod to take matched text and generate replacement text. This is one of the methods you will definitely want to override in your rule class extensions.)

Parameters:

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

[ Top ]

renderXhtml [line 243]

string renderXhtml(
array
$options)

Renders a token into text matching the requested format.

Return: The text rendered from the token options.
Access: public

Overrides Text_Wiki_Rule::renderXhtml() (Simple rendering method to take a set of token options and generate replacement text for it. This is another method you will definitely want to override in your rule subclass extensions.)

Parameters:

array $options — The "options" portion of the token (second element).

[ Top ]

Class: Text_Wiki_Rule_list

Class Overview

Author(s):

Variables

Methods

Inherited Variables

Class: Text_Wiki_Rule

Inherited Methods

Class: Text_Wiki_Rule

Class Details

Class Variables

$regex = '/\n((\*|#) .*\n)(?! {0,}(\*|#))/Us'

Method Detail

process [line 84]

Parameters:

renderXhtml [line 243]

Parameters:

$regex = '/\n((\|#) .\n)(?! {0,}(\*|#))/Us'