class notify_user extends task_base

Logs installation and sends an email to the admin

Properties

protected bool $is_essential from  task_base
protected config $install_config
protected iohandler_interface $iohandler
protected auth $auth
protected db $config
protected log_interface $log
protected user $user
protected string $phpbb_root_path
protected string $php_ext

Methods

__construct(container_factory $container, config $install_config, iohandler_interface $iohandler, string $phpbb_root_path, string $php_ext)

Constructor

bool
is_essential()

Checks if the task is essential to install phpBB or it can be skipped

bool
check_requirements()

Checks requirements for the tasks

run()

Executes the task

static int
get_step_count()

Returns the number of steps the task contains

string
get_task_lang_name()

Returns the language key of the name of the task

Details

at line 72
__construct(container_factory $container, config $install_config, iohandler_interface $iohandler, string $phpbb_root_path, string $php_ext)

Constructor

Parameters

container_factory $container
config $install_config
iohandler_interface $iohandler
string $phpbb_root_path
string $php_ext

in task_base at line 39
bool is_essential()

Checks if the task 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 task is essential, false otherwise

in task_base at line 49
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 103
run()

Executes the task

at line 154
static int get_step_count()

Returns the number of steps the task contains

This is a helper method to provide a better progress bar for the front-end.

Return Value

int

The number of steps that the task contains

at line 162
string get_task_lang_name()

Returns the language key of the name of the task

Return Value

string