phpBB API Documentation
Class

phpbb\install\module\update_filesystem\task\update_files

class update_files extends task_base

File updater task

Methods

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

Constructor

is_essential()

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

from task_base
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 76
public __construct(container_factory $container, config $config, iohandler_interface $iohandler, factory $file_updater_factory, update_helper $update_helper, string $phpbb_root_path)

Constructor

Parameters

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

in task_base at line 39
public 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.

at line 93
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 101
public run()

Executes the task

at line 282
static public 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 290
public string get_task_lang_name()

Returns the language key of the name of the task

Return Value

string