Plugins

API Documentation

\GSPPanel\Plugins

This class controls the plugin system

Methods

bindEvent(string $event, string $plugin, string $method, integer $priority = 10) : void

Binds a plugin and method to an event

Parameters

Name	Type	Description
$event	string	The event to bind to
$plugin	string	The plugins name
$method	string	The plugins method to call when the event is triggered
$priority	integer	The priority if multiple binds exist, default is 10

checkEvent(string $event) : boolean

Returns true if something is bound to the event

Parameters

Name	Type	Description
$event	string	The event name

Returns

Type	Description
boolean

getInstance() : \GSPPanel\Plugins

Returns the instance of the plugins class

Returns

Type	Description
\GSPPanel\Plugins

getPluginDetails(string $plugin) : array

Returns the details from the meta information for the plugin

Parameters

Name	Type	Description
$plugin	string

Returns

Type	Description
array	Array of plugin details

getPluginVar(string $plugin, string $var) : string | integer | array | boolean

Returns a variable from a plugin instance

Parameters

Name	Type	Description
$plugin	string	Plugin name
$var	string	Variable name

Returns

Type	Description
string \| integer \| array \| boolean

installPlugin(string $plugin) : array

Installs the plugin

Parameters

Name	Type	Description
$plugin	string	The name of the plugin

Returns

Type	Description
array

listBinds(string $event) : array

Lists all the events that are bound

Parameters

Name	Type	Description
$event	string	The event type

Returns

Type	Description
array

listEnabled(string $type = null) : void

Returns a list of enabled plugins of the specified type

Parameters

Name	Type	Description
$type	string	The type of plugin (Addon Manager, Update Manager, Query Code)

listPlugins() : array

Get a list of all the plugins available as well as their details

Returns

Type	Description
array	Array of plugins

loadPlugin(string $plugin) : boolean

Load the plugin and call the init method if it exists

Parameters

Name	Type	Description
$plugin	string	The name of the plugin

Returns

Type	Description
boolean

loadPlugins() : void

Search the database and load any required plugins

registerPlugin(string $plugin, array $meta) : void

Register the plugin in the system, this means it has been loaded

Parameters

Name	Type	Description
$plugin	string	The name of the plugin
$meta	array	The array of data returned from getPluginDetails

triggerEvent(string $event, string | integer | array $params = array()) : boolean | string | integer

Triggers an event which then calls the plugin's EventCalled function if it exists or the function directly

Parameters

Name	Type	Description
$event	string	The event that has been triggered
$params	string \| integer \| array	The parameters to be passed to the event handler

Returns

Type	Description
boolean \| string \| integer

triggerPluginEvent(string $plugin, string $event, string | integer | array $params = null) : boolean | string | integer | array

Triggers an event for a specific plugin which then calls the plugin's EventCalled function if it exists or the function directly

Parameters

Name	Type	Description
$plugin	string	The plugin to call
$event	string	The event that has been triggered
$params	string \| integer \| array	The parameters to be passed to the event handler

Returns

Type	Description
boolean \| string \| integer \| array

uninstallPlugin(string $plugin) : array

Uninstalls the plugin

Parameters

Name	Type	Description
$plugin	string	The name of the plugin

Returns

Type	Description
array