interface extension_interface

The interface extension meta classes have to implement to run custom code on enable/disable/purge.

Methods

bool|array
is_enableable()

Indicate whether or not the extension can be enabled.

mixed
enable_step(mixed $old_state)

enable_step is executed on enabling an extension until it returns false.

mixed
disable_step(mixed $old_state)

Disables the extension.

mixed
purge_step(mixed $old_state)

purge_step is executed on purging an extension until it returns false.

Details

at line 28
bool|array is_enableable()

Indicate whether or not the extension can be enabled.

Return Value

bool|array

True if extension is enableable, array of reasons if not, false for generic reason.

at line 42
mixed enable_step(mixed $old_state)

enable_step is executed on enabling an extension until it returns false.

Calls to this function can be made in subsequent requests, when the function is invoked through a webserver with a too low max_execution_time.

Parameters

mixed $old_state

The return value of the previous call of this method, or false on the first call

Return Value

mixed

Returns false after last step, otherwise temporary state which is passed as an argument to the next step

at line 56
mixed disable_step(mixed $old_state)

Disables the extension.

Calls to this function can be made in subsequent requests, when the function is invoked through a webserver with a too low max_execution_time.

Parameters

mixed $old_state

The return value of the previous call of this method, or false on the first call

Return Value

mixed

Returns false after last step, otherwise temporary state which is passed as an argument to the next step

at line 70
mixed purge_step(mixed $old_state)

purge_step is executed on purging an extension until it returns false.

Calls to this function can be made in subsequent requests, when the function is invoked through a webserver with a too low max_execution_time.

Parameters

mixed $old_state

The return value of the previous call of this method, or false on the first call

Return Value

mixed

Returns false after last step, otherwise temporary state which is passed as an argument to the next step