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

Class: Text_Wiki_Parse_Default_List

Source Location: /Text_Wiki-1.2.4/Text/Wiki/Parse/Default/List.php

Class Overview

Text_Wiki_Parse
   |
   --Text_Wiki_Parse_Default_List

Parses for bulleted and numbered lists.


Author(s):

Version:

  • Release: @package_version@

Variables

Methods


Inherited Variables

Inherited Methods

Class: Text_Wiki_Parse

Text_Wiki_Parse::__construct()
Constructor for this parser rule.
Text_Wiki_Parse::Text_Wiki_Parse()
Constructor for this parser rule.
Text_Wiki_Parse::getAttrs()
Extract 'attribute="value"' portions of wiki markup.
Text_Wiki_Parse::getConf()
Simple method to safely get configuration key values.
Text_Wiki_Parse::parse()
Abstrct method to parse source text for matches.
Text_Wiki_Parse::process()
Abstract method to generate replacements for matched text.

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: Paul M. Jones <pmjones@php.net>
  • Version: Release: @package_version@


[ Top ]


Class Variables

$regex =  '/^((\*|#)\s.*\n)(?!\2\s|(?:\s+((?:\*|#) |\n)))/Usm'

[line 55]

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

Type:   string
Overrides:   Array


[ Top ]



Method Detail

process   [line 86]

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_Parse::process() (Abstract method to generate replacements for matched text.)

Parameters:

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

[ Top ]


Documentation generated on Tue, 12 Mar 2019 21:49:20 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.