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

Class: Text_Wiki_Parse_Interwiki

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

Class Overview

Text_Wiki_Parse
   |
   --Text_Wiki_Parse_Interwiki

This class implements a Text_Wiki_Parse to find source text marked as an Interwiki link. See the regex for a detailed explanation of the text matching procedure; e.g., "InterWikiName:PageName".


Author(s):

Variables

Methods


Inherited Variables

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 17]
This class implements a Text_Wiki_Parse to find source text marked as an Interwiki link. See the regex for a detailed explanation of the text matching procedure; e.g., "InterWikiName:PageName".


[ Top ]


Class Variables

$regex =  '([A-Za-z0-9_]+):([\/=&~#A-Za-z0-9_]+)'

[line 20]


Type:   mixed
Overrides:   Array


[ Top ]



Method Detail

parse   [line 34]

void parse( )

Parser. We override the standard parser so we can find both described interwiki links and standalone links.
  • Access: public

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

process   [line 76]

A process( array &$matches)

Generates a replacement for the matched standalone interwiki text.

Token options are:

'site' => The key name for the Text_Wiki interwiki array map, usually the name of the interwiki site.

'page' => The page on the target interwiki to link to.

'text' => The text to display as the link.

  • Return: delimited token to be used as a placeholder in the source text, plus any text priot 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 109]

A processDescr( array &$matches)

Generates a replacement for described interwiki links. Token options are:

'site' => The key name for the Text_Wiki interwiki array map, usually the name of the interwiki site.

'page' => The page on the target interwiki to link to.

'text' => The text to display as the link.

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