container_aware_migration
abstract class container_aware_migration extends migration implements ContainerAwareInterface
Abstract base class for container aware database migrations.
Properties
| protected config | $config | from migration | |
| protected driver_interface | $db | from migration | |
| protected tools_interface | $db_tools | from migration | |
| protected string | $table_prefix | from migration | |
| protected string | $phpbb_root_path | from migration | |
| protected string | $php_ext | from migration | |
| protected array | $errors | from migration | |
| protected array | $queries | from migration | |
| protected ContainerInterface | $container |
Methods
Constructor
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
Wrapper for running queries to generate user feedback on updates
{@inheritdoc}
Details
in
migration at line 59
__construct(config $config, driver_interface $db, tools_interface $db_tools, string $phpbb_root_path, string $php_ext, string $table_prefix)
Constructor
in
migration at line 75
static array
depends_on()
Defines other migrations to be applied first
in
migration 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.
in
migration at line 91
array
update_schema()
Updates the database schema by providing a set of change instructions
in
migration at line 99
array
revert_schema()
Reverts the database schema by providing a set of change instructions
in
migration at line 107
array
update_data()
Updates data by returning a list of instructions to be executed
in
migration at line 115
array
revert_data()
Reverts data by returning a list of instructions to be executed
in
migration at line 126
protected mixed
sql_query(string $sql)
Wrapper for running queries to generate user feedback on updates
in
migration at line 162
array
get_queries()
Get the list of queries run
at line 32
setContainer(ContainerInterface $container = null)
{@inheritdoc}