MDL-61731 message_email: Add privacy files and unit tests
[moodle.git] / message / output / email / 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 class for requesting user data.
19  *
20  * @package    message_email
21  * @copyright  2018 Mihail Geshoski <mihail@moodle.com>
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 namespace message_email\privacy;
27 defined('MOODLE_INTERNAL') || die();
29 use \core_privacy\local\metadata\collection;
30 use \core_privacy\local\request\contextlist;
31 use \core_privacy\local\request\approved_contextlist;
33 /**
34  * Privacy class for requesting user data.
35  *
36  * @package    message_email
37  * @copyright  2018 Mihail Geshoski <mihail@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->link_external_location('smtp', [
50                 'recipient' => 'privacy:metadata:recipient',
51                 'userfrom' => 'privacy:metadata:userfrom',
52                 'subject' => 'privacy:metadata:subject',
53                 'fullmessage' => 'privacy:metadata:fullmessage',
54                 'fullmessagehtml' => 'privacy:metadata:fullmessagehtml',
55                 'attachment' => 'privacy:metadata:attachment',
56                 'attachname' => 'privacy:metadata:attachname',
57                 'replyto' => 'privacy:metadata:replyto',
58                 'replytoname' => 'privacy:metadata:replytoname'
59         ], 'privacy:metadata:externalpurpose');
61         return $collection;
62     }
64     /**
65      * Get the list of contexts that contain user information for the specified user.
66      *
67      * @param   int         $userid     The user to search.
68      * @return  contextlist $contextlist  The contextlist containing the list of contexts used in this plugin.
69      */
70     public static function get_contexts_for_userid(int $userid) : contextlist {
71         $contextlist = new contextlist();
72         return $contextlist;
73     }
75     /**
76      * Export all user data for the specified user, in the specified contexts.
77      *
78      * @param approved_contextlist $contextlist The approved contexts to export information for.
79      */
80     public static function export_user_data(approved_contextlist $contextlist) {
81     }
83     /**
84      * Delete all use data which matches the specified deletion_criteria.
85      *
86      * @param   context $context A user context.
87      */
88     public static function delete_data_for_all_users_in_context(\context $context) {
89     }
91     /**
92      * Delete all user data for the specified user, in the specified contexts.
93      *
94      * @param   approved_contextlist    $contextlist    The approved contexts and user information to delete information for.
95      */
96     public static function delete_data_for_user(approved_contextlist $contextlist) {
97     }
98 }