Elgg  Version 3.0
Public Member Functions | List of all members
Elgg\DefaultPluginBootstrap Class Reference

Null plugin boostrap for plugins not defining 'bootstrap' in their elgg-plugin.php Can also be extended by plugin developers when only needing a limited subset of the bootstrap functions. More...

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

Public Member Functions

 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
} More...
 
 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
} More...
 
 init ()
 {Executed during 'init', 'system' event.Allows the plugin to implement business logic and register all other handlers
Returns
void
} More...
 
 ready ()
 {Executed during 'ready', 'system' event.Allows the plugin to implement logic after all plugins are initialized
Returns
void
} More...
 
 shutdown ()
 {Executed during 'shutdown', 'system' event.Allows the plugin to implement logic during shutdown
Returns
void
} More...
 
 upgrade ()
 {Registered as handler for 'upgrade', 'system' event.Allows the plugin to implement logic during system upgrade
Returns
void
} More...
 
 activate ()
 {Executed when plugin is activated, after 'activate', 'plugin' event and before activate.php is included.
Returns
void
} More...
 
 deactivate ()
 {Executed when plugin is deactivated, after 'deactivate', 'plugin' event and before deactivate.php is included.
Returns
void
} More...
 
- Public Member Functions inherited from Elgg\PluginBootstrap
 __construct (ElggPlugin $plugin, PublicContainer $dic)
 Constructor. More...
 
 elgg ()
 {Returns Elgg's public DI container.
Returns
PublicContainer
} More...
 
 plugin ()
 {Returns plugin entity this bootstrap is related to.
Returns
ElggPlugin
} More...
 

Additional Inherited Members

- Protected Attributes inherited from Elgg\PluginBootstrap
 $plugin
 
 $dic
 

Detailed Description

Null plugin boostrap for plugins not defining 'bootstrap' in their elgg-plugin.php Can also be extended by plugin developers when only needing a limited subset of the bootstrap functions.

NOTE: This class should never implement any code in it's functions

Definition at line 11 of file DefaultPluginBootstrap.php.

Member Function Documentation

Elgg\DefaultPluginBootstrap::activate ( )

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

Returns
void
}

Implements Elgg\PluginBootstrapInterface.

Definition at line 58 of file DefaultPluginBootstrap.php.

Elgg\DefaultPluginBootstrap::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
}

Implements Elgg\PluginBootstrapInterface.

Definition at line 23 of file DefaultPluginBootstrap.php.

Elgg\DefaultPluginBootstrap::deactivate ( )

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

Returns
void
}

Implements Elgg\PluginBootstrapInterface.

Definition at line 65 of file DefaultPluginBootstrap.php.

Elgg\DefaultPluginBootstrap::init ( )

{Executed during 'init', 'system' event.Allows the plugin to implement business logic and register all other handlers

Returns
void
}

Implements Elgg\PluginBootstrapInterface.

Definition at line 30 of file DefaultPluginBootstrap.php.

Elgg\DefaultPluginBootstrap::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
}

Implements Elgg\PluginBootstrapInterface.

Definition at line 16 of file DefaultPluginBootstrap.php.

Elgg\DefaultPluginBootstrap::ready ( )

{Executed during 'ready', 'system' event.Allows the plugin to implement logic after all plugins are initialized

Returns
void
}

Implements Elgg\PluginBootstrapInterface.

Definition at line 37 of file DefaultPluginBootstrap.php.

Elgg\DefaultPluginBootstrap::shutdown ( )

{Executed during 'shutdown', 'system' event.Allows the plugin to implement logic during shutdown

Returns
void
}

Implements Elgg\PluginBootstrapInterface.

Definition at line 44 of file DefaultPluginBootstrap.php.

Elgg\DefaultPluginBootstrap::upgrade ( )

{Registered as handler for 'upgrade', 'system' event.Allows the plugin to implement logic during system upgrade

Returns
void
}

Implements Elgg\PluginBootstrapInterface.

Definition at line 51 of file DefaultPluginBootstrap.php.


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