Plugin Class Reference

Inheritance diagram for Plugin:

Public Member Functions
	plugin_enable ()
	plugin_disable ()
	settingChange ()
	plugin_transaction_reset ()
	plugin_draw_icon ()
	plugin_url ()

Static Public Member Functions
static	memberOf ($file)
static	isEnabled ($plugin)
static	pluginMap ($path="", $in=array())

Public Attributes
	$plugin_settings
	$plugin_description = 'This author didn\'t provide anything. Shame!'

Detailed Description

Plugin class

Plugins are collections of modules. Each collection should contain one module that subclasses 'Plugin'. This module provides meta-information about the plugin like settings and enable/disable hooks

Member Function Documentation

static Plugin::isEnabled (   $plugin)

static

Check whether a given plugin is enabled

Parameters

$plugin

string plugin name

Returns

True or False

static Plugin::memberOf (   $file)

static

Find the plugin containing a given file

Parameters

$file

string filename

Returns

plugin name or boolean False

Plugin::plugin_disable

(

)

Callback. Triggered when plugin is disabled

Plugin::plugin_enable

(

)

Callback. Triggered when plugin is enabled

Plugin::plugin_transaction_reset

(

)

Callback. Triggered after every transaction. Use for reseting any session/state info.

Plugin::plugin_url

(

)

Get a URL for the plugin's directory

static Plugin::pluginMap (   $path = "",   $in = array()  )

static

Find potential class files in a given directory

Parameters

$path

starting directory

Returns

array of class name => full file name

Plugin::settingChange

(

)

Callback. Triggered when plugin settings are updated.

Member Data Documentation

Plugin::$plugin_settings

Initial value:

= array(
        'example1' => array('default'=>'','label'=>'Setting #1',
                        'description'=>'Text goes here'),
        'example2' => array('default'=>1,
                        'options'=>array('Yes'=>1,'No'=>0)
                )
        )

Desired settings. These are automatically exposed on the 'Plugins' area of the install page and written to ini.php

---

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

• pos/is4c-nf/plugins/Plugin.php