diff options
| author | David King <imkingdavid@gmail.com> | 2013-02-06 12:25:13 -0500 |
|---|---|---|
| committer | David King <imkingdavid@gmail.com> | 2013-02-06 12:25:13 -0500 |
| commit | effaef6bddf49b9016d66bd64706392fcdb452b3 (patch) | |
| tree | b2fc1cba8a269453e5a1ec7667141e69a8d34429 /phpBB/includes/db/migration/migration.php | |
| parent | 1e5a1b72dca4e0ccae9340467225499649dea6c8 (diff) | |
| parent | 77df9109b61ec93c28a8120a8d81a045961b24ac (diff) | |
| download | forums-effaef6bddf49b9016d66bd64706392fcdb452b3.tar forums-effaef6bddf49b9016d66bd64706392fcdb452b3.tar.gz forums-effaef6bddf49b9016d66bd64706392fcdb452b3.tar.bz2 forums-effaef6bddf49b9016d66bd64706392fcdb452b3.tar.xz forums-effaef6bddf49b9016d66bd64706392fcdb452b3.zip | |
Merge remote-tracking branch 'EXreaction/feature/migrations' into develop
* EXreaction/feature/migrations: (48 commits)
[feature/migrations] Remove default values from necessary parameters
[feature/migrations] Revert unrelated changes to functions.php
[ticket/9737] Fix some comments
[ticket/9737] Fix a few minor things in migrations
[feature/migrations] Make sure migration data not done before running data step
[feature/migrations] Function to populate the migrations table (for install)
[feature/migrations] Function effectively_installed() in migrations
[feature/migrations] Make load_migrations recursive (optionally)
[feature/migrations] Make the test depends_on methods static
[feature/migrations] Make depends_on static to call it without dependencies
[feature/migrations] install/database_update_migrations.php
[feature/migrations] Move test.php -> install/database_update_migrations.php
[feature/migrations] Store depends on in the database (serialized)
[feature/migrations] Revert method completed
[feature/migrations] Basic reverting test
[feature/migrations] Test for calling a step multiple times
[feature/migrations] Creating revert method to attempt reverting a migration
[feature/migrations] Some comments in db_tools
[feature/migrations] Reverse data functionality
[feature/migrations] Comment
...
Conflicts:
phpBB/install/schemas/firebird_schema.sql
phpBB/install/schemas/mssql_schema.sql
phpBB/install/schemas/mysql_40_schema.sql
phpBB/install/schemas/mysql_41_schema.sql
phpBB/install/schemas/oracle_schema.sql
phpBB/install/schemas/postgres_schema.sql
phpBB/install/schemas/sqlite_schema.sql
Diffstat (limited to 'phpBB/includes/db/migration/migration.php')
| -rw-r--r-- | phpBB/includes/db/migration/migration.php | 190 |
1 files changed, 190 insertions, 0 deletions
diff --git a/phpBB/includes/db/migration/migration.php b/phpBB/includes/db/migration/migration.php new file mode 100644 index 0000000000..5f14a6953c --- /dev/null +++ b/phpBB/includes/db/migration/migration.php @@ -0,0 +1,190 @@ +<?php +/** +* +* @package db +* @copyright (c) 2011 phpBB Group +* @license http://opensource.org/licenses/gpl-license.php GNU Public License v2 +* +*/ + +/** +* @ignore +*/ +if (!defined('IN_PHPBB')) +{ + exit; +} + +/** +* 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. +* +* @package db +*/ +abstract class phpbb_db_migration +{ + /** @var phpbb_config */ + protected $config; + + /** @var phpbb_db_driver */ + protected $db; + + /** @var phpbb_db_tools */ + protected $db_tools; + + /** @var string */ + protected $table_prefix; + + /** @var string */ + protected $phpbb_root_path; + + /** @var string */ + protected $php_ext; + + /** @var array Errors, if any occured */ + protected $errors; + + /** @var array List of queries executed through $this->sql_query() */ + protected $queries = array(); + + /** + * Constructor + * + * @param phpbb_config $config + * @param phpbb_db_driver $db + * @param phpbb_db_tools $db_tools + * @param string $phpbb_root_path + * @param string $php_ext + * @param string $table_prefix + */ + public function __construct(phpbb_config $config, phpbb_db_driver $db, phpbb_db_tools $db_tools, $phpbb_root_path, $php_ext, $table_prefix) + { + $this->config = $config; + $this->db = $db; + $this->db_tools = $db_tools; + $this->table_prefix = $table_prefix; + + $this->phpbb_root_path = $phpbb_root_path; + $this->php_ext = $php_ext; + + $this->errors = array(); + } + + /** + * Defines other migrations to be applied first + * + * @return array An array of migration class names + */ + static public function depends_on() + { + return array(); + } + + /** + * 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() + { + return false; + } + + /** + * 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() + { + return array(); + } + + /** + * 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() + { + return array(); + } + + /** + * Updates data by returning a list of instructions to be executed + * + * @return array Array of data update instructions + */ + public function update_data() + { + return array(); + } + + /** + * 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() + { + return array(); + } + + /** + * Wrapper for running queries to generate user feedback on updates + * + * @param string $sql SQL query to run on the database + * @return mixed Query result from db->sql_query() + */ + protected function sql_query($sql) + { + $this->queries[] = $sql; + + $this->db->sql_return_on_error(true); + + if ($sql === 'begin') + { + $result = $this->db->sql_transaction('begin'); + } + else if ($sql === 'commit') + { + $result = $this->db->sql_transaction('commit'); + } + else + { + $result = $this->db->sql_query($sql); + if ($this->db->sql_error_triggered) + { + $this->errors[] = array( + 'sql' => $this->db->sql_error_sql, + 'code' => $this->db->sql_error_returned, + ); + } + } + + $this->db->sql_return_on_error(false); + + return $result; + } + + /** + * Get the list of queries run + * + * @return array + */ + public function get_queries() + { + return $this->queries; + } +} |