MDL-63352 block_timeline: Persist user preference on timeline
[moodle.git] / blocks / timeline / classes / privacy / provider.php
CommitLineData
1e44de35
RW
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 * Privacy Subsystem implementation for block_timeline.
19 *
20 * @package block_timeline
21 * @copyright 2018 Ryan Wyllie <ryan@moodle.com>
22 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 */
24
25namespace block_timeline\privacy;
26
27defined('MOODLE_INTERNAL') || die();
9e95193e 28use \core_privacy\local\metadata\collection;
1e44de35
RW
29
30/**
31 * Privacy Subsystem for block_timeline.
32 *
33 * @copyright 2018 Ryan Wyllie <ryan@moodle.com>
34 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
35 */
9e95193e 36class provider implements \core_privacy\local\metadata\provider, \core_privacy\local\request\user_preference_provider {
1e44de35
RW
37
38 /**
9e95193e 39 * Returns meta-data information about the myoverview block.
1e44de35 40 *
9e95193e
P
41 * @param \core_privacy\local\metadata\collection $collection A collection of meta-data.
42 * @return \core_privacy\local\metadata\collection Return the collection of meta-data.
1e44de35 43 */
9e95193e
P
44 public static function get_metadata(collection $collection) : collection {
45 $collection->add_user_preference('block_timeline_user_sort_preference', 'privacy:metadata:timelinesortpreference');
46 $collection->add_user_preference('block_timeline_user_filter_preference', 'privacy:metadata:timelinefilterpreference');
47 return $collection;
48 }
49
50 /**
51 * Export all user preferences for the myoverview block
52 *
53 * @param int $userid The userid of the user whose data is to be exported.
54 */
55 public static function export_user_preferences(int $userid) {
56 $preference = get_user_preferences('block_timeline_user_sort_preference', null, $userid);
57 if (isset($preference)) {
58 \core_privacy\local\request\writer::export_user_preference('block_timeline', 'block_timeline_user_sort_preference',
59 get_string($preference, 'block_timeline'),
60 get_string('privacy:metadata:timelinesortpreference', 'block_timeline')
61 );
62 }
63
64 $preference = get_user_preferences('block_timeline_user_filter_preference', null, $userid);
65 if (isset($preference)) {
66 \core_privacy\local\request\writer::export_user_preference('block_timeline', 'block_timeline_user_filter_preference',
67 get_string($preference, 'block_timeline'),
68 get_string('privacy:metadata:timelinefilterpreference', 'block_timeline')
69 );
70 }
1e44de35
RW
71 }
72}