phpBB API Documentation
Class

phpbb\db\migration\migration

abstract class migration implements migration_interface

Abstract base class for database migrations

Each migration consists of a set of schema and data changes to be implemented in a subclass. This class provides various utility methods to simplify editing a phpBB.

Methods

__construct(config $config, driver_interface $db, tools_interface $db_tools, string $phpbb_root_path, string $php_ext, string $table_prefix)

Constructor
static array depends_on()

Defines other migrations to be applied first
bool effectively_installed()

Allows you to check if the migration is effectively installed (entirely optional)
array update_schema()

Updates the database schema by providing a set of change instructions
array revert_schema()

Reverts the database schema by providing a set of change instructions
array update_data()

Updates data by returning a list of instructions to be executed
array revert_data()

Reverts data by returning a list of instructions to be executed
array get_queries()

Get the list of queries run

Details

at line 59
public __construct(config $config, driver_interface $db, tools_interface $db_tools, string $phpbb_root_path, string $php_ext, string $table_prefix)

Constructor

Parameters

config $config
driver_interface $db
tools_interface $db_tools
string $phpbb_root_path
string $php_ext
string $table_prefix

at line 75
static public array depends_on()

Defines other migrations to be applied first

Return Value

array An array of migration class names

at line 83
public bool effectively_installed()

Allows you to check if the migration is effectively installed (entirely optional)

This is checked when a migration is installed. If true is returned, the migration will be set as installed without performing the database changes. This function is intended to help moving to migrations from a previous database updater, where some migrations may have been installed already even though they are not yet listed in the migrations table.

Return Value

bool True if this migration is installed, False if this migration is not installed (checked on install)

at line 91
public array update_schema()

Updates the database schema by providing a set of change instructions

Return Value

array Array of schema changes (compatible with dbtools->performschema_changes())

at line 99
public array revert_schema()

Reverts the database schema by providing a set of change instructions

Return Value

array Array of schema changes (compatible with dbtools->performschema_changes())

at line 107
public array update_data()

Updates data by returning a list of instructions to be executed

Return Value

array Array of data update instructions

at line 115
public array revert_data()

Reverts data by returning a list of instructions to be executed

Return Value

array Array of data instructions that will be performed on revert NOTE: calls to tools (such as config.add) are automatically reverted when possible, so you should not attempt to revert those, this is mostly for otherwise unrevertable calls (custom functions for example)

at line 162
public array get_queries()

Get the list of queries run

Return Value

array