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
|
<?php //$Id: upgrade.php,v 1.2 2007/08/08 22:36:54 stronk7 Exp $
// This file keeps track of upgrades to
// the print 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 installtion 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 lib/ddllib.php
function xmldb_print_upgrade($oldversion=0) {
global $CFG, $THEME, $db;
$result = true;
/// 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 ($result && $oldversion < YYYYMMDD00) { //New version in version.php
/// $result = result of "/lib/ddllib.php" function calls
/// }
/// 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 print
/// iself has been upgraded.
/// For each upgrade block, the file print/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.
/// First example, some fields were added to the module on 20070400
if ($result && $oldversion < 2007040100) {
/// Define field course to be added to print
$table = new XMLDBTable('print');
$field = new XMLDBField('course');
$field->setAttributes(XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, null, null, '0', 'id');
/// Launch add field course
$result = $result && add_field($table, $field);
/// Define field intro to be added to print
$table = new XMLDBTable('print');
$field = new XMLDBField('intro');
$field->setAttributes(XMLDB_TYPE_TEXT, 'medium', null, null, null, null, null, null, 'name');
/// Launch add field intro
$result = $result && add_field($table, $field);
/// Define field introformat to be added to print
$table = new XMLDBTable('print');
$field = new XMLDBField('introformat');
$field->setAttributes(XMLDB_TYPE_INTEGER, '4', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, null, null, '0', 'intro');
/// Launch add field introformat
$result = $result && add_field($table, $field);
}
/// Second example, some hours later, the same day 20070401
/// two more fields and one index were added (note the increment
/// "01" in the last two digits of the version
if ($result && $oldversion < 2007040101) {
/// Define field timecreated to be added to print
$table = new XMLDBTable('print');
$field = new XMLDBField('timecreated');
$field->setAttributes(XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, null, null, '0', 'introformat');
/// Launch add field timecreated
$result = $result && add_field($table, $field);
/// Define field timemodified to be added to print
$table = new XMLDBTable('print');
$field = new XMLDBField('timemodified');
$field->setAttributes(XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, null, null, '0', 'timecreated');
/// Launch add field timemodified
$result = $result && add_field($table, $field);
/// Define index course (not unique) to be added to print
$table = new XMLDBTable('print');
$index = new XMLDBIndex('course');
$index->setAttributes(XMLDB_INDEX_NOTUNIQUE, array('course'));
/// Launch add index course
$result = $result && add_index($table, $index);
}
/// Third example, the next day, 20070402 (with the trailing 00), some inserts were performed, related with the module
if ($result && $oldversion < 2007040200) {
/// Add some actions to get them properly displayed in the logs
$rec = new stdClass;
$rec->module = 'print';
$rec->action = 'add';
$rec->mtable = 'print';
$rec->filed = 'name';
/// Insert the add action in log_display
$result = insert_record('log_display', $rec);
/// Now the update action
$rec->action = 'update';
$result = insert_record('log_display', $rec);
/// Now the view action
$rec->action = 'view';
$result = insert_record('log_display', $rec);
}
/// 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/false) to Moodle. Must be
/// always the last line in the script
return $result;
}
?>
|
