course/format/topics/db/upgrade.php

   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 scripts for Topics course format.
  19  *
  20  * @package    format_topics
  21  * @copyright  2017 Marina Glancy
  22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23  */
  24
  25 /**
  26  * Upgrade script for Topics course format.
  27  *
  28  * @param int|float $oldversion the version we are upgrading from
  29  * @return bool result
  30  */
  31 function xmldb_format_topics_upgrade($oldversion) {
  32     global $DB;
  33
  34     // Automatically generated Moodle v4.1.0 release upgrade line.
  35     // Put any upgrade step following this.
  36
  37     if ($oldversion < 2023030700) {
  38         // For sites migrating from 4.0.x or 4.1.x where the indentation was removed,
  39         // we are disabling 'indentation' value by default.
  40         if ($oldversion >= 2022041900) {
  41             set_config('indentation', 0, 'format_topics');
  42         } else {
  43             set_config('indentation', 1, 'format_topics');
  44         }
  45         upgrade_plugin_savepoint(true, 2023030700, 'format', 'topics');
  46     }
  47
  48     // Automatically generated Moodle v4.2.0 release upgrade line.
  49     // Put any upgrade step following this.
  50
  51     // Automatically generated Moodle v4.3.0 release upgrade line.
  52     // Put any upgrade step following this.
  53
  54     if ($oldversion < 2023100901) {
  55         // During the migration to version 4.4, ensure that sections with null names are renamed to their corresponding
  56         // previous 'Topic X' for continuity.
  57         $newsectionname = $DB->sql_concat("'Topic '", 'section');
  58         $sql = <<<EOF
  59                     UPDATE {course_sections}
  60                        SET name = $newsectionname
  61                      WHERE section > 0 AND (name IS NULL OR name = '')
  62                            AND course IN (SELECT id FROM {course} WHERE format = 'topics')
  63         EOF;
  64         $DB->execute(
  65             sql: $sql,
  66         );
  67
  68         // Main savepoint reached.
  69         upgrade_plugin_savepoint(true, 2023100901, 'format', 'topics');
  70     }
  71
  72     // Automatically generated Moodle v4.4.0 release upgrade line.
  73     // Put any upgrade step following this.
  74
  75     return true;
  76 }