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

Class: Text_Wiki_Parse_Footnote

Source Location: /Text_Wiki_Creole-1.0.2/Text/Wiki/Parse/Creole/Footnote.php

Class Overview

Text_Wiki_Parse
   |
   --Text_Wiki_Parse_Footnote

Parses for bold text.


Author(s):

Version:

  • $Id: Footnote.php 236407 2007-05-26 17:47:24Z mic $

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 26]
Parses for bold text.

This class implements a Text_Wiki_Rule to find source text marked for strong emphasis (bold) as defined by text surrounded by two stars. On parsing, the text itself is left in place, but the starting and ending instances of two stars are replaced with tokens.

  • Author: Michele Tomaiuolo <tomamic@yahoo.it>
  • Author: Paul M. Jones <pmjones@php.net>
  • Version: $Id: Footnote.php 236407 2007-05-26 17:47:24Z mic $
  • License: LGPL


[ Top ]


Class Variables

$regex =   "/(\n)*\[([0-9]+)\]/"

[line 42]

The regular expression used to parse the source text and find matches conforming to this rule. Used by the parse() method.
  • See: parse()
  • Access: public

Type:   string


[ Top ]



Method Detail

process   [line 61]

A process( array &$matches)

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

'type' => ['start'|'end'] The starting or ending point of the emphasized text. The text itself is left in the source.

  • Return: pair of delimited tokens to be used as a placeholder in the source text surrounding the text to be emphasized.
  • Access: public

Parameters:

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

[ Top ]


Documentation generated on Mon, 11 Mar 2019 15:40:30 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.