phpBB API Documentation
Interface

phpbb\extension\extension_interface

interface extension_interface

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

Methods

bool is_enableable()

Indicate whether or not the extension can be enabled.

enable_step($old_state)

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

disable_step($old_state)

Disables the extension.

purge_step($old_state)

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

Details

at line 27
public bool is_enableable()

Indicate whether or not the extension can be enabled.

Return Value

bool

at line 41
public enable_step($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 maxexecutiontime.

Parameters

$old_state

at line 55
public disable_step($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 maxexecutiontime.

Parameters

$old_state

at line 69
public purge_step($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 maxexecutiontime.

Parameters

$old_state