Class: Text_Wiki_Rule_deflist

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

Class Overview

Text_Wiki_Rule
   |
   --Text_Wiki_Rule_deflist

This class implements a Text_Wiki_Rule 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 lines indicates the end of the definition term and the beginning of the definition narrative.

Author(s):

Paul M. Jones <pmjones at ciaweb.net>

Variables

$regex

Methods

Inherited Variables

Class: Text_Wiki_Rule

Text_Wiki_Rule::$_wiki

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 definition list. In short, if a line starts with ':' then it is a definition list item; another ':' on the same lines 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.

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

[ Top ]

Class Variables

$regex = '/\n((:).*\n)(?!(:))/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 78]

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

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

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 ]