MDL-63536 core_repository: Add support for removal of context users
[moodle.git] / repository / boxnet / 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 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  */
25 namespace repository_boxnet\privacy;
27 use core_privacy\local\metadata\collection;
28 use core_privacy\local\request\approved_contextlist;
29 use core_privacy\local\request\context;
30 use core_privacy\local\request\contextlist;
32 defined('MOODLE_INTERNAL') || die();
34 /**
35  * Privacy Subsystem for repository_boxnet implementing metadata and plugin providers.
36  *
37  * @copyright  2018 Zig Tan <zig@moodle.com>
38  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
39  */
40 class provider implements \core_privacy\local\metadata\provider, \core_privacy\local\request\plugin\provider {
42     /**
43      * Returns meta data about this system.
44      *
45      * @param   collection $collection The initialised collection to add items to.
46      * @return  collection     A listing of user data stored through this system.
47      */
48     public static function get_metadata(collection $collection) : collection {
49         $collection->add_external_location_link(
50             'box.com',
51             [
52                 'query' => 'privacy:metadata:repository_boxnet:query'
53             ],
54             'privacy:metadata:repository_boxnet'
55         );
57         return $collection;
58     }
60     /**
61      * Get the list of contexts that contain user information for the specified user.
62      *
63      * @param   int $userid The user to search.
64      * @return  contextlist   $contextlist  The contextlist containing the list of contexts used in this plugin.
65      */
66     public static function get_contexts_for_userid(int $userid) : contextlist {
67         return new contextlist();
68     }
70     /**
71      * Export all user data for the specified user, in the specified contexts.
72      *
73      * @param   approved_contextlist $contextlist The approved contexts to export information for.
74      */
75     public static function export_user_data(approved_contextlist $contextlist) {
76     }
78     /**
79      * Delete all data for all users in the specified context.
80      *
81      * @param   context $context The specific context to delete data for.
82      */
83     public static function delete_data_for_all_users_in_context(\context $context) {
84     }
86     /**
87      * Delete all user data for the specified user, in the specified contexts.
88      *
89      * @param   approved_contextlist $contextlist The approved contexts and user information to delete information for.
90      */
91     public static function delete_data_for_user(approved_contextlist $contextlist) {
92     }
94 }