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

Class: Text_Wiki_Render

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

Class Overview




Variables

Methods


Child classes:

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 ]

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:51:29 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.