MDL-63538 repository_boxnet: Add support for removal of context users
[moodle.git] / repository / boxnet / classes / privacy / provider.php
CommitLineData
435e4e2a
ZT
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 repository_boxnet.
19 *
20 * @package repository_boxnet
21 * @copyright 2018 Zig Tan <zig@moodle.com>
22 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 */
24
25namespace repository_boxnet\privacy;
26
27use core_privacy\local\metadata\collection;
28use core_privacy\local\request\approved_contextlist;
2d15655c 29use core_privacy\local\request\approved_userlist;
435e4e2a
ZT
30use core_privacy\local\request\context;
31use core_privacy\local\request\contextlist;
2d15655c 32use core_privacy\local\request\userlist;
435e4e2a
ZT
33
34defined('MOODLE_INTERNAL') || die();
35
36/**
37 * Privacy Subsystem for repository_boxnet implementing metadata and plugin providers.
38 *
39 * @copyright 2018 Zig Tan <zig@moodle.com>
40 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
41 */
2d15655c
MH
42class provider implements
43 \core_privacy\local\metadata\provider,
44 \core_privacy\local\request\core_userlist_provider,
45 \core_privacy\local\request\plugin\provider {
435e4e2a
ZT
46
47 /**
48 * Returns meta data about this system.
49 *
50 * @param collection $collection The initialised collection to add items to.
51 * @return collection A listing of user data stored through this system.
52 */
53 public static function get_metadata(collection $collection) : collection {
54 $collection->add_external_location_link(
55 'box.com',
56 [
57 'query' => 'privacy:metadata:repository_boxnet:query'
58 ],
59 'privacy:metadata:repository_boxnet'
60 );
61
62 return $collection;
63 }
64
65 /**
66 * Get the list of contexts that contain user information for the specified user.
67 *
68 * @param int $userid The user to search.
69 * @return contextlist $contextlist The contextlist containing the list of contexts used in this plugin.
70 */
71 public static function get_contexts_for_userid(int $userid) : contextlist {
72 return new contextlist();
73 }
74
2d15655c
MH
75 /**
76 * Get the list of users who have data within a context.
77 *
78 * @param userlist $userlist The userlist containing the list of users who have data in this context/plugin combination.
79 */
80 public static function get_users_in_context(userlist $userlist) {
81 }
82
435e4e2a
ZT
83 /**
84 * Export all user data for the specified user, in the specified contexts.
85 *
86 * @param approved_contextlist $contextlist The approved contexts to export information for.
87 */
88 public static function export_user_data(approved_contextlist $contextlist) {
89 }
90
91 /**
92 * Delete all data for all users in the specified context.
93 *
94 * @param context $context The specific context to delete data for.
95 */
96 public static function delete_data_for_all_users_in_context(\context $context) {
97 }
98
99 /**
100 * Delete all user data for the specified user, in the specified contexts.
101 *
102 * @param approved_contextlist $contextlist The approved contexts and user information to delete information for.
103 */
104 public static function delete_data_for_user(approved_contextlist $contextlist) {
105 }
106
2d15655c
MH
107 /**
108 * Delete multiple users within a single context.
109 *
110 * @param approved_userlist $userlist The approved context and user information to delete information for.
111 */
112 public static function delete_data_for_users(approved_userlist $userlist) {
113 }
435e4e2a 114}