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


Classes:
Text_Wiki
Text_Wiki_Parse
Text_Wiki_Parse_Anchor
Text_Wiki_Parse_Blockquote
Text_Wiki_Parse_Bold
Text_Wiki_Parse_Break
Text_Wiki_Parse_Center
Text_Wiki_Parse_Code
Text_Wiki_Parse_Colortext
Text_Wiki_Parse_Deflist
Text_Wiki_Parse_Delimiter
Text_Wiki_Parse_Embed
Text_Wiki_Parse_emphasis
Text_Wiki_Parse_Freelink
Text_Wiki_Parse_Heading
Text_Wiki_Parse_Horiz
Text_Wiki_Parse_Html
Text_Wiki_Parse_Image
Text_Wiki_Parse_Include
Text_Wiki_Parse_Interwiki
Text_Wiki_Parse_Italic
Text_Wiki_Parse_List
Text_Wiki_Parse_Newline
Text_Wiki_Parse_Paragraph
Text_Wiki_Parse_Phplookup
Text_Wiki_Parse_Prefilter
Text_Wiki_Parse_Raw
Text_Wiki_Parse_Revise
Text_Wiki_Parse_Strong
Text_Wiki_Parse_Superscript
Text_Wiki_Parse_Table
Text_Wiki_Parse_Tighten
Text_Wiki_Parse_Toc
Text_Wiki_Parse_Tt
Text_Wiki_Parse_Url
Text_Wiki_Parse_Wikilink
Text_Wiki_Render_Latex
Text_Wiki_Render_Latex_Anchor
Text_Wiki_Render_Latex_Prefilter
Text_Wiki_Render_Plain_Anchor
Text_Wiki_Render_Plain_Prefilter
Text_Wiki_Render_Xhtml_Anchor
Text_Wiki_Render_Xhtml_Prefilter
Text_Wiki
   Text_Wiki_Parse_Function
Files:
Anchor.php
Anchor.php
Anchor.php
Anchor.php
Blockquote.php
Blockquote.php
Blockquote.php
Blockquote.php
Bold.php
Bold.php
Bold.php
Bold.php
Break.php
Break.php
Break.php
Break.php
Center.php
Center.php
Center.php
Center.php
Code.php
Code.php
Code.php
Code.php
Colortext.php
Colortext.php
Colortext.php
Colortext.php
Deflist.php
Deflist.php
Deflist.php
Deflist.php
Delimiter.php
Delimiter.php
Delimiter.php
Delimiter.php
Embed.php
Embed.php
Embed.php
Embed.php
Emphasis.php
Emphasis.php
Emphasis.php
Emphasis.php
Freelink.php
Freelink.php
Freelink.php
Freelink.php
Function.php
Function.php
Function.php
Function.php
Heading.php
Heading.php
Heading.php
Heading.php
Horiz.php
Horiz.php
Horiz.php
Horiz.php
Html.php
Html.php
Html.php
Html.php
Image.php
Image.php
Image.php
Image.php
Include.php
Include.php
Include.php
Include.php
Interwiki.php
Interwiki.php
Interwiki.php
Interwiki.php
Italic.php
Italic.php
Italic.php
Italic.php
Latex.php
List.php
List.php
List.php
List.php
Newline.php
Newline.php
Newline.php
Newline.php
Paragraph.php
Paragraph.php
Paragraph.php
Paragraph.php
Parse.php
Phplookup.php
Phplookup.php
Phplookup.php
Phplookup.php
Plain.php
Prefilter.php
Prefilter.php
Prefilter.php
Prefilter.php
Raw.php
Raw.php
Raw.php
Raw.php
Render.php
Revise.php
Revise.php
Revise.php
Revise.php
Strong.php
Strong.php
Strong.php
Strong.php
Superscript.php
Superscript.php
Superscript.php
Superscript.php
Table.php
Table.php
Table.php
Table.php
Tighten.php
Tighten.php
Tighten.php
Tighten.php
Toc.php
Toc.php
Toc.php
Toc.php
Tt.php
Tt.php
Tt.php
Tt.php
Url.php
Url.php
Url.php
Url.php
Wiki.php
Wikilink.php
Wikilink.php
Wikilink.php
Wikilink.php
Xhtml.php

Class: Text_Wiki_Parse_Deflist

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

Class Overview

Text_Wiki_Parse
   |
   --Text_Wiki_Parse_Deflist

This class implements a Text_Wiki_Parse 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):

Variables

Methods

Inherited Variables

Class: Text_Wiki_Parse

Text_Wiki_Parse::$conf
Text_Wiki_Parse::$rule
Text_Wiki_Parse::$wiki

Inherited Methods

Class: Text_Wiki_Parse

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 20]
This class implements a Text_Wiki_Parse 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.



[ Top ]

Class Variables

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

[line 36]

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

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 Mon, 11 Mar 2019 13:56:08 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.