API Documentation
\

\Text_Wiki_Render_Docbook_Smiley

Smiley rule Docbook render class

Summary

Methods
Properties
Constants
__construct()
getConf()
formatConf()
urlEncode()
textEncode()
token()
$conf
$format
$rule
$wiki
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$conf

$conf : array

Configuration keys for this rule 'prefix' => the path to smileys images inclusive file name prefix, starts with '/' ==> abolute reference if no file names prefix but some folder, terminates with '/' 'extension' => the file extension (inclusive '.'), e.g. : if prefix 'smileys/icon_' and extension '.gif' ':)' whose name is 'smile' will give relative file 'smileys/icon_smile.gif' if prefix '/image/smileys/' and extension '.png': absolute '/image/smileys/smile.gif' 'css' => optional style applied to smileys

Type

array — 'config-key' => mixed config-value

$format

$format : string

The name of this rule's format.

Type

string

$rule

$rule : string

The name of this rule's token array elements.

Type

string

$wiki

$wiki : object

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.

Type

object

Methods

__construct()

__construct(  $obj)

Constructor for this render format or rule.

Parameters

$obj

getConf()

getConf(string  $key, mixed  $default = null) : mixed

Simple method to safely get configuration key values.

Parameters

string $key

The configuration key.
mixed $default

If the key does not exist, return this value instead.

Returns

mixed —

The configuration key value (if it exists) or the default value (if not).

formatConf()

formatConf(string  $format, string  $key) : mixed

Simple method to wrap a configuration in an sprintf() format.

Parameters

string $format

The sprintf() format string.
string $key

The configuration key.

Returns

mixed —

The formatted configuration key value (if it exists) or null (if it does not).

urlEncode()

urlEncode(string  $urlChunk) : \rendered

Default method to render url

Parameters

string $urlChunk

a part of an url to render

Returns

\rendered —

url

textEncode()

textEncode(string  $text) : \rendered

Default method to render text (htmlspecialchars)

Parameters

string $text

the text to render

Returns

\rendered —

text

token()

token(array  $options) : string

Renders a token into text matching the requested format.

process the Smileys

Parameters

array $options

The "options" portion of the token (second element).

Returns

string —

The text rendered from the token options.