class create_config_file extends task_base

Dumps config file

Properties

protected bool $is_essential from  task_base
protected filesystem_interface $filesystem
protected database $db_helper
protected config $install_config
protected iohandler_interface $iohandler
protected string $phpbb_root_path
protected string $php_ext
protected array $options

Methods

__construct(filesystem_interface $filesystem, config $install_config, database $db_helper, iohandler_interface $iohandler, string $phpbb_root_path, string $php_ext, array $options = array())

Constructor

bool
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_config_data(bool $debug = false, bool $debug_container = false, string $environment = null)

Returns the content which should be dumped to config.php

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 69
__construct(filesystem_interface $filesystem, config $install_config, database $db_helper, iohandler_interface $iohandler, string $phpbb_root_path, string $php_ext, array $options = array())

Constructor

Parameters

filesystem_interface $filesystem
config $install_config
database $db_helper
iohandler_interface $iohandler
string $phpbb_root_path
string $php_ext
array $options

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

Executes the task

at line 165
protected string get_config_data(bool $debug = false, bool $debug_container = false, string $environment = null)

Returns the content which should be dumped to config.php

Parameters

bool $debug

If the debug constants should be enabled by default or not

bool $debug_container

If the container should be compiled on every page load or not

string $environment

The environment to use

Return Value

string

content to be written to the config file

at line 231
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 239
string get_task_lang_name()

Returns the language key of the name of the task

Return Value

string