Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.0.x will end 8 May 2023 (12 months).
  • Bug fixes for security issues in 4.0.x will end 13 November 2023 (18 months).
  • PHP version: minimum PHP 7.3.0 Note: the minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is also supported.
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/**
 * This file keeps track of upgrades to the myoverview block
 *
 * @since 3.8
 * @package block_myoverview
 * @copyright 2019 Jake Dallimore <jrhdallimore@gmail.com>
 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

defined('MOODLE_INTERNAL') || die();

> require_once("{$CFG->dirroot}/my/lib.php"); /** > require_once("{$CFG->libdir}/db/upgradelib.php"); * Upgrade code for the MyOverview block. >
* * @param int $oldversion */ function xmldb_block_myoverview_upgrade($oldversion) { global $DB, $CFG, $OUTPUT; if ($oldversion < 2019091800) { // Remove orphaned course favourites, which weren't being deleted when the course was deleted. $sql = 'SELECT f.id FROM {favourite} f LEFT JOIN {course} c ON (c.id = f.itemid) WHERE f.component = :component AND f.itemtype = :itemtype AND c.id IS NULL'; $params = ['component' => 'core_course', 'itemtype' => 'courses']; if ($records = $DB->get_fieldset_sql($sql, $params)) { $chunks = array_chunk($records, 1000); foreach ($chunks as $chunk) { list($insql, $inparams) = $DB->get_in_or_equal($chunk); $DB->delete_records_select('favourite', "id $insql", $inparams); } } upgrade_block_savepoint(true, 2019091800, 'myoverview', false); } // Automatically generated Moodle v3.8.0 release upgrade line. // Put any upgrade step following this. if ($oldversion < 2019111801) { // Renaming the setting from displaygroupingstarred to displaygroupingfavourites to match Moodle convention. // Check to see if record exists. get_config doesn't allow differentiation between not exists and false. $dbval = $DB->get_field('config_plugins', 'value', ['plugin' => 'block_myoverview', 'name' => 'displaygroupingstarred']); if ($dbval !== false) { set_config('displaygroupingfavourites', $dbval, 'block_myoverview'); unset_config('displaygroupingstarred', 'block_myoverview'); } if (isset($CFG->forced_plugin_settings['block_myoverview']['displaygroupingstarred'])) { // Check to see if the starred setting is defined in the config file. Display a warning if so. $warn = 'Setting block_myoverview->displaygroupingstarred has been renamed '. 'to block_myoverview->displaygroupingfavourites. Old setting present in config.php.'; echo $OUTPUT->notification($warn, 'notifyproblem'); } upgrade_block_savepoint(true, 2019111801, 'myoverview', false); } // Automatically generated Moodle v3.9.0 release upgrade line. // Put any upgrade step following this.
< // Automatically generated Moodle v3.10.0 release upgrade line. < // Put any upgrade step following this.
> if ($oldversion < 2021052504) { > upgrade_block_delete_instances('myoverview', '__default', 'my-index'); > > // Add new instance to the /my/courses.php page. > $subpagepattern = $DB->get_record('my_pages', [ > 'userid' => null, > 'name' => MY_PAGE_COURSES, > 'private' => MY_PAGE_PUBLIC, > ], 'id', IGNORE_MULTIPLE)->id; > > $blockname = 'myoverview'; > $pagetypepattern = 'my-index'; > > $blockparams = [ > 'blockname' => $blockname, > 'pagetypepattern' => $pagetypepattern, > 'subpagepattern' => $subpagepattern, > ]; > > // See if this block already somehow exists, it should not but who knows. > if (!$DB->record_exists('block_instances', $blockparams)) { > $page = new moodle_page(); > $page->set_context(context_system::instance()); > // Add the block to the default /my/courses. > $page->blocks->add_region('content'); > $page->blocks->add_block($blockname, 'content', 0, false, $pagetypepattern, $subpagepattern); > } > > upgrade_block_savepoint(true, 2021052504, 'myoverview', false); > } > > if ($oldversion < 2022041901) { > upgrade_block_set_my_user_parent_context('myoverview', '__default', 'my-index'); > upgrade_block_savepoint(true, 2022041901, 'myoverview', false); > }
< // Automatically generated Moodle v3.11.0 release upgrade line.
> // Automatically generated Moodle v4.0.0 release upgrade line.
// Put any upgrade step following this. return true; }