be95345fc4f0395b2f21dfd535f4768be7e8dd5b
[moodle.git] / blocks / myoverview / classes / privacy / provider.php
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/>.
17 /**
18  * Privacy Subsystem implementation for block_myoverview.
19  *
20  * @package    block_myoverview
21  * @copyright  2018 Zig Tan <zig@moodle.com>
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 namespace block_myoverview\privacy;
27 use core_privacy\local\request\user_preference_provider;
28 use core_privacy\local\metadata\collection;
29 use \core_privacy\local\request\writer;
31 defined('MOODLE_INTERNAL') || die();
33 /**
34  * Privacy Subsystem for block_myoverview.
35  *
36  * @copyright  2018 Zig Tan <zig@moodle.com>
37  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
38  */
39 class provider implements \core_privacy\local\metadata\provider, user_preference_provider {
41     /**
42      * Returns meta-data information about the myoverview block.
43      *
44      * @param  \core_privacy\local\metadata\collection $collection A collection of meta-data.
45      * @return \core_privacy\local\metadata\collection Return the collection of meta-data.
46      */
47     public static function get_metadata(collection $collection) : collection {
48         $collection->add_user_preference('block_myoverview_user_sort_preference', 'privacy:metadata:overviewsortpreference');
49         $collection->add_user_preference('block_myoverview_user_view_preference', 'privacy:metadata:overviewviewpreference');
50         $collection->add_user_preference('block_myoverview_user_grouping_preference',
51             'privacy:metadata:overviewgroupingpreference');
52         return $collection;
53     }
54     /**
55      * Export all user preferences for the myoverview block
56      *
57      * @param int $userid The userid of the user whose data is to be exported.
58      */
59     public static function export_user_preferences(int $userid) {
60         $preference = get_user_preferences('block_myoverview_user_sort_preference', null, $userid);
61         if (isset($preference)) {
62             writer::export_user_preference('block_myoverview',
63                 'block_myoverview_user_sort_preference', get_string($preference, 'block_myoverview'),
64                 get_string('privacy:metadata:overviewsortpreference', 'block_myoverview'));
65         }
67         $preference = get_user_preferences('block_myoverview_user_view_preference', null, $userid);
68         if (isset($preference)) {
69             writer::export_user_preference('block_myoverview',
70                 'block_myoverview_user_view_preference',
71                 get_string($preference, 'block_myoverview'),
72                 get_string('privacy:metadata:overviewviewpreference', 'block_myoverview'));
73         }
75         $preference = get_user_preferences('block_myoverview_user_grouping_preference', null, $userid);
76         if (isset($preference)) {
77             writer::export_user_preference('block_myoverview',
78                 'block_myoverview_user_grouping_preference',
79                 get_string($preference, 'block_myoverview'),
80                 get_string('privacy:metadata:overviewgroupingpreference', 'block_myoverview'));
81         }
83         $preferences = get_user_preferences(null, null, $userid);
84         foreach ($preferences as $name => $value) {
85             if ((substr($name, 0, 30) == 'block_myoverview_hidden_course')) {
86                 writer::export_user_preference(
87                     'block_myoverview',
88                     $name,
89                     $value,
90                     get_string('privacy:request:preference:set', 'block_myoverview', (object) [
91                         'name' => $name,
92                         'value' => $value,
93                     ])
94                 );
95             }
96         }
97     }
98 }