diff --git a/blocks/myoverview/classes/output/main.php b/blocks/myoverview/classes/output/main.php index d9687ded276..96e18fbf4e1 100644 --- a/blocks/myoverview/classes/output/main.php +++ b/blocks/myoverview/classes/output/main.php @@ -121,7 +121,7 @@ class main implements renderable, templatable { * * @var boolean */ - private $displaygroupingstarred; + private $displaygroupingfavourites; /** * Store a course grouping option setting. @@ -214,7 +214,7 @@ class main implements renderable, templatable { $this->displaygroupinginprogress = $config->displaygroupinginprogress; $this->displaygroupingfuture = $config->displaygroupingfuture; $this->displaygroupingpast = $config->displaygroupingpast; - $this->displaygroupingstarred = $config->displaygroupingstarred; + $this->displaygroupingfavourites = $config->displaygroupingfavourites; $this->displaygroupinghidden = $config->displaygroupinghidden; $this->displaygroupingcustomfield = ($config->displaygroupingcustomfield && $config->customfiltergrouping); $this->customfiltergrouping = $config->customfiltergrouping; @@ -226,7 +226,7 @@ class main implements renderable, templatable { $this->displaygroupinginprogress, $this->displaygroupingfuture, $this->displaygroupingpast, - $this->displaygroupingstarred, + $this->displaygroupingfavourites, $this->displaygroupinghidden); $displaygroupingselectorscount = count(array_filter($displaygroupingselectors)); if ($displaygroupingselectorscount > 1 || $this->displaygroupingcustomfield) { @@ -259,7 +259,7 @@ class main implements renderable, templatable { if ($config->displaygroupingpast == true) { return BLOCK_MYOVERVIEW_GROUPING_PAST; } - if ($config->displaygroupingstarred == true) { + if ($config->displaygroupingfavourites == true) { return BLOCK_MYOVERVIEW_GROUPING_FAVOURITES; } if ($config->displaygroupinghidden == true) { @@ -439,7 +439,7 @@ class main implements renderable, templatable { 'displaygroupinginprogress' => $this->displaygroupinginprogress, 'displaygroupingfuture' => $this->displaygroupingfuture, 'displaygroupingpast' => $this->displaygroupingpast, - 'displaygroupingstarred' => $this->displaygroupingstarred, + 'displaygroupingfavourites' => $this->displaygroupingfavourites, 'displaygroupinghidden' => $this->displaygroupinghidden, 'displaygroupingselector' => $this->displaygroupingselector, 'displaygroupingcustomfield' => $this->displaygroupingcustomfield && $customfieldvalues, diff --git a/blocks/myoverview/db/upgrade.php b/blocks/myoverview/db/upgrade.php index fc4c890feaa..d9bccdd6f7e 100644 --- a/blocks/myoverview/db/upgrade.php +++ b/blocks/myoverview/db/upgrade.php @@ -31,7 +31,7 @@ defined('MOODLE_INTERNAL') || die(); * @param int $oldversion */ function xmldb_block_myoverview_upgrade($oldversion) { - global $DB; + global $DB, $CFG, $OUTPUT; if ($oldversion < 2019091800) { // Remove orphaned course favourites, which weren't being deleted when the course was deleted. @@ -58,5 +58,25 @@ function xmldb_block_myoverview_upgrade($oldversion) { // 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); + } + return true; } diff --git a/blocks/myoverview/lib.php b/blocks/myoverview/lib.php index 21f9b70a724..7af8cbd0644 100644 --- a/blocks/myoverview/lib.php +++ b/blocks/myoverview/lib.php @@ -148,7 +148,7 @@ function block_myoverview_user_preferences() { * @param stdClass $course The deleted course */ function block_myoverview_pre_course_delete(\stdClass $course) { - // Removing any starred courses which have been created for users, for this course. + // Removing any favourited courses which have been created for users, for this course. $service = \core_favourites\service_factory::get_service_for_component('core_course'); $service->delete_favourites_by_type_and_item('courses', $course->id); } diff --git a/blocks/myoverview/settings.php b/blocks/myoverview/settings.php index 0ec6ebea45a..c6bcdf416e0 100644 --- a/blocks/myoverview/settings.php +++ b/blocks/myoverview/settings.php @@ -110,7 +110,7 @@ if ($ADMIN->fulltree) { $settings->hide_if('block_myoverview/customfiltergrouping', 'block_myoverview/displaygroupingcustomfield'); $settings->add(new admin_setting_configcheckbox( - 'block_myoverview/displaygroupingstarred', + 'block_myoverview/displaygroupingfavourites', get_string('favourites', 'block_myoverview'), '', 1)); diff --git a/blocks/myoverview/templates/nav-grouping-selector.mustache b/blocks/myoverview/templates/nav-grouping-selector.mustache index 5d6b5983b15..ed38dc99773 100644 --- a/blocks/myoverview/templates/nav-grouping-selector.mustache +++ b/blocks/myoverview/templates/nav-grouping-selector.mustache @@ -33,7 +33,7 @@ "displaygroupinginprogress": true, "displaygroupingfuture": true, "displaygroupingpast": true, - "displaygroupingstarred": true, + "displaygroupingfavourites": true, "displaygroupinghidden": true, "displaygroupingselector": true } @@ -122,7 +122,7 @@ {{/customfieldvalues}} {{/displaygroupingcustomfield}} - {{#displaygroupingstarred}} + {{#displaygroupingfavourites}} @@ -130,7 +130,7 @@ {{#str}} favourites, block_myoverview {{/str}} - {{/displaygroupingstarred}} + {{/displaygroupingfavourites}} {{#displaygroupinghidden}}