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

Class: Text_Wiki_Parse_Code

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

Class Overview

Text_Wiki_Parse
   |
   --Text_Wiki_Parse_Code

This class implements a Text_Wiki_Parse to find sections marked as code


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 20]
This class implements a Text_Wiki_Parse to find sections marked as code

examples. Blocks are marked as the string

  1.  on a line by itself,
  2.  followed by the inline code exampleand terminated with the string
on a line by itself. The code example is run through the native PHP highlight_string() function to colorize it, then surrounded with
...
tags when rendered as XHTML.



[ Top ]


Class Variables

$regex =  '/^(\<code( .+)?\>)\n(.+)\n(\<\/code\>)(\s|$)/Umsi'

[line 34]

The regular expression used to find source text matching this rule.
  • Access: public

Type:   string
Overrides:   Array


[ Top ]



Method Detail

process   [line 52]

A process( array &$matches)

Generates a token entry for the matched text. Token options are:

'text' => The full matched text, not including the tags.

  • Return: delimited token number to be used as a placeholder in the source text.
  • 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.