MDL-63352 block_timeline: Persist user preference on timeline
[moodle.git] / blocks / timeline / classes / privacy / provider.php
index 02ae526..3be0998 100644 (file)
@@ -25,6 +25,7 @@
 namespace block_timeline\privacy;
 
 defined('MOODLE_INTERNAL') || die();
+use \core_privacy\local\metadata\collection;
 
 /**
  * Privacy Subsystem for block_timeline.
@@ -32,15 +33,40 @@ defined('MOODLE_INTERNAL') || die();
  * @copyright  2018 Ryan Wyllie <ryan@moodle.com>
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-class provider implements \core_privacy\local\metadata\null_provider {
+class provider implements \core_privacy\local\metadata\provider, \core_privacy\local\request\user_preference_provider {
 
     /**
-     * Get the language string identifier with the component's language
-     * file to explain why this plugin stores no data.
+     * Returns meta-data information about the myoverview block.
      *
-     * @return  string
+     * @param  \core_privacy\local\metadata\collection $collection A collection of meta-data.
+     * @return \core_privacy\local\metadata\collection Return the collection of meta-data.
      */
-    public static function get_reason() : string {
-        return 'privacy:metadata';
+    public static function get_metadata(collection $collection) : collection {
+        $collection->add_user_preference('block_timeline_user_sort_preference', 'privacy:metadata:timelinesortpreference');
+        $collection->add_user_preference('block_timeline_user_filter_preference', 'privacy:metadata:timelinefilterpreference');
+        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_timeline_user_sort_preference', null, $userid);
+        if (isset($preference)) {
+            \core_privacy\local\request\writer::export_user_preference('block_timeline', 'block_timeline_user_sort_preference',
+                    get_string($preference, 'block_timeline'),
+                    get_string('privacy:metadata:timelinesortpreference', 'block_timeline')
+            );
+        }
+
+        $preference = get_user_preferences('block_timeline_user_filter_preference', null, $userid);
+        if (isset($preference)) {
+            \core_privacy\local\request\writer::export_user_preference('block_timeline', 'block_timeline_user_filter_preference',
+                    get_string($preference, 'block_timeline'),
+                    get_string('privacy:metadata:timelinefilterpreference', 'block_timeline')
+            );
+        }
     }
 }