Class: patTemplate_OutputFilter_BBCode

Source Location: /includes/patTemplate/patTemplate/OutputFilter/BBCode.php

Class patTemplate_OutputFilter_BBCode

Class Overview

patTemplate BBCode output filter

$Id: BBCode.php 49 2005-09-15 02:55:27Z rhuk $

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.

Located in /includes/patTemplate/patTemplate/OutputFilter/BBCode.php [line 41]

patTemplate_Module
   |
   --patTemplate_OutputFilter
      |
      --patTemplate_OutputFilter_BBCode

Author(s):

Sebastian Mordziol <argh@php-tools.net>
Stephan Schmidt <schst@php.net>

Information Tags:

Link:

http://www.php-tools.net/site.php?file=patBBCode/Overview.xml

Properties

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From patTemplate_Module

patTemplate_Module::$_params

Inherited From patTemplate_OutputFilter

patTemplate_OutputFilter::apply()

apply the filter

Inherited From patTemplate_Module

patTemplate_Module::getName()

get the name of the module

patTemplate_Module::getParam()

gets a parameter of the module

patTemplate_Module::setParams()

sets parameters of the module

[ Top ]

Property Summary

object patBBCode	$BBCode	BBCode parser
string	$_name	filter name

[ Top ]

Method Summary

string	apply()	remove all whitespace from the output
void	_prepare()	prepare BBCode object

[ Top ]

Properties

object patBBCode $BBCode = null [line 58]

BBCode parser

API Tags:

Access:

private

[ Top ]

string $_name = 'BBCode' [line 50]

filter name

API Tags:

Abstract:
Access:	protected

Redefinition of:

patTemplate_Module::$_name: module name

[ Top ]

Methods

apply [line 67]

string apply(
string
$data 
)

remove all whitespace from the output

Parameters:

string

$data:

data

API Tags:

Return:	data without whitespace
Access:	public

Redefinition of:

patTemplate_OutputFilter::apply(): apply the filter

[ Top ]

_prepare [line 82]

void _prepare(
)

prepare BBCode object

API Tags:

Access:

private

[ Top ]

The site fititnt.org is not affiliated with or endorsed by the Joomla! Project or Open Source Matters. If you are looking for official documentation, visit api.joomla.org and docs.joomla.org.

Documentation generated on Mon, 26 Oct 2009 22:51:24 -0200 by phpDocumentor 1.4.3

Visit fititnt.org, and look for some extension or more Joomla Framework info	patTemplate Filters

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