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

Class: Text_Wiki_Parse_Default_Deflist

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

Class Overview

Text_Wiki_Parse
   |
   --Text_Wiki_Parse_Default_Deflist

Parses for definition 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 38]
Parses for definition lists.

This class implements a Text_Wiki_Parse_Default 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 line 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@php.net>
  • Version: Release: @package_version@


[ Top ]


Class Variables

$regex =  '/\n((: ).*\n)(?!(: |\n))/Us'

[line 54]

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

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_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:17 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.