phpBB API Documentation
Class

phpbb\install\module_base

abstract class module_base implements module_interface

Base class for installer module

Methods

__construct(ordered_service_collection $tasks, bool $essential = true, bool $allow_progress_bar = true)

Installer module constructor

setup(config $config, iohandler_interface $iohandler)

Dependency getter

is_essential()

Checks if the execution of the module is essential to install phpBB or it can be skipped

bool check_requirements()

Checks requirements for the tasks

run()

Executes the task

int get_step_count()

Returns the number of tasks in the module

Details

at line 65
public __construct(ordered_service_collection $tasks, bool $essential = true, bool $allow_progress_bar = true)

Installer module constructor

Parameters

ordered_service_collection $tasks array of installer tasks for installer module
bool $essential flag indicating whether the module is essential or not
bool $allow_progress_bar flag indicating whether or not to send progress information from within the module

at line 78
public setup(config $config, iohandler_interface $iohandler)

Dependency getter

Parameters

config $config
iohandler_interface $iohandler

at line 87
public is_essential()

Checks if the execution of the module is essential to install phpBB or it can be skipped

Note: Please note that all the non-essential modules have to implement check_requirements() method.

at line 97
public bool check_requirements()

Checks requirements for the tasks

Note: Only need to be implemented for non-essential tasks, as essential tasks requirements should be checked in the requirements install module.

Return Value

bool true if the task's requirements are met

at line 105
public run()

Executes the task

at line 199
public int get_step_count()

Returns the number of tasks in the module

Return Value

int