Multilingual multiuser multiblog engine

Class: Plugin

Source Location: /blogs/plugins/plugin.class.php

Class Plugin

Class Overview

Plugin Class

Located in /blogs/plugins/plugin.class.php [line 21]

Author(s):

API Tags:

Abstract:

[ Top ]

Direct descendents

Child Class	Description
RendererPlugin	RendererPlugin Class
ToolbarPlugin	ToolbarPlugin Class

[ Top ]

Property Summary

mixed	$author	Should be overriden by derived class:
mixed	$code	Should be overriden by derived class:
mixed	$help_url	Should be overriden by derived class:
mixed	$long_desc	Should be overriden by derived class:
mixed	$name	Should be overriden by derived class:
mixed	$priority	Should be overriden by derived class:
mixed	$short_desc	Should be overriden by derived class:
mixed	$version	Should be overriden by derived class:

[ Top ]

Method Summary

Plugin	Plugin()	Constructor, should set name and description
void	code()	Template function: display plugin code
void	long_desc()	Template function: display long description for plug in
void	name()	Template function: display plugin name
void	set_param()	Set param value
void	short_desc()	Template function: display short description for plug in

[ Top ]

Properties

mixed $author [line 30]

Should be overriden by derived class:

[ Top ]

mixed $code = '' [line 26]

Should be overriden by derived class:

Redefined in descendants as:

[ Top ]

mixed $help_url [line 31]

Should be overriden by derived class:

[ Top ]

mixed $long_desc [line 33]

Should be overriden by derived class:

Redefined in descendants as:

[ Top ]

mixed $name = 'Unnamed plug-in' [line 28]

Should be overriden by derived class:

Redefined in descendants as:

[ Top ]

mixed $priority = 50 [line 27]

Should be overriden by derived class:

Redefined in descendants as:

[ Top ]

mixed $short_desc [line 32]

Should be overriden by derived class:

Redefined in descendants as:

[ Top ]

mixed $version [line 29]

Should be overriden by derived class:

[ Top ]

Methods

Constructor Plugin [line 42]

Plugin Plugin(
)

Constructor, should set name and description

[ Top ]

code [line 54]

void code(
)

Template function: display plugin code

[ Top ]

long_desc [line 93]

void long_desc(
[string
$format = 'htmlbody'] 
)

Template function: display long description for plug in

Parameters:

string

$format:

Output format, see format_to_output()

[ Top ]

name [line 67]

void name(
[string
$format = 'htmlbody'] 
)

Template function: display plugin name

Parameters:

string

$format:

Output format, see format_to_output()

[ Top ]

set_param [line 107]

void set_param(
string
$parname, mixed
$parvalue 
)

Set param value

Parameters:

string	$parname:	Name of parameter
mixed	$parvalue:	Value of parameter

[ Top ]

short_desc [line 80]

void short_desc(
[string
$format = 'htmlbody'] 
)

Template function: display short description for plug in

Parameters:

string

$format:

Output format, see format_to_output()

[ Top ]

Documentation generated on Tue, 20 May 2008 01:51:55 +0200 by phpDocumentor 1.4.2