1. class
  2. phpbb
  3. \
  4. install
  5. \
  6. module
  7. \
  8. requirements
  9. \
  10. task
  11. \
  12. check_server_environment

check_server_environment

class check_server_environment extends task_base

Installer task that checks if the server meets phpBB requirements

Properties

protected bool $is_essential from  task_base
protected database $database_helper
protected iohandler_interface $response_helper
protected bool $tests_passed

Methods

__construct(database $database_helper, iohandler_interface $response)

Constructor

bool
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

from  task_base
run()

Executes the task

set_test_passed(bool $is_passed)

Sets $this->tests_passed

check_php_version()

Check if the requirements for PHP version is met

check_image_size()

Checks if the installed PHP has getimagesize() available

check_pcre()

Checks if the installed PHP supports PCRE

check_json()

Checks whether PHP's JSON extension is available or not

check_mbstring()

Checks whether PHP's mbstring extension is available or not

check_xml()

Checks whether or not the XML PHP extension is available (Required by the text formatter)

check_available_dbms()

Check if any supported DBMS is available

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 42
__construct(database $database_helper, iohandler_interface $response)

Constructor

Parameters

database $database_helper
iohandler_interface $response

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 55
run()

Executes the task

at line 91
protected set_test_passed(bool $is_passed)

Sets $this->tests_passed

Parameters

bool $is_passed

at line 100
protected check_php_version()

Check if the requirements for PHP version is met

at line 116
protected check_image_size()

Checks if the installed PHP has getimagesize() available

at line 132
protected check_pcre()

Checks if the installed PHP supports PCRE

at line 148
protected check_json()

Checks whether PHP's JSON extension is available or not

at line 164
protected check_mbstring()

Checks whether PHP's mbstring extension is available or not

at line 180
protected check_xml()

Checks whether or not the XML PHP extension is available (Required by the text formatter)

at line 196
protected check_available_dbms()

Check if any supported DBMS is available

at line 214
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 222
string get_task_lang_name()

Returns the language key of the name of the task

Return Value

string