User Documentation
Configuration
Libraries
Pages
Administration Pages
Plugins
Index

Plugin

Abstract class for plugins.  Plugins can inherit from this class to get default configuration functionality.  They can also override the configuration methods to do custom configuration.  Inherits: LnBlogObject

Summary
Plugin
Abstract class for plugins.
Properties
plugin_desc
A short description of the plugin.
plugin_version
The version number of the plugin.
member_list
An associative array of arrays, with the form member=>settings, where member is the name of a member variable of your class and settings is an associative array of the configuration data for that member.
Functions
addOption
A short-hand way to add configuration options.
showConfig
Displays the plugin configuration in an HTML form.
updateConfig
Retrieves configuration data for the plugin from an HTTP POST and stores the data in the relevant files.

Properties

plugin_desc

A short description of the plugin.

plugin_version

The version number of the plugin.  This should be in “1.2.3” format.

member_list

An associative array of arrays, with the form member=>settings, where member is the name of a member variable of your class and settings is an associative array of the configuration data for that member.  This array is used by the default configuration show/save methods.

The following is a list of possible configuration settings for a member variable.  If a setting is not given for a particular control, then the default value will be used.

descriptionA descriptive string for the variable.  This will be displayed on the configuration screen when the user modifies the setting for this variable.  This element is required.
controlThe type of control used to display this variable on the configuration screen.  For the most part, these map directly to HTML input element types.  The currently recognized values are “text”, “checkbox”, “radio”, and “select”.  The default is “text”.
defaultThe default value for this variable.  This value will be used if the user does not specify a setting.  Also, if the user modifies other settings, no configuration entry will be saved for this variable if the value is still the default.  This is important because of pre-blog overriding.  The default is the empty string.
optionsAn array of the form value=>description, where the value keys are control values and the descriptions describe each choice for the user.  These are used only for radio button and selection box controls, with each array element representing an option for the user to select .

Functions

addOption

function addOption($name,  
$description,  
$default,  
$control = "text",
$options = false)

A short-hand way to add configuration options.  Adds the necessary values to member_list all in one shot.

Parameters

nameThe name of the option.
descriptionA short description for the user to see.
defaultThe default value.
controlOptional control to use.  The default is “text”.
optionsAn array of options for radio and select controls.

showConfig

function showConfig(&$page)

Displays the plugin configuration in an HTML form.  You must make sure to initialize the member_list for this to work.

Parameters

pageA reference to the page which will display the configuration.  This is useful for configs that need to add linked-in stylesheets or external Javascript files.

Returns

Optionally returns the form markup as a string.

updateConfig

function updateConfig()

Retrieves configuration data for the plugin from an HTTP POST and stores the data in the relevant files.

Returns

True on success, false on failure.
Generated by Natural Docs
function addOption($name,  
$description,  
$default,  
$control = "text",
$options = false)
A short-hand way to add configuration options.
function showConfig(&$page)
Displays the plugin configuration in an HTML form.
function updateConfig()
Retrieves configuration data for the plugin from an HTTP POST and stores the data in the relevant files.
A base object which is event-aware, i.e.