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

Class: Text_Wiki_Render

Source Location: /Text_Wiki-0.23.0/Text/Wiki/Render.php

Class Overview




Variables

Methods


Child classes:

Text_Wiki_Render_Latex
Formats parsed Text_Wiki for LaTeX rendering.
Text_Wiki_Render_Xhtml_List
Text_Wiki_Render_Xhtml_Colortext
Text_Wiki_Render_Xhtml_tt
Text_Wiki_Render_Xhtml_Include
Text_Wiki_Render_Xhtml_Bold
Text_Wiki_Render_Xhtml_Html
Text_Wiki_Render_Xhtml_Deflist
Text_Wiki_Render_Xhtml_Prefilter
This class implements a Text_Wiki_Render_Xhtml to "pre-filter" source text so that line endings are consistently \n, lines ending in a backslash \ are concatenated with the next line, and tabs are converted to spaces.
Text_Wiki_Render_Xhtml_Strong
Text_Wiki_Render_Xhtml_Blockquote
Text_Wiki_Render_Xhtml_Paragraph
Text_Wiki_Render_Xhtml_Horiz
Text_Wiki_Render_Xhtml_Toc
Text_Wiki_Render_Xhtml_Newline
Text_Wiki_Render_Xhtml_Table
Text_Wiki_Render_Xhtml_Url
Text_Wiki_Render_Xhtml_Superscript
Text_Wiki_Render_Xhtml_Revise
Text_Wiki_Render_Xhtml_Raw
Text_Wiki_Render_Xhtml_Code
Text_Wiki_Render_Xhtml_Emphasis
Text_Wiki_Render_Xhtml_Center
Text_Wiki_Render_Xhtml_Delimiter
Text_Wiki_Render_Xhtml_Image
Text_Wiki_Render_Xhtml_Anchor
This class renders an anchor target name in XHTML.
Text_Wiki_Render_Xhtml_Italic
Text_Wiki_Render_Xhtml_Interwiki
Text_Wiki_Render_Xhtml_Heading
Text_Wiki_Render_Xhtml_Phplookup
Text_Wiki_Render_Xhtml_Wikilink
Text_Wiki_Render_Xhtml_Tighten
Text_Wiki_Render_Xhtml_Function
Text_Wiki_Render_Xhtml_Break
Text_Wiki_Render_Xhtml_Embed
Text_Wiki_Render_Plain_List
Text_Wiki_Render_Plain_Colortext
Text_Wiki_Render_Plain_tt
Text_Wiki_Render_Plain_Include
Text_Wiki_Render_Plain_Bold
Text_Wiki_Render_Plain_Html
Text_Wiki_Render_Plain_Deflist
Text_Wiki_Render_Plain_Prefilter
This class implements a Text_Wiki_Render_Xhtml to "pre-filter" source text so that line endings are consistently \n, lines ending in a backslash \ are concatenated with the next line, and tabs are converted to spaces.
Text_Wiki_Render_Plain_Strong
Text_Wiki_Render_Plain_Blockquote
Text_Wiki_Render_Plain_Paragraph
Text_Wiki_Render_Plain_Horiz
Text_Wiki_Render_Plain_Toc
Text_Wiki_Render_Plain_Newline
Text_Wiki_Render_Plain_Table
Text_Wiki_Render_Plain_Url
Text_Wiki_Render_Plain_Superscript
Text_Wiki_Render_Plain_Revise
Text_Wiki_Render_Plain_Raw
Text_Wiki_Render_Plain_Code
Text_Wiki_Render_Plain_Emphasis
Text_Wiki_Render_Plain_Center
Text_Wiki_Render_Plain_Delimiter
Text_Wiki_Render_Plain_Image
Text_Wiki_Render_Plain_Anchor
This class renders an anchor target name in XHTML.
Text_Wiki_Render_Plain_Italic
Text_Wiki_Render_Plain_Interwiki
Text_Wiki_Render_Plain_Heading
Text_Wiki_Render_Plain_Phplookup
Text_Wiki_Render_Plain_Wikilink
Text_Wiki_Render_Plain_Tighten
Text_Wiki_Render_Plain_Function
Text_Wiki_Render_Plain_Freelink
Text_Wiki_Render_Plain_Break
Text_Wiki_Render_Plain_Embed
Text_Wiki_Render_Xhtml
Text_Wiki_Render_Latex_List
Text_Wiki_Render_Latex_Colortext
Text_Wiki_Render_Latex_tt
Text_Wiki_Render_Latex_Include
Text_Wiki_Render_Latex_Html
Text_Wiki_Render_Latex_Deflist
Text_Wiki_Render_Latex_Prefilter
This class implements a Text_Wiki_Render_Latex to "pre-filter" source text so that line endings are consistently \n, lines ending in a backslash \ are concatenated with the next line, and tabs are converted to spaces.
Text_Wiki_Render_Latex_Strong
Text_Wiki_Render_Latex_Blockquote
Text_Wiki_Render_Latex_Paragraph
Text_Wiki_Render_Latex_Horiz
Text_Wiki_Render_Latex_Toc
Text_Wiki_Render_Latex_Newline
Text_Wiki_Render_Latex_Table
Text_Wiki_Render_Latex_Url
Text_Wiki_Render_Latex_Superscript
Text_Wiki_Render_Latex_Revise
Text_Wiki_Render_Latex_Raw
Text_Wiki_Render_Latex_Code
Text_Wiki_Render_Latex_Emphasis
Text_Wiki_Render_Latex_Center
Text_Wiki_Render_Latex_Delimiter
Text_Wiki_Render_Latex_Image
Text_Wiki_Render_Latex_Anchor
This class renders an anchor target name in LaTeX.
Text_Wiki_Render_Latex_Interwiki
Text_Wiki_Render_Latex_Heading
Text_Wiki_Render_Latex_Phplookup
Text_Wiki_Render_Latex_Wikilink
Text_Wiki_Render_Latex_Tighten
Text_Wiki_Render_Latex_Function
Text_Wiki_Render_Latex_Freelink
Text_Wiki_Render_Latex_Break
Text_Wiki_Render_Latex_Embed
Text_Wiki_Render_Plain

