83666d0039f80c4820996daf4cf1836a07c26a2e
[moodle.git] / mod / lti / service / memberships / 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 ltiservice_memberships.
19  *
20  * @package    ltiservice_memberships
21  * @copyright  2018 Mark Nelson <markn@moodle.com>
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 namespace ltiservice_memberships\privacy;
27 use \core_privacy\local\metadata\collection;
28 use \core_privacy\local\request\contextlist;
29 use \core_privacy\local\request\approved_contextlist;
31 defined('MOODLE_INTERNAL') || die();
33 /**
34  * Privacy Subsystem for ltiservice_memberships.
35  *
36  * @copyright  2018 Mark Nelson <markn@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\plugin\provider {
43     /**
44      * Returns meta data about this system.
45      *
46      * @param collection $collection The initialised collection to add items to.
47      * @return collection A listing of user data stored through this system.
48      */
49     public static function get_metadata(collection $collection) : collection {
50         $collection->link_external_location('External LTI provider.', [
51             'userid' => 'privacy:metadata:userid',
52             'useridnumber' => 'privacy:metadata:useridnumber',
53             'fullname' => 'privacy:metadata:fullname',
54             'firstname' => 'privacy:metadata:firstname',
55             'lastname' => 'privacy:metadata:lastname',
56             'email' => 'privacy:metadata:email'
57         ], 'privacy:metadata:externalpurpose');
59         return $collection;
60     }
62     /**
63      * Get the list of contexts that contain user information for the specified user.
64      *
65      * @param int $userid The user to search.
66      * @return contextlist The contextlist containing the list of contexts used in this plugin.
67      */
68     public static function get_contexts_for_userid(int $userid) : contextlist {
69         return new contextlist();
70     }
72     /**
73      * Export all user data for the specified user, in the specified contexts.
74      *
75      * @param approved_contextlist $contextlist The approved contexts to export information for.
76      */
77     public static function export_user_data(approved_contextlist $contextlist) {
78     }
80     /**
81      * Delete all user data which matches the specified context.
82      *
83      * @param \context $context A user context.
84      */
85     public static function delete_data_for_all_users_in_context(\context $context) {
86     }
88     /**
89      * Delete all user data for the specified user, in the specified contexts.
90      *
91      * @param approved_contextlist $contextlist The approved contexts and user information to delete information for.
92      */
93     public static function delete_data_for_user(approved_contextlist $contextlist) {
94     }
95 }