phpBB API Documentation
Class

phpbb\install\module\install_filesystem\module

class module extends module_base

Installer module for filesystem installation

Methods

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

Installer module constructor

from module_base
setup(config $config, iohandler_interface $iohandler)

Dependency getter

from module_base
is_essential()

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

from module_base
bool check_requirements()

Checks requirements for the tasks

from module_base
run()

Executes the task

from module_base
int get_step_count()

Returns the number of tasks in the module

from module_base
array get_navigation_stage_path()

Returns an array to the correct navigation stage

Details

in module_base 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

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

Dependency getter

Parameters

config $config
iohandler_interface $iohandler

in module_base 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.

in module_base 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

in module_base at line 105
public run()

Executes the task

in module_base at line 199
public int get_step_count()

Returns the number of tasks in the module

Return Value

int

at line 24
public array get_navigation_stage_path()

Returns an array to the correct navigation stage

Return Value

array