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

Class: Text_Wiki_Parse_Freelink

Source Location: /Text_Wiki_Cowiki-0.0.2/Text/Wiki/Parse/Cowiki/Freelink.php

Class Overview


Parses for freelinked page links.




Inherited Variables

Inherited Methods

Class Details

[line 43]
Parses for freelinked page links.

This class implements a Text_Wiki_Parse to find source text marked as a wiki freelink, and automatically create a link to that page.

A freelink is any page name not conforming to the standard StudlyCapsStyle for a wiki page name. For example, a page normally named MyHomePage can be renamed and referred to as ((My Home Page)) -- note the spaces in the page name. You can also make a "nice-looking" link without renaming the target page; e.g., ((MyHomePage|My Home Page)). Finally, you can use named anchors on the target page: ((MyHomePage|My Home Page#Section1)).

[ Top ]

Class Variables

$regex =  '/abcdefghijklmnop\(\)\(\#\*%$%/'

[line 46]

Type:   mixed

[ Top ]

Method Detail

process   [line 69]

A process( array &$matches)

Generates a replacement for the matched text. Token options are:

'page' => the wiki page name (e.g., HomePage).

'text' => alternative text to be displayed in place of the wiki page name.

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

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


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

[ Top ]

Documentation generated on Mon, 11 Mar 2019 14:52:58 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.