phpBB API Documentation
Interface

phpbb\install\task_interface

interface task_interface

Interface for installer tasks

Methods

static int get_step_count()

Returns the number of steps the task contains

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

string get_task_lang_name()

Returns the language key of the name of the task

Details

at line 28
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 38
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 48
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 53
public run()

Executes the task

at line 60
public string get_task_lang_name()

Returns the language key of the name of the task

Return Value

string