PHP Интерфейс 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.
См. ссылку: http://picocms.org
Автор: Daniel Rudolf
Показать файл Открыть проект

Открытые методы

Метод Описание
__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

Описание методов

__construct() публичный Метод

Constructs a new instance of a Pico plugin
public __construct ( Pico $pico )
$pico Pico current instance of Pico

getDependants() публичный Метод

Returns a list of plugins which depend on this plugin
public getDependants ( ) : object[]
Результат object[] dependant plugins

getDependencies() публичный Метод

Returns a list of names of plugins required by this plugin
public getDependencies ( ) : string[]
Результат string[] required plugins

getPico() публичный Метод

Returns the plugins instance of Pico
См. также: Pico
public getPico ( ) : Pico
Результат Pico the plugins instance of Pico

handleEvent() публичный Метод

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
Результат void

isEnabled() публичный Метод

Returns true if this plugin is enabled, false otherwise
См. также: PicoPluginInterface::setEnabled()
public isEnabled ( ) : boolean
Результат boolean plugin is enabled (true) or disabled (false)

isStatusChanged() публичный Метод

Returns true if the plugin was ever enabled/disabled manually
См. также: PicoPluginInterface::setEnabled()
public isStatusChanged ( ) : boolean
Результат boolean plugin is in its default state (true), false otherwise

setEnabled() публичный Метод

Enables or disables this plugin
См. также: PicoPluginInterface::isEnabled()
См. также: 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.
Результат void