phpBB API Documentation
Class

phpbb\extension\base

class base implements extension_interface

A base class for extensions without custom enable/disable/purge code.

Methods

__construct(ContainerInterface $container, finder $extension_finder, migrator $migrator, string $extension_name, string $extension_path)

Constructor

bool is_enableable()

Indicate whether or not the extension can be enabled.

false enable_step(mixed $old_state)

Single enable step that installs any included migrations

false disable_step(mixed $old_state)

Single disable step that does nothing

false purge_step(mixed $old_state)

Single purge step that reverts any included and installed migrations

Details

at line 50
public __construct(ContainerInterface $container, finder $extension_finder, migrator $migrator, string $extension_name, string $extension_path)

Constructor

Parameters

ContainerInterface $container Container object
finder $extension_finder
migrator $migrator
string $extension_name Name of this extension (from ext.manager)
string $extension_path Relative path to this extension

at line 63
public bool is_enableable()

Indicate whether or not the extension can be enabled.

Return Value

bool

at line 74
public false enable_step(mixed $old_state)

Single enable step that installs any included migrations

Parameters

mixed $old_state State returned by previous call of this method

Return Value

false Indicates no further steps are required

at line 89
public false disable_step(mixed $old_state)

Single disable step that does nothing

Parameters

mixed $old_state State returned by previous call of this method

Return Value

false Indicates no further steps are required

at line 100
public false purge_step(mixed $old_state)

Single purge step that reverts any included and installed migrations

Parameters

mixed $old_state State returned by previous call of this method

Return Value

false Indicates no further steps are required