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_Wikilink

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

Class Overview

Text_Wiki_Parse
   |
   --Text_Wiki_Parse_Wikilink

Parse for links to wiki pages.


Author(s):

Methods

Inherited Variables

Class: Text_Wiki_Parse

Text_Wiki_Parse::$conf
Text_Wiki_Parse::$regex
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 29]
Parse for links to wiki pages.

Wiki page names are typically in StudlyCapsStyle made of WordsSmashedTogether.

You can also create described links to pages in this style: [WikiPageName nice text link to use for display]

The token options for this rule are:

'page' => the wiki page name.

'text' => the displayed link text.

'anchor' => a named anchor on the target wiki page.

$Id: Wikilink.php,v 1.2 2004/09/25 19:05:13 pmjones Exp $



[ Top ]

Method Detail

Text_Wiki_Parse_Wikilink (Constructor)   [line 45]

Text_Wiki_Parse_Wikilink Text_Wiki_Parse_Wikilink( object &$obj)

Constructor.

We override the Text_Wiki_Parse constructor so we can explicitly comment each part of the $regex property.

  • Access: public

Parameters:

object   &$obj   —  The calling "parent" Text_Wiki object.

[ Top ]

parse   [line 78]

void parse( )

First parses for described links, then for standalone links.
  • Access: public

Overrides Text_Wiki_Parse::parse() (Abstrct method to parse source text for matches.)
[ Top ]

process   [line 139]

A process( array &$matches)

Generate a replacement for standalone links.
  • Return: delimited token to be used as a placeholder in the source text, plus any text prior to the match.
  • 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 ]

processDescr   [line 111]

A processDescr( array &$matches)

Generate a replacement for described links.
  • Return: delimited token to be used as a placeholder in the source text, plus any text priot to the match.
  • Access: public

Parameters:

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

[ Top ]
Documentation generated on Mon, 11 Mar 2019 13:56:12 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.