Class: Text_Wiki_Parse_Default_Wikilink

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

Class Overview

Text_Wiki_Parse
   |
   --Text_Wiki_Parse_Default_Wikilink

Parse for links to wiki pages.

Author(s):

Paul M. Jones <pmjones at php.net>

Version:

Release: @package_version@

Variables

$conf

Methods

Inherited Variables

Class: Text_Wiki_Parse

Text_Wiki_Parse::$regex
Text_Wiki_Parse::$rule
Text_Wiki_Parse::$wiki

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 45]
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.

Author: Paul M. Jones <pmjones@php.net>
Version: Release: @package_version@

[ Top ]

Class Variables

$conf = array (
                       'ext_chars' => false,
                       'utf-8' => false
    )

[line 47]

Type:	mixed
Overrides:	Array

[ Top ]

Method Detail

Text_Wiki_Parse_Default_Wikilink (Constructor) [line 118]

Text_Wiki_Parse_Default_Wikilink Text_Wiki_Parse_Default_Wikilink(
object
&$obj)

Constructor.

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

Access: public

Parameters:

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

[ Top ]

__construct (Constructor) [line 65]

Text_Wiki_Parse_Default_Wikilink __construct(
object
&$obj)

Constructor.

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

Access: public

Overrides Text_Wiki_Parse::__construct() (Constructor for this parser rule.)

Parameters:

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

[ Top ]

parse [line 134]

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

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

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 ]

Class: Text_Wiki_Parse_Default_Wikilink

Class Overview

Author(s):

Version:

Variables

Methods

Inherited Variables

Class: Text_Wiki_Parse

Inherited Methods

Class: Text_Wiki_Parse

Class Details

Class Variables

$conf = array ( 'ext_chars' => false, 'utf-8' => false )

Method Detail

Text_Wiki_Parse_Default_Wikilink (Constructor) [line 118]

Parameters:

__construct (Constructor) [line 65]

Parameters:

parse [line 134]

process [line 203]

Parameters:

processDescr [line 175]

Parameters:

$conf = array (
'ext_chars' => false,
'utf-8' => false
)