MDL-6074 blocks: Hide user in online users block
[moodle.git] / blocks / online_users / 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_online_users.
19  *
20  * @package    block_online_users
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_online_users\privacy;
27 use core_privacy\local\metadata\collection;
28 use core_privacy\local\request\writer;
29 use core_privacy\local\request\transform;
31 defined('MOODLE_INTERNAL') || die();
33 /**
34  * Privacy Subsystem for block_online_users.
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
40         \core_privacy\local\metadata\provider,
41         \core_privacy\local\request\user_preference_provider {
43     /**
44      * Describe all the places where this plugin stores personal data.
45      *
46      * @param collection $collection Collection of items to add metadata to.
47      * @return collection Collection with our added items.
48      */
49     public static function get_metadata(collection $collection) : collection {
51         $collection->add_user_preference('block_online_users_uservisibility',
52                 'privacy:metadata:preference:uservisibility');
54         return $collection;
55     }
57     /**
58      * Export user preferences controlled by this plugin.
59      *
60      * @param int $userid ID of the user we are exporting data form.
61      */
62     public static function export_user_preferences(int $userid) {
64         $uservisibility = get_user_preferences('block_online_users_uservisibility', 1, $userid);
66         writer::export_user_preference('block_online_users',
67                 'block_online_users_uservisibility', transform::yesno($uservisibility),
68                 get_string('privacy:metadata:preference:uservisibility', 'block_online_users'));
69     }
70 }