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

Class: Text_Wiki_Parse_Underline

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

Class Overview

Text_Wiki_Parse
   |
   --Text_Wiki_Parse_Underline

Parses for italic text.


Author(s):

Version:

  • $Id: Underline.php 242127 2007-09-03 21:29:36Z mic $

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 25]
Parses for italic text.

This class implements a Text_Wiki_Parse to find source text marked for underlined as defined by text surrounded by two '_'. On parsing, the text itself is left in place, but the starting and ending instances of two '^' are replaced with tokens.

  • Author: Michele Tomaiuolo <tomamic@yahoo.it>
  • Author: Paul M. Jones <pmjones@php.net>
  • Version: $Id: Underline.php 242127 2007-09-03 21:29:36Z mic $
  • License: LGPL


[ Top ]


Class Variables

$regex =   "/__(.+?)__/"

[line 41]

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]

string process( array &$matches)

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

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

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

Parameters:

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

[ Top ]


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