handleEvent(string $eventName, array $params)
Handles a event that was triggered by Pico
name of the triggered event
Common interface for Pico plugins
If you're developing a new plugin, you MUST both implement this interface
and define the class constant
API_VERSION. You SHOULD always use the
API version of Pico's latest milestone when releasing a plugin. If you're
developing a new version of an existing plugin, it is strongly recommended
to update your plugin to use Pico's latest API version.
setEnabled(boolean $enabled, boolean $recursive = true, boolean $auto = false)
Enables or disables this plugin
enable (TRUE) or disable (FALSE) this plugin
when TRUE, enable or disable recursively. In other words, if you enable a plugin, all required plugins are enabled, too. When disabling a plugin, all depending plugins are disabled likewise. Recursive operations are only performed as long as a plugin wasn't enabled/disabled manually. This parameter is optional and defaults to TRUE.
enable or disable to fulfill a dependency. This parameter is optional and defaults to FALSE.
thrown when a dependency fails
isEnabled() : boolean|null
Returns a boolean indicating whether this plugin is enabled or not
You musn't rely on the return value when Pico's
wasn't triggered on all plugins yet. This method might even return NULL
then. The plugin's status might change later.
plugin is enabled (TRUE) or disabled (FALSE)
getPico() : \Pico
Returns the plugin's instance of Pico
the plugin's instance of Pico