abstract_requirements_module
abstract class abstract_requirements_module extends module_base
Base class for requirements installer module
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
Installer module constructor
Checks if the execution of the module is essential to install phpBB or it can be skipped
Executes the task
Returns the number of tasks in the module
Details
in
module_base at line 65
__construct(ordered_service_collection $tasks, bool $essential = true, bool $allow_progress_bar = true)
Installer module constructor
in
module_base at line 78
setup(config $config, iohandler_interface $iohandler)
Dependency getter
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.
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.
at line 24
null
run()
Executes the task
in
module_base at line 190
protected string
recover_progress()
Returns the next task's name
at line 67
int
get_step_count()
Returns the number of tasks in the module