Elgg  Version 3.0
Public Member Functions | List of all members
Elgg\PluginBootstrapInterface Interface Reference

Plugin bootstrap interface. More...

Inheritance diagram for Elgg\PluginBootstrapInterface:
Elgg\PluginBootstrap Elgg\DefaultPluginBootstrap

Public Member Functions

 load ()
 Executed during 'plugins_load', 'system' event. More...
 
 boot ()
 Executed during 'plugins_boot:before', 'system' event. More...
 
 init ()
 Executed during 'init', 'system' event. More...
 
 ready ()
 Executed during 'ready', 'system' event. More...
 
 shutdown ()
 Executed during 'shutdown', 'system' event. More...
 
 activate ()
 Executed when plugin is activated, after 'activate', 'plugin' event and before activate.php is included. More...
 
 deactivate ()
 Executed when plugin is deactivated, after 'deactivate', 'plugin' event and before deactivate.php is included. More...
 
 upgrade ()
 Registered as handler for 'upgrade', 'system' event. More...
 
 elgg ()
 Returns Elgg's public DI container. More...
 
 plugin ()
 Returns plugin entity this bootstrap is related to. More...
 

Detailed Description

Plugin bootstrap interface.

Definition at line 11 of file PluginBootstrapInterface.php.

Member Function Documentation

Elgg\PluginBootstrapInterface::activate ( )

Executed when plugin is activated, after 'activate', 'plugin' event and before activate.php is included.

Returns
void

Implemented in Elgg\DefaultPluginBootstrap.

Elgg\PluginBootstrapInterface::boot ( )

Executed during 'plugins_boot:before', 'system' event.

Allows the plugin to register handlers for 'plugins_boot', 'system' and 'init', 'system' events, as well as implement boot time logic

Returns
void

Implemented in Elgg\DefaultPluginBootstrap.

Elgg\PluginBootstrapInterface::deactivate ( )

Executed when plugin is deactivated, after 'deactivate', 'plugin' event and before deactivate.php is included.

Returns
void

Implemented in Elgg\DefaultPluginBootstrap.

Elgg\PluginBootstrapInterface::elgg ( )

Returns Elgg's public DI container.

Returns
PublicContainer

Implemented in Elgg\PluginBootstrap.

Elgg\PluginBootstrapInterface::init ( )

Executed during 'init', 'system' event.

Allows the plugin to implement business logic and register all other handlers

Returns
void

Implemented in Elgg\DefaultPluginBootstrap.

Elgg\PluginBootstrapInterface::load ( )

Executed during 'plugins_load', 'system' event.

Allows the plugin to require additional files, as well as configure services prior to booting the plugin

Returns
void

Implemented in Elgg\DefaultPluginBootstrap.

Elgg\PluginBootstrapInterface::plugin ( )

Returns plugin entity this bootstrap is related to.

Returns
ElggPlugin

Implemented in Elgg\PluginBootstrap.

Elgg\PluginBootstrapInterface::ready ( )

Executed during 'ready', 'system' event.

Allows the plugin to implement logic after all plugins are initialized

Returns
void

Implemented in Elgg\DefaultPluginBootstrap.

Elgg\PluginBootstrapInterface::shutdown ( )

Executed during 'shutdown', 'system' event.

Allows the plugin to implement logic during shutdown

Returns
void

Implemented in Elgg\DefaultPluginBootstrap.

Elgg\PluginBootstrapInterface::upgrade ( )

Registered as handler for 'upgrade', 'system' event.

Allows the plugin to implement logic during system upgrade

Returns
void

Implemented in Elgg\DefaultPluginBootstrap.


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