PHP Interface PicoPluginInterface

For a list of supported events see {@link DummyPlugin}; you can use {@link DummyPlugin} as template for new plugins. For a list of deprecated events see {@link PicoDeprecated}. You SHOULD NOT use deprecated events when implementing this interface. Deprecated events are triggered by the {@link PicoDeprecated} plugin, if plugins which don't implement this interface are loaded. You can take advantage from this behaviour if you want to do something only when old plugins are loaded. Consequently the old events are never triggered when your plugin is implementing this interface and no old plugins are present. If you're developing a new plugin, you MUST implement this interface. If you're the developer of an old plugin, it is STRONGLY RECOMMENDED to use the events introduced in Pico 1.0 when releasing a new version of your plugin. If you want to use any of the new events, you MUST implement this interface and update all other events you use.

See link: http://picocms.org

Author: Daniel Rudolf

Show file Open project: gilbitron/pico

Public Methods

Method	Description
__construct ( Pico $pico )	Constructs a new instance of a Pico plugin
getDependants ( ) : object[]	Returns a list of plugins which depend on this plugin
getDependencies ( ) : string[]	Returns a list of names of plugins required by this plugin
getPico ( ) : Pico	Returns the plugins instance of Pico
handleEvent ( string $eventName, array $params ) : void	Handles a event that was triggered by Pico
isEnabled ( ) : boolean	Returns true if this plugin is enabled, false otherwise
isStatusChanged ( ) : boolean	Returns true if the plugin was ever enabled/disabled manually
setEnabled ( boolean $enabled, boolean $recursive = true, boolean $auto = false ) : void	Enables or disables this plugin

Method Details

__construct() public method

Constructs a new instance of a Pico plugin

public __construct ( Pico $pico )
$pico	Pico	current instance of Pico

getDependants() public method

Returns a list of plugins which depend on this plugin

public getDependants ( ) : object[]
return	object[]	dependant plugins

getDependencies() public method

Returns a list of names of plugins required by this plugin

public getDependencies ( ) : string[]
return	string[]	required plugins

getPico() public method

Returns the plugins instance of Pico

handleEvent() public method

Handles a event that was triggered by Pico

public handleEvent ( string $eventName, array $params ) : void
$eventName	string	name of the triggered event
$params	array	passed parameters
return	void

isEnabled() public method

Returns true if this plugin is enabled, false otherwise

See also: PicoPluginInterface::setEnabled()

public isEnabled ( ) : boolean
return	boolean	plugin is enabled (true) or disabled (false)

isStatusChanged() public method

Returns true if the plugin was ever enabled/disabled manually

See also: PicoPluginInterface::setEnabled()

public isStatusChanged ( ) : boolean
return	boolean	plugin is in its default state (true), false otherwise

setEnabled() public method

Enables or disables this plugin

See also: PicoPluginInterface::isEnabled()

See also: PicoPluginInterface::isStatusChanged()

public setEnabled ( boolean $enabled, boolean $recursive = true, boolean $auto = false ) : void
$enabled	boolean	enable (true) or disable (false) this plugin
$recursive	boolean	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.
$auto	boolean	enable or disable to fulfill a dependency This parameter is optional and defaults to false.
return	void

public getPico ( ) : Pico
return	Pico	the plugins instance of Pico