plugin Class Reference

Inheritance diagram for plugin:

Public Member Functions
	__construct ($id, $currentUser, $template, $folder, $connection)
	getPluginName ()
	getPluginDescription ()
	getMessages ()
	getClassName ()
	getRequiredDojo ()
	getRequiredCss ()
	getOnLoadCode ()
	getJs ()
	getHeaderTags ()
	getDbPrefix ()
	deleteInstanceTables ()
	start ()
	getId ()

Detailed Description

What's a plugin? This class should define these.. every plugin has to extend this class!

Author

skamster

Constructor & Destructor Documentation

plugin::__construct	(		$id,
			$currentUser,
			$template,
			$folder,
			$connection
	)

Constructor

Parameters

array	$post	all the post-datas..
array	$get	all the get-datas
user	$currentUser
PDO	$connection

Member Function Documentation

plugin::getDbPrefix

(

)

For internally use of the plugins, to do unique tables.

plugin::getId

(

)

Implement this for using getDbPrefix. Important! Gets your instance plugin-id.

Returns

int id

plugin::getMessages

(

)

Get the className, which have to be unique too! Don't use points, better something like pluginnameUsername . This isn't so important for the user to show, the pluginName is used for this.

plugin::getPluginDescription ( )

abstract

Get a description of the plugin-file for admin or user which want to instance a plugin.

plugin::getPluginName ( )

abstract

Get the pluginname, set by each plugin. Use convention like pluginname.username.v01 or so. Important is a unique pluginname to others exist in web.

plugin::getRequiredDojo

(

)

Includes stuff like dojo.require(yourname). Eats a array.

plugin::start ( )

abstract

Execute-method of the plugin

---

The documentation for this class was generated from the following file:

• class/plugin.php