class module extends module_base

Properties

protected config $install_config from  module_base
protected iohandler_interface $iohandler from  module_base
protected bool $is_essential from  module_base
protected ordered_service_collection $task_collection

Array of tasks for installer module

from  module_base
protected array $task_step_count from  module_base
protected bool $allow_progress_bar from  module_base

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

bool
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

null
run()

Executes the task

string
recover_progress()

Returns the next task's name

int
get_step_count()

Returns the number of tasks in the module

array
get_navigation_stage_path()

Returns an array to the correct navigation stage

Details

in module_base at line 65
__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

in module_base at line 78
setup(config $config, iohandler_interface $iohandler)

Dependency getter

Parameters

config $config
iohandler_interface $iohandler

in module_base at line 87
bool 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.

Return Value

bool

true if the module is essential, false otherwise

in module_base at line 97
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

in module_base at line 105
null run()

Executes the task

Return Value

null

in module_base at line 190
protected string recover_progress()

Returns the next task's name

Return Value

string

Index of the array element of the next task

at line 29
int get_step_count()

Returns the number of tasks in the module

Return Value

int

at line 21
array get_navigation_stage_path()

Returns an array to the correct navigation stage

Return Value

array