Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.3.x will end 7 October 2024 (12 months).
  • Bug fixes for security issues in 4.3.x will end 21 April 2025 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.2.x is supported too.

Differences Between: [Versions 310 and 403] [Versions 311 and 403] [Versions 39 and 403] [Versions 400 and 403] [Versions 401 and 403] [Versions 402 and 403]

   1  <?php
   2  // This file is part of Moodle - http://moodle.org/
   3  //
   4  // Moodle is free software: you can redistribute it and/or modify
   5  // it under the terms of the GNU General Public License as published by
   6  // the Free Software Foundation, either version 3 of the License, or
   7  // (at your option) any later version.
   8  //
   9  // Moodle is distributed in the hope that it will be useful,
  10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  // GNU General Public License for more details.
  13  //
  14  // You should have received a copy of the GNU General Public License
  15  // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16  
  17  /**
  18   * tool_dataprivacy plugin upgrade code
  19   *
  20   * @package    tool_dataprivacy
  21   * @copyright  2018 Jun Pataleta
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  defined('MOODLE_INTERNAL') || die();
  26  
  27  /**
  28   * Function to upgrade tool_dataprivacy.
  29   *
  30   * @param int $oldversion the version we are upgrading from
  31   * @return bool result
  32   */
  33  function xmldb_tool_dataprivacy_upgrade($oldversion) {
  34      global $CFG, $DB;
  35  
  36      $dbman = $DB->get_manager();
  37  
  38      // Automatically generated Moodle v3.9.0 release upgrade line.
  39      // Put any upgrade step following this.
  40  
  41      if ($oldversion < 2020061501) {
  42  
  43          // Define field commentsformat to be added to tool_dataprivacy_request.
  44          $table = new xmldb_table('tool_dataprivacy_request');
  45          $field = new xmldb_field('commentsformat', XMLDB_TYPE_INTEGER, '2', null, XMLDB_NOTNULL, null, '0', 'comments');
  46  
  47          // Conditionally launch add field commentsformat.
  48          if (!$dbman->field_exists($table, $field)) {
  49              $dbman->add_field($table, $field);
  50          }
  51  
  52          // Define field dpocommentformat to be added to tool_dataprivacy_request.
  53          $field = new xmldb_field('dpocommentformat', XMLDB_TYPE_INTEGER, '2', null, XMLDB_NOTNULL, null, '0', 'dpocomment');
  54  
  55          // Conditionally launch add field dpocommentformat.
  56          if (!$dbman->field_exists($table, $field)) {
  57              $dbman->add_field($table, $field);
  58          }
  59  
  60          // Define field systemapproved to be added to tool_dataprivacy_request.
  61          $field = new xmldb_field('systemapproved', XMLDB_TYPE_INTEGER, '4', null, XMLDB_NOTNULL, null, '0', 'dpocommentformat');
  62  
  63          // Conditionally launch add field systemapproved.
  64          if (!$dbman->field_exists($table, $field)) {
  65              $dbman->add_field($table, $field);
  66          }
  67  
  68          // Dataprivacy savepoint reached.
  69          upgrade_plugin_savepoint(true, 2020061501, 'tool', 'dataprivacy');
  70      }
  71  
  72      // Automatically generated Moodle v4.0.0 release upgrade line.
  73      // Put any upgrade step following this.
  74      if ($oldversion < 2022053000) {
  75  
  76          // Define key usermodified (foreign) to be added to tool_dataprivacy_purposerole.
  77          $table = new xmldb_table('tool_dataprivacy_purposerole');
  78          $key = new xmldb_key('usermodified', XMLDB_KEY_FOREIGN, ['usermodified'], 'user', ['id']);
  79  
  80          // Launch add key usermodified.
  81          $dbman->add_key($table, $key);
  82  
  83          // Dataprivacy savepoint reached.
  84          upgrade_plugin_savepoint(true, 2022053000, 'tool', 'dataprivacy');
  85      }
  86  
  87      // Automatically generated Moodle v4.1.0 release upgrade line.
  88      // Put any upgrade step following this.
  89  
  90      // Automatically generated Moodle v4.2.0 release upgrade line.
  91      // Put any upgrade step following this.
  92  
  93      if ($oldversion < 2023062700) {
  94  
  95          // Define table tool_dataprivacy_contextlist to be created.
  96          $table = new xmldb_table('tool_dataprivacy_contextlist');
  97  
  98          // Adding fields to table tool_dataprivacy_contextlist.
  99          $table->add_field('id', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
 100          $table->add_field('component', XMLDB_TYPE_CHAR, '255', null, XMLDB_NOTNULL, null, null);
 101          $table->add_field('timecreated', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, '0');
 102          $table->add_field('timemodified', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, '0');
 103  
 104          // Adding keys to table tool_dataprivacy_contextlist.
 105          $table->add_key('primary', XMLDB_KEY_PRIMARY, ['id']);
 106  
 107          // Conditionally launch create table for tool_dataprivacy_contextlist.
 108          if (!$dbman->table_exists($table)) {
 109              $dbman->create_table($table);
 110          }
 111  
 112          // Define table tool_dataprivacy_ctxlst_ctx to be created.
 113          $table = new xmldb_table('tool_dataprivacy_ctxlst_ctx');
 114  
 115          // Adding fields to table tool_dataprivacy_ctxlst_ctx.
 116          $table->add_field('id', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
 117          $table->add_field('contextid', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, null);
 118          $table->add_field('contextlistid', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, null);
 119          $table->add_field('status', XMLDB_TYPE_INTEGER, '2', null, XMLDB_NOTNULL, null, '0');
 120          $table->add_field('timecreated', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, '0');
 121          $table->add_field('timemodified', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, '0');
 122  
 123          // Adding keys to table tool_dataprivacy_ctxlst_ctx.
 124          $table->add_key('primary', XMLDB_KEY_PRIMARY, ['id']);
 125          $table->add_key('contextlistid', XMLDB_KEY_FOREIGN, ['contextlistid'], 'tool_dataprivacy_contextlist', ['id']);
 126  
 127          // Conditionally launch create table for tool_dataprivacy_ctxlst_ctx.
 128          if (!$dbman->table_exists($table)) {
 129              $dbman->create_table($table);
 130          }
 131  
 132          // Define table tool_dataprivacy_rqst_ctxlst to be created.
 133          $table = new xmldb_table('tool_dataprivacy_rqst_ctxlst');
 134  
 135          // Adding fields to table tool_dataprivacy_rqst_ctxlst.
 136          $table->add_field('id', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
 137          $table->add_field('requestid', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, null);
 138          $table->add_field('contextlistid', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, null);
 139  
 140          // Adding keys to table tool_dataprivacy_rqst_ctxlst.
 141          $table->add_key('primary', XMLDB_KEY_PRIMARY, ['id']);
 142          $table->add_key('requestid', XMLDB_KEY_FOREIGN, ['requestid'], 'tool_dataprivacy_request', ['id']);
 143          $table->add_key('contextlistid', XMLDB_KEY_FOREIGN, ['contextlistid'], 'tool_dataprivacy_contextlist', ['id']);
 144          $table->add_key('requestidcontextlistid', XMLDB_KEY_UNIQUE, ['requestid', 'contextlistid']);
 145  
 146          // Conditionally launch create table for tool_dataprivacy_rqst_ctxlst.
 147          if (!$dbman->table_exists($table)) {
 148              $dbman->create_table($table);
 149          }
 150  
 151          // Dataprivacy savepoint reached.
 152          upgrade_plugin_savepoint(true, 2023062700, 'tool', 'dataprivacy');
 153      }
 154  
 155      // Automatically generated Moodle v4.3.0 release upgrade line.
 156      // Put any upgrade step following this.
 157  
 158      return true;
 159  }