Merge branch 'wip-MDL-61966-master' of git://github.com/abgreeve/moodle
[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 defined('MOODLE_INTERNAL') || die();
29 /**
30  * Privacy Subsystem for block_myoverview.
31  *
32  * @copyright  2018 Zig Tan <zig@moodle.com>
33  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
34  */
35 class provider implements \core_privacy\local\metadata\provider, \core_privacy\local\request\user_preference_provider {
37     /**
38      * Returns meta-data information about the myoverview block.
39      *
40      * @param  \core_privacy\local\metadata\collection $collection A collection of meta-data.
41      * @return \core_privacy\local\metadata\collection Return the collection of meta-data.
42      */
43     public static function get_metadata(\core_privacy\local\metadata\collection $collection) :
44             \core_privacy\local\metadata\collection {
45         $collection->add_user_preference('block_myoverview_last_tab', 'privacy:metadata:overviewlasttab');
46         return $collection;
47     }
49     /**
50      * Export all user preferences for the myoverview block
51      *
52      * @param int $userid The userid of the user whose data is to be exported.
53      */
54     public static function export_user_preferences(int $userid) {
55         $preference = get_user_preferences('block_myoverview_last_tab', null, $userid);
56         if (isset($preference)) {
57             \core_privacy\local\request\writer::export_user_preference('block_myoverview', 'block_myoverview_last_tab',
58                     $preference, get_string('privacy:metadata:overviewlasttab', 'block_myoverview'));
59         }
60     }
61 }