diff options
| author | Nathaniel Guse <nathaniel.guse@gmail.com> | 2013-02-11 21:37:15 -0600 |
|---|---|---|
| committer | Nathaniel Guse <nathaniel.guse@gmail.com> | 2013-02-11 21:37:15 -0600 |
| commit | 54e9f7b50ab8b25f63945c6ff09cc9ffa80c04af (patch) | |
| tree | 09adec7705026866584002de8cb7f760581e876b /phpBB/includes/db/migration/migration.php | |
| parent | e4c37c159ab4eb152280dec8e46c9d98a26354a0 (diff) | |
| parent | fa33eae556c248ef6b2d41d9c9203b29e23dfb3a (diff) | |
| download | forums-54e9f7b50ab8b25f63945c6ff09cc9ffa80c04af.tar forums-54e9f7b50ab8b25f63945c6ff09cc9ffa80c04af.tar.gz forums-54e9f7b50ab8b25f63945c6ff09cc9ffa80c04af.tar.bz2 forums-54e9f7b50ab8b25f63945c6ff09cc9ffa80c04af.tar.xz forums-54e9f7b50ab8b25f63945c6ff09cc9ffa80c04af.zip | |
Merge branch 'develop' of https://github.com/phpbb/phpbb3 into ticket/11103
# By Nathan Guse (28) and others
# Via Andreas Fischer (9) and others
* 'develop' of https://github.com/phpbb/phpbb3: (90 commits)
[ticket/11350] Do not pass $db by reference; typehint phpbb_db_driver
[feature/migrations] Remove default values from necessary parameters
[ticket/11201] Revert WLM dropping because it is still used in China.
[ticket/11220] Improvement to the info pop-up from "list="
[feature/migrations] Revert unrelated changes to functions.php
[ticket/11233] prohibit selecting anonymous user as a PM recipient
[ticket/11343] Remove spare parentheses.
[ticket/11343] Remove spare space.
[ticket/11343] Use === when checking stored user_actkey against user input.
[ticket/11295] Correct cases: replace postgres with phpbb_db_driver_postgres.
[ticket/10050] removing prosilver edits
[ticket/9737] Fix some comments
[ticket/11337] Abort setup-webserver.sh script when an error occurs.
[ticket/11337] Only run functional tests on 5.3.19 or higher. No FPM otherwise.
[ticket/11337] Silence nginx config file writing.
[ticket/11337] php-fpm.conf is no longer owned by root.
[ticket/11337] Run functional tests on travis using nginx and php-fpm.
[ticket/11338] Travis CI: Install PHP extension for redis key-value store.
[ticket/10050] adding .topicrow to template condition
[ticket/9737] Fix a few minor things in migrations
...
Conflicts:
phpBB/config/services.yml
phpBB/config/tables.yml
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; + } +} |