MDL-63044 block_myoverview: remove tab preference

blocks/myoverview/block_myoverview.php

@@ -50,16 +50,7 @@ public function get_content() {
             return $this->content;
         }
 
-        // Check if the tab to select wasn't passed in the URL, if so see if the user has any preference.
-        if (!$tab = optional_param('myoverviewtab', null, PARAM_ALPHA)) {
-            // Check if the user has no preference, if so get the site setting.
-            if (!$tab = get_user_preferences('block_myoverview_last_tab')) {
-                $config = get_config('block_myoverview');
-                $tab = $config->defaulttab;
-            }
-        }
-
-        $renderable = new \block_myoverview\output\main($tab);
+        $renderable = new \block_myoverview\output\main();
         $renderer = $this->page->get_renderer('block_myoverview');
 
         $this->content = new stdClass();
@@ -77,13 +68,4 @@ public function get_content() {
     public function applicable_formats() {
         return array('my' => true);
     }
-
-    /**
-     * This block does contain a configuration settings.
-     *
-     * @return boolean
-     */
-    public function has_config() {
-        return true;
-    }
 }

blocks/myoverview/classes/output/main.php

@@ -39,21 +39,6 @@
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class main implements renderable, templatable {
-
-    /**
-     * @var string The tab to display.
-     */
-    public $tab;
-
-    /**
-     * Constructor.
-     *
-     * @param string $tab The tab to display.
-     */
-    public function __construct($tab) {
-        $this->tab = $tab;
-    }
-
     /**
      * Export this data so it can be used as the context for a mustache template.
      *
@@ -88,24 +73,13 @@ public function export_for_template(renderer_base $output) {
         $nocoursesurl = $output->image_url('courses', 'block_myoverview')->out();
         $noeventsurl = $output->image_url('activities', 'block_myoverview')->out();
 
-        // Now, set the tab we are going to be viewing.
-        $viewingtimeline = false;
-        $viewingcourses = false;
-        if ($this->tab == BLOCK_MYOVERVIEW_TIMELINE_VIEW) {
-            $viewingtimeline = true;
-        } else {
-            $viewingcourses = true;
-        }
-
         return [
             'midnight' => usergetmidnight(time()),
             'coursesview' => $coursesview->export_for_template($output),
             'urls' => [
                 'nocourses' => $nocoursesurl,
                 'noevents' => $noeventsurl
             ],
-            'viewingtimeline' => $viewingtimeline,
-            'viewingcourses' => $viewingcourses
         ];
     }
 }

blocks/myoverview/classes/privacy/provider.php

@@ -32,30 +32,15 @@
  * @copyright  2018 Zig Tan <[email protected]>
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-class provider implements \core_privacy\local\metadata\provider, \core_privacy\local\request\user_preference_provider {
+class provider implements \core_privacy\local\metadata\null_provider {
 
     /**
-     * Returns meta-data information about the myoverview block.
+     * Get the language string identifier with the component's language
+     * file to explain why this plugin stores no data.
      *
-     * @param  \core_privacy\local\metadata\collection $collection A collection of meta-data.
-     * @return \core_privacy\local\metadata\collection Return the collection of meta-data.
+     * @return  string
      */
-    public static function get_metadata(\core_privacy\local\metadata\collection $collection) :
-            \core_privacy\local\metadata\collection {
-        $collection->add_user_preference('block_myoverview_last_tab', 'privacy:metadata:overviewlasttab');
-        return $collection;
-    }
-
-    /**
-     * Export all user preferences for the myoverview block
-     *
-     * @param int $userid The userid of the user whose data is to be exported.
-     */
-    public static function export_user_preferences(int $userid) {
-        $preference = get_user_preferences('block_myoverview_last_tab', null, $userid);
-        if (isset($preference)) {
-            \core_privacy\local\request\writer::export_user_preference('block_myoverview', 'block_myoverview_last_tab',
-                    $preference, get_string('privacy:metadata:overviewlasttab', 'block_myoverview'));
-        }
+    public static function get_reason() : string {
+        return 'privacy:metadata';
     }
 }

blocks/myoverview/settings.php → blocks/myoverview/db/upgrade.php

@@ -15,25 +15,27 @@
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * Settings for the overview block.
+ * This file keeps track of upgrades to the myoverview block
  *
- * @package    block_myoverview
- * @copyright  2017 Mark Nelson <markn@moodle.com>
- * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package block_myoverview
+ * @copyright 2018 Ryan Wyllie <ryan@moodle.com>
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
-defined('MOODLE_INTERNAL') || die;
+defined('MOODLE_INTERNAL') || die();
 
-require_once($CFG->dirroot . '/blocks/myoverview/lib.php');
-
-if ($ADMIN->fulltree) {
+/**
+ * Upgrade code for the myoverview block.
+ *
+ * @param int $oldversion
+ */
+function xmldb_block_myoverview_upgrade($oldversion) {
+    global $DB;
 
-    $options = [
-        BLOCK_MYOVERVIEW_TIMELINE_VIEW => get_string('timeline', 'block_myoverview'),
-        BLOCK_MYOVERVIEW_COURSES_VIEW => get_string('courses')
-    ];
+    if ($oldversion < 2018092700) {
+        $DB->delete_records('user_preferences', ['name' => 'block_myoverview_last_tab']);
+        upgrade_block_savepoint(true, 2018092700, 'myoverview');
+    }
 
-    $settings->add(new admin_setting_configselect('block_myoverview/defaulttab',
-        get_string('defaulttab', 'block_myoverview'),
-        get_string('defaulttab_desc', 'block_myoverview'), 'timeline', $options));
+    return true;
 }

blocks/myoverview/lang/en/block_myoverview.php

@@ -22,8 +22,6 @@
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
-$string['defaulttab'] = 'Default tab';
-$string['defaulttab_desc'] = 'The tab that will be displayed when a user first views their course overview. When returning to their course overview, the user\'s active tab is remembered.';
 $string['future'] = 'Future';
 $string['inprogress'] = 'In progress';
 $string['morecourses'] = 'More courses';
@@ -44,4 +42,4 @@
 $string['timeline'] = 'Timeline';
 $string['viewcourse'] = 'View course';
 $string['viewcoursename'] = 'View course {$a}';
-$string['privacy:metadata:overviewlasttab'] = 'This stores the last tab selected by the user on the overview block.';
+$string['privacy:metadata'] = 'The myoverview block does not store any personal data.';

blocks/myoverview/templates/main.mustache

@@ -47,9 +47,3 @@
         </div>
     </div>
 </div>
-{{#js}}
-require(['jquery', 'block_myoverview/tab_preferences'], function($, TabPreferences) {
-    var root = $('#block-myoverview-view-choices-{{uniqid}}');
-    TabPreferences.registerEventListeners(root);
-});
-{{/js}}

blocks/myoverview/version.php

@@ -24,6 +24,6 @@
 
 defined('MOODLE_INTERNAL') || die();
 
-$plugin->version   = 2018051400;         // The current plugin version (Date: YYYYMMDDXX).
+$plugin->version   = 2018092700;         // The current plugin version (Date: YYYYMMDDXX).
 $plugin->requires  = 2018050800;         // Requires this Moodle version.
 $plugin->component = 'block_myoverview'; // Full name of the plugin (used for diagnostics).

lib/navigationlib.php

@@ -3036,7 +3036,7 @@ protected function load_courses_enrolled() {
         // Show a link to the course page if there are more courses the user is enrolled in.
         if ($showmorelinkinnav || $showmorelinkinflatnav) {
             // Adding hash to URL so the link is not highlighted in the navigation when clicked.
-            $url = new moodle_url('/my/?myoverviewtab=courses');
+            $url = new moodle_url('/my/');
             $parent = $this->rootnodes['mycourses'];
             $coursenode = $parent->add(get_string('morenavigationlinks'), $url, self::TYPE_CUSTOM, null, self::COURSE_INDEX_PAGE);
 

message/tests/privacy_provider_test.php

@@ -146,7 +146,7 @@ public function test_export_user_preferences() {
         set_user_preference('message_provider_moodle_instantmessage_loggedoff', 'inbound', $user->id);
 
         // Set an unrelated preference.
-        set_user_preference('block_myoverview_last_tab', 'courses', $USER->id);
+        set_user_preference('some_unrelated_preference', 'courses', $USER->id);
 
         provider::export_user_preferences($USER->id);