Docs For Class RendererPlugin

Class Overview

RendererPlugin Class

Located in /blogs/plugins/renderer.class.php [line 26]

Plugin
   |
   --RendererPlugin

Author(s):

API Tags:

Abstract:

Properties

Methods

render

[ Top ]

Direct descendents

Child Class	Description
smilies_Rendererplugin
wikilinks_Rendererplugin
auto_p_Rendererplugin
textile_Rendererplugin
texturize_Rendererplugin
gmcode_Rendererplugin
autolinks_Rendererplugin
bbcode_Rendererplugin
wacko_Rendererplugin

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties	Inherited Methods	Inherited Constants
Inherited From Plugin Plugin::$author Plugin::$code Plugin::$help_url Plugin::$long_desc Plugin::$name Plugin::$priority Plugin::$short_desc Plugin::$version	Inherited From Plugin Plugin::Plugin() Constructor, should set name and description Plugin::code() Template function: display plugin code Plugin::long_desc() Template function: display long description for plug in Plugin::name() Template function: display plugin name Plugin::set_param() Set param value Plugin::short_desc() Template function: display short description for plug in

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From Plugin

Plugin::$author

Plugin::$code

Plugin::$help_url

Plugin::$long_desc

Plugin::$name

Plugin::$priority

Plugin::$short_desc

Plugin::$version

Inherited From Plugin

Plugin::Plugin()

Constructor, should set name and description

Plugin::code()

Template function: display plugin code

Plugin::long_desc()

Template function: display long description for plug in

Plugin::name()

Template function: display plugin name

Plugin::set_param()

Set param value

Plugin::short_desc()

Template function: display short description for plug in

[ Top ]

Property Summary

mixed	$apply_to_html	Should this plugin apply to HTML?
mixed	$apply_to_xml	Should this plugin apply to XML?
mixed	$apply_when	When should this plugin apply?

[ Top ]

Method Summary

boolean

render()

Perform rendering

[ Top ]

Properties

mixed $apply_to_html = true [line 42]

Should this plugin apply to HTML?

Redefined in descendants as:

[ Top ]

mixed $apply_to_xml = false [line 50]

Should this plugin apply to XML?

It should actually only apply when:

it generates some content that is visible without HTML tags
it removes some dirty markup when generating the tags (which will get stripped afterwards)

Note: htmlentityencoded is not considered as XML here.

Redefined in descendants as:

[ Top ]

mixed $apply_when = 'opt-out' [line 38]

When should this plugin apply?

Possible values:

'stealth'
'always'
'opt-out'
'opt-in'
'lazy'
'never'

Redefined in descendants as:

[ Top ]

Methods

render [line 64]

boolean render(
string
&$content, string
$format 
)

Perform rendering

Well, this one does nothing but checking if Rendering applies to the output format. You need to derive this function.

Parameters:

string	&$content:	content to render (by reference) / rendered content
string	$format:	Output format, see format_to_output()

API Tags:

Return:

true if we can render something for the required output format

Redefined in descendants as:

smilies_Rendererplugin::render() : Perform rendering
wikilinks_Rendererplugin::render() : Perform rendering
auto_p_Rendererplugin::render() : Perform rendering
textile_Rendererplugin::render() : Perform rendering
texturize_Rendererplugin::render() : Perform rendering
gmcode_Rendererplugin::render() : Perform rendering
autolinks_Rendererplugin::render() : Perform rendering
bbcode_Rendererplugin::render() : Perform rendering
wacko_Rendererplugin::render() : Perform rendering

[ Top ]

Multilingual multiuser multiblog engine

Class: RendererPlugin

Class RendererPlugin

Packages

Classes

Files