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

Class: Text_Wiki_Parse_Default_Strong

Source Location: /Text_Wiki-1.2.4/Text/Wiki/Parse/Default/Strong.php

Class Overview

Text_Wiki_Parse
   |
   --Text_Wiki_Parse_Default_Strong

Parses for strongly-emphasized text.


Author(s):

Version:

  • Release: @package_version@

Variables

Methods


Inherited Variables

Inherited Methods

Class: Text_Wiki_Parse

Text_Wiki_Parse::__construct()
Constructor for this parser rule.
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 38]
Parses for strongly-emphasized text.

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

  • Author: Paul M. Jones <pmjones@php.net>
  • Version: Release: @package_version@


[ Top ]


Class Variables

$regex =   "/\*\*(.*?)\*\*/"

[line 54]

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

Type:   string
Overrides:   Array


[ Top ]



Method Detail

process   [line 73]

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

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 Tue, 12 Mar 2019 21:49:21 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.