check_filesystem
class check_filesystem extends task_base
Checks filesystem requirements
Properties
| protected bool | $is_essential | from task_base | |
| protected filesystem_interface | $filesystem | ||
| protected array | $files_to_check | ||
| protected bool | $tests_passed | ||
| protected string | $phpbb_root_path | ||
| protected iohandler_interface | $response |
Methods
Constructor
Checks if the task is essential to install phpBB or it can be skipped
Executes the task
Sets $this->tests_passed
Check if a file is readable and writable
Check if a directory is readable and writable
Returns the number of steps the task contains
Returns the language key of the name of the task
Details
at line 55
__construct(filesystem_interface $filesystem, iohandler_interface $response, string $phpbb_root_path, string $php_ext, bool $check_config_php = true)
Constructor
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.
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.
at line 103
run()
Executes the task
at line 128
protected
set_test_passed(bool $is_passed)
Sets $this->tests_passed
at line 140
protected
check_file(string $file, bool $failable = false)
Check if a file is readable and writable
at line 201
protected
check_dir(string $dir, bool $failable = false)
Check if a directory is readable and writable
at line 267
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.
at line 275
string
get_task_lang_name()
Returns the language key of the name of the task