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.
Properties
protected config | $config | ||
protected driver_interface | $db | ||
protected tools_interface | $db_tools | ||
protected string | $table_prefix | ||
protected string | $phpbb_root_path | ||
protected string | $php_ext | ||
protected array | $errors | ||
protected array | $queries |
Methods
Constructor
Defines other migrations to be applied first
Allows you to check if the migration is effectively installed (entirely optional)
Updates the database schema by providing a set of change instructions
Reverts the database schema by providing a set of change instructions
Updates data by returning a list of instructions to be executed
Reverts data by returning a list of instructions to be executed
Wrapper for running queries to generate user feedback on updates
Get the list of queries run
Details
at line 59
__construct(config $config, driver_interface $db, tools_interface $db_tools, string $phpbb_root_path, string $php_ext, string $table_prefix)
Constructor
at line 75
static array
depends_on()
Defines other migrations to be applied first
at line 83
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.
at line 91
array
update_schema()
Updates the database schema by providing a set of change instructions
at line 99
array
revert_schema()
Reverts the database schema by providing a set of change instructions
at line 107
array
update_data()
Updates data by returning a list of instructions to be executed
at line 115
array
revert_data()
Reverts data by returning a list of instructions to be executed
at line 126
protected mixed
sql_query(string $sql)
Wrapper for running queries to generate user feedback on updates
at line 162
array
get_queries()
Get the list of queries run