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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
|
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* This file keeps track of upgrades to the sqlbox module
*
* Sometimes, changes between versions involve alterations to database
* structures and other major things that may break installations. The upgrade
* function in this file will attempt to perform all the necessary actions to
* upgrade your older installation to the current version. If there's something
* it cannot do itself, it will tell you what you need to do. The commands in
* here will all be database-neutral, using the functions defined in DLL libraries.
*
* @package mod
* @subpackage sqlbox
* @copyright 2012 Jan Klemkow, Benjamin Franzke
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
/**
* Execute sqlbox upgrade from the given old version
*
* @param int $oldversion
* @return bool
*/
function xmldb_sqlbox_upgrade($oldversion) {
global $DB;
$dbman = $DB->get_manager(); // loads ddl manager and xmldb classes
// And upgrade begins here. For each one, you'll need one
// block of code similar to the next one. Please, delete
// this comment lines once this file start handling proper
// upgrade code.
// if ($oldversion < YYYYMMDD00) { //New version in version.php
//
// }
// Lines below (this included) MUST BE DELETED once you get the first version
// of your module ready to be installed. They are here only
// for demonstrative purposes and to show how the sqlbox
// iself has been upgraded.
// For each upgrade block, the file sqlbox/version.php
// needs to be updated . Such change allows Moodle to know
// that this file has to be processed.
// To know more about how to write correct DB upgrade scripts it's
// highly recommended to read information available at:
// http://docs.moodle.org/en/Development:XMLDB_Documentation
// and to play with the XMLDB Editor (in the admin menu) and its
// PHP generation posibilities.
if ($oldversion < 2013012402) {
$table = new xmldb_table('sqlbox_solutions');
$field = new xmldb_field('correct', XMLDB_TYPE_INTEGER, '1', null, null, null, null, 'query');
if (!$dbman->field_exists($table, $field)) {
$dbman->add_field($table, $field);
}
upgrade_mod_savepoint(true, 2013012402, 'sqlbox');
}
if ($oldversion < 2013012401) {
$table = new xmldb_table('sqlbox_solutions');
$fieldold = new xmldb_field('correct');
if ($dbman->field_exists($table, $fieldold)) {
$dbman->drop_field($table, $fieldold);
}
// sqlbox savepoint reached
upgrade_mod_savepoint(true, 2013012401, 'sqlbox');
}
if ($oldversion < 2013012400) {
// Define table sqlbox_solutions to be created
$table = new xmldb_table('sqlbox_solutions');
// Adding fields to table sqlbox_solutions
$table->add_field('id', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
$table->add_field('sqlboxid', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, '0');
$table->add_field('userid', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, '0');
$table->add_field('query', XMLDB_TYPE_TEXT, null, null, XMLDB_NOTNULL, null, null);
$table->add_field('correct', XMLDB_TYPE_BINARY, null, null, null, null, null);
// Adding keys to table sqlbox_solutions
$table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
$table->add_key('sqlboxid', XMLDB_KEY_FOREIGN, array('sqlboxid'), 'sqlbox', array('id'));
// Adding indexes to table sqlbox_solutions
$table->add_index('userid', XMLDB_INDEX_NOTUNIQUE, array('userid'));
// Conditionally launch create table for sqlbox_solutions
if (!$dbman->table_exists($table)) {
$dbman->create_table($table);
}
// sqlbox savepoint reached
upgrade_mod_savepoint(true, 2013012400, 'sqlbox');
}
if ($oldversion < 20121223) {
// Define field query to be added to sqlbox
$table = new xmldb_table('sqlbox');
$field = new xmldb_field('query', XMLDB_TYPE_TEXT, 'medium',
null, null, null, null, 'query');
// Add field query
if (!$dbman->field_exists($table, $field)) {
$dbman->add_field($table, $field);
}
}
// First example, some fields were added to install.xml on 2007/04/01
if ($oldversion < 2007040100) {
// Define field course to be added to sqlbox
$table = new xmldb_table('sqlbox');
$field = new xmldb_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0', 'id');
// Add field course
if (!$dbman->field_exists($table, $field)) {
$dbman->add_field($table, $field);
}
// Define field intro to be added to sqlbox
$table = new xmldb_table('sqlbox');
$field = new xmldb_field('intro', XMLDB_TYPE_TEXT, 'medium', null, null, null, null,'name');
// Add field intro
if (!$dbman->field_exists($table, $field)) {
$dbman->add_field($table, $field);
}
// Define field introformat to be added to sqlbox
$table = new xmldb_table('sqlbox');
$field = new xmldb_field('introformat', XMLDB_TYPE_INTEGER, '4', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0',
'intro');
// Add field introformat
if (!$dbman->field_exists($table, $field)) {
$dbman->add_field($table, $field);
}
// Once we reach this point, we can store the new version and consider the module
// upgraded to the version 2007040100 so the next time this block is skipped
upgrade_mod_savepoint(true, 2007040100, 'sqlbox');
}
// Second example, some hours later, the same day 2007/04/01
// two more fields and one index were added to install.xml (note the micro increment
// "01" in the last two digits of the version
if ($oldversion < 2007040101) {
// Define field timecreated to be added to sqlbox
$table = new xmldb_table('sqlbox');
$field = new xmldb_field('timecreated', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0',
'introformat');
// Add field timecreated
if (!$dbman->field_exists($table, $field)) {
$dbman->add_field($table, $field);
}
// Define field timemodified to be added to sqlbox
$table = new xmldb_table('sqlbox');
$field = new xmldb_field('timemodified', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0',
'timecreated');
// Add field timemodified
if (!$dbman->field_exists($table, $field)) {
$dbman->add_field($table, $field);
}
// Define index course (not unique) to be added to sqlbox
$table = new xmldb_table('sqlbox');
$index = new xmldb_index('courseindex', XMLDB_INDEX_NOTUNIQUE, array('course'));
// Add index to course field
if (!$dbman->index_exists($table, $index)) {
$dbman->add_index($table, $index);
}
// Another save point reached
upgrade_mod_savepoint(true, 2007040101, 'sqlbox');
}
// Third example, the next day, 2007/04/02 (with the trailing 00), some actions were performed to install.php,
// related with the module
if ($oldversion < 2007040200) {
// insert here code to perform some actions (same as in install.php)
upgrade_mod_savepoint(true, 2007040200, 'sqlbox');
}
// And that's all. Please, examine and understand the 3 example blocks above. Also
// it's interesting to look how other modules are using this script. Remember that
// the basic idea is to have "blocks" of code (each one being executed only once,
// when the module version (version.php) is updated.
// Lines above (this included) MUST BE DELETED once you get the first version of
// yout module working. Each time you need to modify something in the module (DB
// related, you'll raise the version and add one upgrade block here.
// Final return of upgrade result (true, all went good) to Moodle.
return true;
}
|
