diff options
Diffstat (limited to 'Moodle/mod/print/db/upgrade.php')
| -rwxr-xr-x | Moodle/mod/print/db/upgrade.php | 134 |
1 files changed, 134 insertions, 0 deletions
diff --git a/Moodle/mod/print/db/upgrade.php b/Moodle/mod/print/db/upgrade.php new file mode 100755 index 0000000..632c262 --- /dev/null +++ b/Moodle/mod/print/db/upgrade.php @@ -0,0 +1,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; +} + +?> |