Search:

# CWIS Developers Documentation

# 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 triggered 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.
## 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.
| $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.

List of all members.

## Detailed Description

Base class for all plugins.

Definition at line 6 of file Plugin.php.

## Member Function Documentation

Plugin::DeclareEvents | ( |  | ) |

Declare events triggered by this plugin.

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

Definition at line 43 of file Plugin.php.

Plugin::GetAttributes | ( |  | ) |

Retrieve plugin information.

Returns:
  Array of attribute values indexed by attribute names.

Definition at line 88 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 34 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 have been called.

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

Definition at line 22 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 54 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 79 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 67 of file Plugin.php.

## Member Data Documentation

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

Name of the plugin's author.

Definition at line 112 of file Plugin.php.

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

Text description of the plugin.

Definition at line 110 of file Plugin.php.

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

Contact email for the plugin's author.

Definition at line 116 of file Plugin.php.

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

Whether the plugin should be enabled by default when installed.

Definition at line 118 of file Plugin.php.

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

Proper (human-readable) name of plugin.

Definition at line 106 of file Plugin.php.

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

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

Definition at line 124 of file Plugin.php.

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

Web address for more information about the plugin.

Definition at line 114 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 108 of file Plugin.php.

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

- Plugin.php