Inherited Variables

Inherited Methods


Class Details

[line 3]


[ Top ]


Class Variables

$conf = array()

[line 16]

Configuration options for this render rule.
  • Access: public

Type:   string


[ Top ]

$format =  null

[line 29]

The name of this rule's format.
  • Access: public

Type:   string


[ Top ]

$rule =  null

[line 42]

The name of this rule's token array elements.
  • Access: public

Type:   string


[ Top ]

$wiki =  null

[line 57]

A reference to the calling Text_Wiki object.

This is needed so that each rule has access to the same source text, token set, URLs, interwiki maps, page names, etc.

  • Access: public

Type:   object


[ Top ]



Method Detail

Text_Wiki_Render (Constructor)   [line 70]

Text_Wiki_Render Text_Wiki_Render( object &$obj)

Constructor for this render format or rule.
  • Access: public

Parameters:

object   &$obj   —  The calling "parent" Text_Wiki object.

[ Top ]

formatConf   [line 157]

mixed formatConf( string $format, string $key)

Simple method to wrap a configuration in an sprintf() format.
  • Return: The formatted configuration key value (if it exists) or null (if it does not).
  • Access: public

Parameters:

string   $key   —  The configuration key.
string   $format   —  The sprintf() format string.

[ Top ]

getConf   [line 132]

mixed getConf( string $key, [mixed $default = null])

Simple method to safely get configuration key values.
  • Return: The configuration key value (if it exists) or the default value (if not).
  • Access: public

Parameters:

string   $key   —  The configuration key.
mixed   $default   —  If the key does not exist, return this value instead.

[ Top ]


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