\patTemplate_OutputFilter_BBCode

patTemplate BBCode output filter

$Id: BBCode.php 408 2005-07-21 11:19:36Z argh $

Uses patBBCode. Note that patBBCode's syntax is not entirely the same than the 'official' BBCode. See the patBBCode projet page for details.

The following parameters are available:

  • skinDir (required) The folder where BBCode templates are stored

  • reader (required) The type of reader to use

  • BBCode (optional) A fully configured BBCode objet to use. The other two options are not required if you set this.

Summary

Methods
Properties
Constants
apply()
getName()
setParams()
getParam()
_prepare()
$_name
$_params
$BBCode
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$_name

$_name : string

filter name

Type

string

$_params

$_params : array

module parameters

Type

array

$BBCode

$BBCode : object

BBCode parser

Type

object — patBBCode

Methods

apply()

apply(  $data) : string

remove all whitespace from the output

Parameters

$data

Returns

string —

data without whitespace

getName()

getName() : string

get the name of the module

Returns

string —

name of the module

setParams()

setParams(  $params,   $clear = false) 

sets parameters of the module

Parameters

$params
$clear

getParam()

getParam(  $name) : mixed

gets a parameter of the module

Parameters

$name

Returns

mixed —

value of the parameter

_prepare()

_prepare() 

prepare BBCode object