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

Class: Text_Wiki_Render

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

Class Overview


Base rendering class for parsed and tokenized text.


Author(s):

Version:

  • Release: @package_version@

Variables

Methods


Child classes:

Text_Wiki_Render_Latex
Formats parsed Text_Wiki for LaTeX rendering.
Text_Wiki_Render_Docbook_Font
Font rule render class (used for BBCode)
Text_Wiki_Render_Docbook_List
This class renders bullet and ordered lists in DocBook.
Text_Wiki_Render_Docbook_SpecialChar
This class renders special characters in DocBook.
Text_Wiki_Render_Docbook_Colortext
This class renders colored text in DocBook.
Text_Wiki_Render_Docbook_Tt
This class renders monospaced text in DocBook.
Text_Wiki_Render_Docbook_Include
This class renders included markup in DocBook. (empty)
Text_Wiki_Render_Docbook_Bold
This class renders bold text in DocBook.
Text_Wiki_Render_Docbook_Html
This class renders preformated html in DocBook.
Text_Wiki_Render_Docbook_Titlebar
This class renders a title bar in DocBook.
Text_Wiki_Render_Docbook_Deflist
This class renders definition lists in DocBook.
Text_Wiki_Render_Docbook_Box
This class renders a box drawn in DocBook.
Text_Wiki_Render_Docbook_Prefilter
This class implements a Text_Wiki_Render_Docbook 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_Docbook_Strong
This class renders text marked as strong in DocBook.
Text_Wiki_Render_Docbook_Page
This class renders page markers in DocBook.
Text_Wiki_Render_Docbook_Blockquote
This class renders a blockquote in DocBook.
Text_Wiki_Render_Docbook_Smiley
Smiley rule Docbook render class
Text_Wiki_Render_Docbook_Paragraph
This class renders paragraphs in DocBook.
Text_Wiki_Render_Docbook_Horiz
This class renders an horizontal bar in DocBook.
Text_Wiki_Render_Docbook_Toc
This class inserts a table of content in DocBook.
Text_Wiki_Render_Docbook_Underline
This class renders underlined text in DocBook.
Text_Wiki_Render_Docbook_Newline
This class renders new lines in DocBook.
Text_Wiki_Render_Docbook_Table
This class renders tables in DocBook.
Text_Wiki_Render_Docbook_Url
This class renders URL links in DocBook.
Text_Wiki_Render_Docbook_Superscript
This class renders superscript text in DocBook.
Text_Wiki_Render_Docbook_Revise
This class renders revision marks in DocBook.
Text_Wiki_Render_Docbook_Raw
This class renders not processed blocks in DocBook.
Text_Wiki_Render_Docbook_Code
This class renders code blocks in DocBook.
Text_Wiki_Render_Docbook_Emphasis
This class renders emphasized text in DocBook.
Text_Wiki_Render_Docbook_Center
This class renders centered content in DocBook.
Text_Wiki_Render_Docbook_Delimiter
This class set back the replaced delimiters in DocBook.
Text_Wiki_Render_Docbook_Image
This class inserts an image in DocBook.
Text_Wiki_Render_Docbook_Anchor
This class renders an anchor target name in DocBook.
Text_Wiki_Render_Docbook_Subscript
This class renders subscript text in DocBook.
Text_Wiki_Render_Docbook_Italic
This class renders italic text in DocBook.
Text_Wiki_Render_Docbook_Interwiki
This class renders inter wikis links in DocBook.
Text_Wiki_Render_Docbook_Heading
This class renders headings in DocBook.
Text_Wiki_Render_Docbook_Phplookup
This class renders a link to php functions description in DocBook.
Text_Wiki_Render_Docbook_Wikilink
This class renders wiki links in DocBook.
Text_Wiki_Render_Docbook_Tighten
This class makes the tightening in DocBook. (empty)
Text_Wiki_Render_Docbook_Function
This class renders a function description in DocBook.
Text_Wiki_Render_Docbook_Break
This class renders line breaks in DocBook.
Text_Wiki_Render_Docbook_Preformatted
This class renders preformated text in DocBook.
Text_Wiki_Render_Docbook_Plugin
This class renders wiki plugins in DocBook. (empty)
Text_Wiki_Render_Docbook_Embed
This class replaces the embedded php output in DocBook.
Text_Wiki_Render_Xhtml_Font
Font rule render class (used for BBCode)
Text_Wiki_Render_Xhtml_List
This class renders bullet and ordered lists in XHTML.
Text_Wiki_Render_Xhtml_SpecialChar
This class renders special characters in XHTML.
Text_Wiki_Render_Xhtml_Colortext
This class renders colored text in XHTML.
Text_Wiki_Render_Xhtml_Tt
This class renders monospaced text in XHTML.
Text_Wiki_Render_Xhtml_Address
Address rule end renderer for Xhtml
Text_Wiki_Render_Xhtml_Include
This class renders included maekup in XHTML. (empty)
Text_Wiki_Render_Xhtml_Bold
This class renders bold text in XHTML.
Text_Wiki_Render_Xhtml_Html
This class renders preformated html in XHTML.
Text_Wiki_Render_Xhtml_Titlebar
This class renders a title bar in XHTML.
Text_Wiki_Render_Xhtml_Deflist
This class renders definition lists in XHTML.
Text_Wiki_Render_Xhtml_Box
This class renders a box drawn in XHTML.
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
This class renders text marked as strong in XHTML.
Text_Wiki_Render_Xhtml_Page
This class renders page markers in XHTML.
Text_Wiki_Render_Xhtml_Blockquote
This class renders a blockquote in XHTML.
Text_Wiki_Render_Xhtml_Smiley
Smiley rule Xhtml render class
Text_Wiki_Render_Xhtml_Paragraph
This class renders paragraphs in XHTML.
Text_Wiki_Render_Xhtml_Horiz
This class renders an horizontal bar in XHTML.
Text_Wiki_Render_Xhtml_Toc
This class inserts a table of content in XHTML.
Text_Wiki_Render_Xhtml_Underline
This class renders underlined text in XHTML.
Text_Wiki_Render_Xhtml_Newline
This class renders new lines in XHTML.
Text_Wiki_Render_Xhtml_Table
This class renders tables in XHTML.
Text_Wiki_Render_Xhtml_Url
This class renders URL links in XHTML.
Text_Wiki_Render_Xhtml_Superscript
This class renders superscript text in XHTML.
Text_Wiki_Render_Xhtml_Revise
This class renders revision marks in XHTML.
Text_Wiki_Render_Xhtml_Raw
This class renders not processed blocks in XHTML.
Text_Wiki_Render_Xhtml_Code
This class renders code blocks in XHTML.
Text_Wiki_Render_Xhtml_Emphasis
This class renders emphasized text in XHTML.
Text_Wiki_Render_Xhtml_Center
This class renders centered content in XHTML.
Text_Wiki_Render_Xhtml_Delimiter
This class set back the replaced delimiters in XHTML.
Text_Wiki_Render_Xhtml_Image
This class inserts an image in XHTML.
Text_Wiki_Render_Xhtml_Anchor
This class renders an anchor target name in XHTML.
Text_Wiki_Render_Xhtml_Subscript
This class renders subscript text in XHTML.
Text_Wiki_Render_Xhtml_Italic
This class renders italic text in XHTML.
Text_Wiki_Render_Xhtml_Interwiki
This class renders inter wikis links in XHTML.
Text_Wiki_Render_Xhtml_Heading
This class renders headings in XHTML.
Text_Wiki_Render_Xhtml_Phplookup
This class renders a link to php functions description in XHTML.
Text_Wiki_Render_Xhtml_Wikilink
This class renders wiki links in XHTML.
Text_Wiki_Render_Xhtml_Tighten
This class makes the tightening in XHTML. (empty)
Text_Wiki_Render_Xhtml_Function
This class renders a function description in XHTML.
Text_Wiki_Render_Xhtml_Break
This class renders line breaks in XHTML.
Text_Wiki_Render_Xhtml_Preformatted
This class renders preformated text in XHTML.
Text_Wiki_Render_Xhtml_Plugin
This class renders wiki plugins in XHTML. (empty)
Text_Wiki_Render_Xhtml_Embed
This class replaces the embedded php output in XHTML.
Text_Wiki_Render_Plain_Font
Font rule render class (used for BBCode)
Text_Wiki_Render_Plain_List
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Plain_SpecialChar
This class renders special characters in Plain.
Text_Wiki_Render_Plain_Colortext
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Plain_tt
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Plain_Include
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Plain_Bold
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Plain_Html
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Plain_Titlebar
This class renders a title bar in Plain.
Text_Wiki_Render_Plain_Deflist
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Plain_Box
This class renders a box drawn in Plain.
Text_Wiki_Render_Plain_Prefilter
This class implements a Text_Wiki_Render_Plain 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
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Plain_Page
This class renders page markers in Plain.
Text_Wiki_Render_Plain_Blockquote
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Plain_Smiley
Smiley rule Plain render class
Text_Wiki_Render_Plain_Paragraph
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Plain_Horiz
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Plain_Toc
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Plain_Underline
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Plain_Newline
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Plain_Table
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Plain_Url
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Plain_Superscript
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Plain_Revise
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Plain_Raw
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Plain_Code
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Plain_Emphasis
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Plain_Center
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Plain_Delimiter
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Plain_Image
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Plain_Anchor
This class renders an anchor target name in XHTML.
Text_Wiki_Render_Plain_Subscript
This class renders subscript text in Plain.
Text_Wiki_Render_Plain_Italic
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Plain_Interwiki
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Plain_Heading
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Plain_Phplookup
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Plain_Wikilink
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Plain_Tighten
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Plain_Function
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Plain_Freelink
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Plain_Break
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Plain_Preformatted
This class renders preformated text in Plain.
Text_Wiki_Render_Plain_Plugin
This class renders wiki plugins in Plain. (empty)
Text_Wiki_Render_Plain_Embed
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Xhtml
Format class for the Xhtml rendering
Text_Wiki_Render_Latex_Font
Font rule render class (used for BBCode)
Text_Wiki_Render_Latex_List
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Latex_SpecialChar
This class renders special characters in Latex.
Text_Wiki_Render_Latex_Colortext
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Latex_tt
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Latex_Include
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Latex_Bold
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Latex_Html
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Latex_Titlebar
This class renders a title bar in Latex.
Text_Wiki_Render_Latex_Deflist
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Latex_Box
This class renders a box drawn in Latex.
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
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Latex_Page
This class renders page markers in Latex.
Text_Wiki_Render_Latex_Blockquote
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Latex_Smiley
Smiley rule Latex render class
Text_Wiki_Render_Latex_Paragraph
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Latex_Horiz
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Latex_Toc
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Latex_Underline
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Latex_Newline
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Latex_Table
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Latex_Url
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Latex_Superscript
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Latex_Revise
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Latex_Raw
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Latex_Code
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Latex_Emphasis
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Latex_Center
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Latex_Delimiter
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Latex_Image
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Latex_Anchor
This class renders an anchor target name in LaTeX.
Text_Wiki_Render_Latex_Subscript
This class renders subscript text in Latex.
Text_Wiki_Render_Latex_Italic
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Latex_Interwiki
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Latex_Heading
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Latex_Phplookup
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Latex_Wikilink
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Latex_Tighten
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Latex_Function
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Latex_Break
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Latex_Preformatted
This class renders preformated text in Latex.
Text_Wiki_Render_Latex_Plugin
This class renders wiki plugins in Latex. (empty)
Text_Wiki_Render_Latex_Embed
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Plain
Base rendering class for parsed and tokenized text.
Text_Wiki_Render_Docbook
Format class for the Docbook rendering

