phpBB API Documentation
Interface

phpbb\install\module_interface

interface module_interface

Interface for installer modules

An installer module is a task collection which executes installer tasks.

Methods

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

array get_navigation_stage_path()

Returns an array to the correct navigation stage

Details

at line 31
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 41
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 48
public run()

Executes the task

at line 55
public int get_step_count()

Returns the number of tasks in the module

Return Value

int

at line 62
public array get_navigation_stage_path()

Returns an array to the correct navigation stage

Return Value

array