[Summary view]

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

   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   * Upgrade code for install
  19   *
  20   * @package   tool_usertours
  21   * @copyright 2016 Ryan Wyllie <ryan@moodle.com>
  22   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  defined('MOODLE_INTERNAL') || die();
  26  
  27  use tool_usertours\manager;
  28  use tool_usertours\tour;
  29  
  30  /**
  31   * Upgrade the user tours plugin.
  32   *
  33   * @param int $oldversion The old version of the user tours plugin
  34   * @return bool
  35   */
  36  function xmldb_tool_usertours_upgrade($oldversion) {
  37      global $CFG, $DB;
  38  
  39      // Automatically generated Moodle v3.6.0 release upgrade line.
  40      // Put any upgrade step following this.
  41  
  42      // Automatically generated Moodle v3.7.0 release upgrade line.
  43      // Put any upgrade step following this.
  44  
  45      // Automatically generated Moodle v3.8.0 release upgrade line.
  46      // Put any upgrade step following this.
  47  
  48      if ($oldversion < 2020061501) {
  49          // Updating shipped tours will fix broken sortorder records in existing tours.
  50          manager::update_shipped_tours();
  51  
  52          upgrade_plugin_savepoint(true, 2020061501, 'tool', 'usertours');
  53      }
  54  
  55      // Automatically generated Moodle v3.9.0 release upgrade line.
  56      // Put any upgrade step following this.
  57  
  58      if ($oldversion < 2020082700) {
  59          // Clean up user preferences of deleted tours.
  60          $select = $DB->sql_like('name', ':lastcompleted') . ' OR ' . $DB->sql_like('name', ':requested');
  61          $params = [
  62              'lastcompleted' => tour::TOUR_LAST_COMPLETED_BY_USER . '%',
  63              'requested' => tour::TOUR_REQUESTED_BY_USER . '%',
  64          ];
  65  
  66          $preferences = $DB->get_records_select('user_preferences', $select, $params, '', 'DISTINCT name');
  67          foreach ($preferences as $preference) {
  68              // Match tour ID at the end of the preference name, remove all of that preference type if tour ID doesn't exist.
  69              if (preg_match('/(?<tourid>\d+)$/', $preference->name, $matches) &&
  70                      !$DB->record_exists('tool_usertours_tours', ['id' => $matches['tourid']])) {
  71  
  72                  $DB->delete_records('user_preferences', ['name' => $preference->name]);
  73              }
  74          }
  75  
  76          upgrade_plugin_savepoint(true, 2020082700, 'tool', 'usertours');
  77      }
  78  
  79      // Automatically generated Moodle v3.10.0 release upgrade line.
  80      // Put any upgrade step following this.
  81  
  82      if ($oldversion < 2021051700) {
  83          // Updating shipped tours.
  84          manager::update_shipped_tours();
  85  
  86          upgrade_plugin_savepoint(true, 2021051700, 'tool', 'usertours');
  87      }
  88  
  89      // Automatically generated Moodle v3.11.0 release upgrade line.
  90      // Put any upgrade step following this.
  91  
  92      return true;
  93  }