diff options
| author | Marc Alexander <admin@m-a-styles.de> | 2016-01-18 14:54:54 +0100 |
|---|---|---|
| committer | Marc Alexander <admin@m-a-styles.de> | 2016-01-18 14:54:54 +0100 |
| commit | e954b0b82b9fe873211bdd8885aefb78284f0893 (patch) | |
| tree | 3d0a3a93e534f80b0753f1b693ba14f666d85ef5 /phpBB/phpbb/db/migration/migration_interface.php | |
| parent | b90852485335455a3eda0e7193b40b1364156b27 (diff) | |
| download | forums-e954b0b82b9fe873211bdd8885aefb78284f0893.tar forums-e954b0b82b9fe873211bdd8885aefb78284f0893.tar.gz forums-e954b0b82b9fe873211bdd8885aefb78284f0893.tar.bz2 forums-e954b0b82b9fe873211bdd8885aefb78284f0893.tar.xz forums-e954b0b82b9fe873211bdd8885aefb78284f0893.zip | |
[ticket/13733] Use interface for migratinos
PHPBB3-13733
Diffstat (limited to 'phpBB/phpbb/db/migration/migration_interface.php')
| -rw-r--r-- | phpBB/phpbb/db/migration/migration_interface.php | 70 |
1 files changed, 70 insertions, 0 deletions
diff --git a/phpBB/phpbb/db/migration/migration_interface.php b/phpBB/phpbb/db/migration/migration_interface.php new file mode 100644 index 0000000000..2aba5ec608 --- /dev/null +++ b/phpBB/phpbb/db/migration/migration_interface.php @@ -0,0 +1,70 @@ +<?php +/** + * + * This file is part of the phpBB Forum Software package. + * + * @copyright (c) phpBB Limited <https://www.phpbb.com> + * @license GNU General Public License, version 2 (GPL-2.0) + * + * For full copyright and license information, please see + * the docs/CREDITS.txt file. + * + */ + +namespace phpbb\db\migration; + +/** + * Base class interface for database migrations + */ +interface migration_interface +{ + /** + * Defines other migrations to be applied first + * + * @return array An array of migration class names + */ + static public function depends_on(); + + /** + * 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 bool True if this migration is installed, False if this migration is not installed (checked on install) + */ + public function effectively_installed(); + + /** + * Updates the database schema by providing a set of change instructions + * + * @return array Array of schema changes (compatible with db_tools->perform_schema_changes()) + */ + public function update_schema(); + + /** + * Reverts the database schema by providing a set of change instructions + * + * @return array Array of schema changes (compatible with db_tools->perform_schema_changes()) + */ + public function revert_schema(); + + /** + * Updates data by returning a list of instructions to be executed + * + * @return array Array of data update instructions + */ + public function update_data(); + + /** + * Reverts data by returning a list of instructions to be executed + * + * @return 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) + */ + public function revert_data(); +} |