Inherited Variables

Inherited Methods


Class Details

[line 26]
Base rendering class for parsed and tokenized text.


[ Top ]


Class Variables

$conf = array()

[line 39]

Configuration options for this render rule.
  • Access: public

Type:   string


[ Top ]

$format =  null

[line 52]

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

Type:   string


[ Top ]

$rule =  null

[line 65]

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

Type:   string


[ Top ]

$wiki =  null

[line 80]

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 149]

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 ]

__construct (Constructor)   [line 93]

Text_Wiki_Render __construct( object &$obj)

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

Overridden in child classes as:

Text_Wiki_Render_Docbook_Heading::__construct()
Constructor.

Parameters:

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

[ Top ]

formatConf   [line 196]

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 171]

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 ]

textEncode   [line 229]

rendered textEncode( string $text)

Default method to render text (htmlspecialchars)
  • Return: text
  • Access: public

Overridden in child classes as:

Text_Wiki_Render_Xhtml::textEncode()
Method to render text

Parameters:

string   $text   —  the text to render

[ Top ]

urlEncode   [line 215]

rendered urlEncode( string $urlChunk)

Default method to render url
  • Return: url
  • Access: public

Parameters:

string   $urlChunk   —  a part of an url to render

[ Top ]


Documentation generated on Tue, 12 Mar 2019 21:49:21 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.