Diogenes_Plugin_Skel Class Reference

Inheritance diagram for Diogenes_Plugin_Skel:

[legend]List of all members.

Public Member Functions
	allow_wperms ($wperms)
	setParams ($params)
	eraseParams ($barrel= '', $page=0)
	writeParams ($barrel= '', $page=0, $pos=0)
	dump ()
Public Attributes
	$type
	$params = array()
	$name = "Plugin_Skel"
	$description = "Plugin skeleton"
	$version = "0.1"
	$pos
	$active = 0

---

Detailed Description

This class describes a Diogenes plugin.

Definition at line 39 of file Skel.php.

---

Member Function Documentation

Diogenes_Plugin_Skel::allow_wperms

(

$

wperms

)

Is the plugin allowed with respect to a given write permission on a page ?

Parameters:

$wperms

Reimplemented in TextileMarkup, and WikiMarkup.

Definition at line 66 of file Skel.php.

Diogenes_Plugin_Skel::setParams

(

$

params

)

Set plugin parameters.

Parameters:

$params

Definition at line 76 of file Skel.php.

References $params.

Diogenes_Plugin_Skel::eraseParams	(	$	barrel = '',
		$	page = 0
	)

Erase parameters from database.

Parameters:

	$barrel
	$page

Definition at line 96 of file Skel.php.

Diogenes_Plugin_Skel::writeParams	(	$	barrel = '',
		$	page = 0,
		$	pos = 0
	)

Store parameters to database.

Parameters:

	$barrel
	$page
	$pos

Definition at line 118 of file Skel.php.

References $params, and $pos.

Diogenes_Plugin_Skel::dump

(

)

Dump parameters to a table.

Definition at line 137 of file Skel.php.

---

Member Data Documentation

Diogenes_Plugin_Skel::$type

Plugin type (object, filter)

Reimplemented in Diogenes_Plugin_Filter, and Diogenes_Plugin_Render.

Definition at line 41 of file Skel.php.

Diogenes_Plugin_Skel::$params = array()

Array of plugin parameters

Reimplemented in FileList, HtmlHead, HttpHeader, LinksMagic, and MailForm.

Definition at line 44 of file Skel.php.

Referenced by setParams(), and writeParams().

Diogenes_Plugin_Skel::$name = "Plugin_Skel"

Plugin name

Reimplemented in Diogenes_Plugin_Filter, Diogenes_Plugin_Render, FileList, HtmlHead, HttpHeader, LinksMagic, MailForm, RenderPhp, TextileMarkup, and WikiMarkup.

Definition at line 47 of file Skel.php.

Diogenes_Plugin_Skel::$description = "Plugin skeleton"

Plugin description

Reimplemented in Diogenes_Plugin_Filter, Diogenes_Plugin_Render, FileList, HtmlHead, HttpHeader, LinksMagic, MailForm, RenderPhp, TextileMarkup, and WikiMarkup.

Definition at line 50 of file Skel.php.

Diogenes_Plugin_Skel::$version = "0.1"

Plugin version

Reimplemented in Diogenes_Plugin_Filter, and Diogenes_Plugin_Render.

Definition at line 53 of file Skel.php.

Diogenes_Plugin_Skel::$pos

Position of the plugin

Definition at line 56 of file Skel.php.

Referenced by writeParams().

Diogenes_Plugin_Skel::$active = 0

Is the plugin active ?

Definition at line 59 of file Skel.php.

---

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

• Skel.php

---