phpBB API Documentation
Class

phpbb\db\migration\tool\config_text

class config_text implements tool_interface

Migration config_text tool

Methods

__construct(db_text $config_text)

Constructor

string get_name()

Retrieve a short name used for commands in migrations.

null add(string $config_name, mixed $config_value)

Add a config_text setting.

null update(string $config_name, mixed $config_value)

Update an existing config_text setting.

null remove(string $config_name)

Remove an existing config_text setting.

null reverse()

Reverse an original install action

Details

at line 29
public __construct(db_text $config_text)

Constructor

Parameters

db_text $config_text

at line 37
public string get_name()

Retrieve a short name used for commands in migrations.

Return Value

string short name

at line 50
public null add(string $config_name, mixed $config_value)

Add a config_text setting.

Parameters

string $config_name The name of the config_text setting you would like to add
mixed $config_value The value of the config_text setting

Return Value

null

at line 69
public null update(string $config_name, mixed $config_value)

Update an existing config_text setting.

Parameters

string $config_name The name of the config_text setting you would like to update
mixed $config_value The value of the config_text setting

Return Value

null

Exceptions

exception

at line 86
public null remove(string $config_name)

Remove an existing config_text setting.

Parameters

string $config_name The name of the config_text setting you would like to remove

Return Value

null

at line 99
public null reverse()

Reverse an original install action

First argument is the original call to the class (e.g. add, remove) After the first argument, send the original arguments to the function in the original call

Return Value

null