Search:

# CWIS Developers Documentation

Public Member Functions | Protected Attributes

# Plugin Class Reference

Base class for all plugins. More...

## Public Member Functions
| Register ()
| Set the plugin attributes.
| Initialize ()
| Initialize the plugin.
| HookEvents ()
| Hook methods to be called when specific events occur.
| DeclareEvents ()
| Declare events defined by this plugin.
| Install ()
| Perform any work needed when the plugin is first installed (for example, creating database tables).
| Upgrade ($PreviousVersion)
| Perform any work needed when the plugin is upgraded to a new version (for example, adding fields to database tables).
| Uninstall ($RemoveData)
| Perform any work needed when the plugin is uninstalled.
| GetAttributes ()
| Retrieve plugin information.
| ConfigSetting ($SettingName, $NewValue=NULL)
| Get/set plugin configuration setting.
## Protected Attributes
| $Name = NULL
| Proper (human-readable) name of plugin.
| $Version = NULL
| Version number of plugin in the format X.X.X (for example: 1.2.12).
| $Description = NULL
| Text description of the plugin.
| $Author = NULL
| Name of the plugin's author.
| $Url = NULL
| Web address for more information about the plugin.
| $Email = NULL
| Contact email for the plugin's author.
| $Instructions = NULL
| Instructions for configuring the plugin (displayed on the automatically-generated configuration page if configuration values are supplied).
| $EnabledByDefault = FALSE
| Whether the plugin should be enabled by default when installed.
| $Requires = array()
| Array with plugin base (class) names for the index and minimum version numbers for the values.
| $CfgSetup = array()
| Associative array describing the configuration values for the plugin.
| $CfgPage = NULL
| Name of configuration page for plugin.

List of all members.

## Detailed Description

Base class for all plugins.

Definition at line 6 of file Plugin.php.

## Member Function Documentation

Plugin::ConfigSetting | ( | $ | SettingName,
|  | $ | NewValue = `NULL`
| ) |  | `[final]`

Get/set plugin configuration setting.

Parameters:

  SettingName | Name of configuration value.
  NewValue | New setting value.

Returns:
  Requested value, or NULL if value was not set or there was no configuration value with the specified name.

Definition at line 116 of file Plugin.php.

Plugin::DeclareEvents | ( | ) |

Declare events defined by this plugin.

This is used when a plugin defines new events that it signals or responds to. Names of these events should begin with the plugin base name, followed by "_EVENT_" and the event name in all caps (for example "MyPlugin_EVENT_MY_EVENT").

Returns:
  Array with event names for the index and event types for the values.

Definition at line 47 of file Plugin.php.

Plugin::GetAttributes | ( | ) | `[final]`

Retrieve plugin information.

Returns:
  Array of attribute values indexed by attribute names.

Definition at line 92 of file Plugin.php.

Plugin::HookEvents | ( | ) |

Hook methods to be called when specific events occur.

For events declared by other plugins the name string should start with the plugin base (class) name followed by "::" and then the event name.

Returns:
  Array of method names to hook indexed by the event constants or names to hook them to.

Definition at line 35 of file Plugin.php.

Plugin::Initialize | ( | ) |

Initialize the plugin.

This is called after all plugins have been loaded but before any methods for this plugin (other than Register() or Initialize()) have been called.

Returns:
  NULL if initialization was successful, otherwise a string containing an error message indicating why initialization failed.

Definition at line 23 of file Plugin.php.

Plugin::Install | ( | ) |

Perform any work needed when the plugin is first installed (for example, creating database tables).

Returns:
  NULL if installation succeeded, otherwise a string containing an error message indicating why installation failed.

Definition at line 58 of file Plugin.php.

Plugin::Register | ( | ) | `[abstract]`

Set the plugin attributes.

At minimum this method MUST set $this->Name and $this->Version. This is called when the plugin is initially loaded.

Plugin::Uninstall | ( | $ | RemoveData ) |

Perform any work needed when the plugin is uninstalled.

Parameters:

  RemoveData | If TRUE, any data created by the plugin should be removed.

Returns:
  NULL if uninstall succeeded, otherwise a string containing an error message indicating why uninstall failed.

Definition at line 83 of file Plugin.php.

Plugin::Upgrade | ( | $ | PreviousVersion ) |

Perform any work needed when the plugin is upgraded to a new version (for example, adding fields to database tables).

Parameters:

  PreviousVersion | The version number of this plugin that was previously installed.

Returns:
  NULL if upgrade succeeded, otherwise a string containing an error message indicating why upgrade failed.

Definition at line 71 of file Plugin.php.

## Member Data Documentation

Plugin::$Author = NULL`[protected]`

Name of the plugin's author.

Definition at line 147 of file Plugin.php.

Plugin::$CfgPage = NULL`[protected]`

Name of configuration page for plugin.

Definition at line 180 of file Plugin.php.

Plugin::$CfgSetup = array()`[protected]`

Associative array describing the configuration values for the plugin.

The first index is the name of the configuration setting, and the second indicates the type of information about that setting. For more information please see Implementing CWIS Plugins.

Definition at line 175 of file Plugin.php.

Plugin::$Description = NULL`[protected]`

Text description of the plugin.

Definition at line 145 of file Plugin.php.

Plugin::$Email = NULL`[protected]`

Contact email for the plugin's author.

Definition at line 151 of file Plugin.php.

Plugin::$EnabledByDefault = FALSE`[protected]`

Whether the plugin should be enabled by default when installed.

Definition at line 157 of file Plugin.php.

Plugin::$Instructions = NULL`[protected]`

Instructions for configuring the plugin (displayed on the automatically-generated configuration page if configuration values are supplied).

Definition at line 155 of file Plugin.php.

Plugin::$Name = NULL`[protected]`

Proper (human-readable) name of plugin.

Definition at line 141 of file Plugin.php.

Plugin::$Requires = array()`[protected]`

Array with plugin base (class) names for the index and minimum version numbers for the values.

Special indexes of "PHP" may be used to specify a minimum required PHP version or "PHPX_xxx" to specify a required PHP extension, where "xxx" is the extension name (e.g. "PHPX_GD"). The version number value is ignored for PHP extensions.

Definition at line 166 of file Plugin.php.

Plugin::$Url = NULL`[protected]`

Web address for more information about the plugin.

Definition at line 149 of file Plugin.php.

Plugin::$Version = NULL`[protected]`

Version number of plugin in the format X.X.X (for example: 1.2.12).

Definition at line 143 of file Plugin.php.

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

- Plugin.php