class update_files extends task_base

File updater task

Properties

protected bool $is_essential from  task_base
protected driver_interface $cache
protected config $installer_config
protected iohandler_interface $iohandler
protected factory $factory
protected file_updater_interface|null $file_updater
protected update_helper $update_helper

Methods

__construct(container_factory $container, config $config, iohandler_interface $iohandler, factory $file_updater_factory, update_helper $update_helper)

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

get_file_updater(null|string $file_updater_method = null)

Get file updater

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 70
__construct(container_factory $container, config $config, iohandler_interface $iohandler, factory $file_updater_factory, update_helper $update_helper)

Constructor

Parameters

container_factory $container
config $config
iohandler_interface $iohandler
factory $file_updater_factory
update_helper $update_helper

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

at line 86
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 94
run()

Executes the task

at line 240
protected file_updater_interface get_file_updater(null|string $file_updater_method = null)

Get file updater

Parameters

null|string $file_updater_method

Name of the file updater to use

Return Value

file_updater_interface

File updater

at line 279
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 287
string get_task_lang_name()

Returns the language key of the name of the task

Return Value

string