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:

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. Returns void } More...
	deactivate ()
	{Executed when plugin is deactivated, after 'deactivate', 'plugin' event. Returns void } More...
Public Member Functions inherited from Elgg\PluginBootstrap
	__construct (protected \ElggPlugin $plugin, protected 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...

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

activate()

Elgg\DefaultPluginBootstrap::activate

(

)

{Executed when plugin is activated, after 'activate', 'plugin' event.

Returns

void

}

Implements Elgg\PluginBootstrapInterface.

Definition at line 52 of file DefaultPluginBootstrap.php.

boot()

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 22 of file DefaultPluginBootstrap.php.

deactivate()

Elgg\DefaultPluginBootstrap::deactivate

(

)

{Executed when plugin is deactivated, after 'deactivate', 'plugin' event.

Returns

void

}

Implements Elgg\PluginBootstrapInterface.

Definition at line 58 of file DefaultPluginBootstrap.php.

init()

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 28 of file DefaultPluginBootstrap.php.

load()

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.

ready()

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 34 of file DefaultPluginBootstrap.php.

shutdown()

Elgg\DefaultPluginBootstrap::shutdown

(

)

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

Returns

void

}

Implements Elgg\PluginBootstrapInterface.

Definition at line 40 of file DefaultPluginBootstrap.php.

upgrade()

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 46 of file DefaultPluginBootstrap.php.

---

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

• engine/classes/Elgg/DefaultPluginBootstrap.php