phpBB API Documentation
Class

phpbb\install\module\update_filesystem\task\file_check

class file_check extends task_base

Updater task performing file checking

Methods

__construct(filesystem $filesystem, config $config, iohandler_interface $iohandler, update_helper $update_helper, string $phpbb_root_path)

Construct

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 62
public __construct(filesystem $filesystem, config $config, iohandler_interface $iohandler, update_helper $update_helper, string $phpbb_root_path)

Construct

Parameters

filesystem $filesystem
config $config
iohandler_interface $iohandler
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 76
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 84
public run()

Executes the task

at line 236
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 244
public string get_task_lang_name()

Returns the language key of the name of the task

Return Value

string