aboutsummaryrefslogtreecommitdiffstats
path: root/phpBB/includes/db/migration.php
blob: fb030ded446a4096d3caac93841556d299e2d871 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
<?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
{
	protected $config;
	protected $db;
	protected $db_tools;
	protected $table_prefix;

	protected $phpbb_root_path;
	protected $php_ext;

	protected $errors;

	/**
	* Migration constructor
	*
	* @param \Symfony\Component\DependencyInjection\ContainerInterface	$container	Container supplying dependencies
	*/
	public function phpbb_db_migration(\Symfony\Component\DependencyInjection\ContainerInterface $container)
	{
		$this->config = $this->container->get('config');
		$this->db = $this->container->get('dbal.conn');
		$this->db_tools = $this->container->get('dbal.tools');
		$this->table_prefix = $this->container->getParameters('core.table_prefix');

		$this->phpbb_root_path = $this->container->getParameters('core.root_path');
		$this->php_ext = $this->container->getParameters('core.php_ext');

		$this->errors = array();
	}

	/**
	* Defines other migrationsto be applied first (abstract method)
	*
	* @return array An array of migration class names
	*/
	public function depends_on()
	{
		return array();
	}

	/**
	* Updates the database schema by providing a set of change instructions
	*
	* @return array
	*/
	public function update_schema()
	{
		return array();
	}

	/**
	* Updates data by returning a list of instructions to be executed
	*
	* @return array
	*/
	public function update_data()
	{
	}

	/**
	* Wrapper for running queries to generate user feedback on updates
	*/
	protected function sql_query($sql)
	{
		if (defined('DEBUG'))
		{
			echo "<br />\n{$sql}\n<br />";
		}

		$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;
	}
}