Merge branch 'MDL-62135-master' of git://github.com/FMCorz/moodle
[moodle.git] / admin / tool / log / classes / local / privacy / logstore_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  * Logstore provider interface.
19  *
20  * @package    tool_log
21  * @copyright  2018 Frédéric Massart
22  * @author     Frédéric Massart <fred@branchup.tech>
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 namespace tool_log\local\privacy;
27 defined('MOODLE_INTERNAL') || die();
29 use context;
30 use core_privacy\local\request\contextlist;
31 use core_privacy\local\request\approved_contextlist;
33 /**
34  * Logstore provider interface.
35  *
36  * Logstore subplugins providers must implement this interface.
37  *
38  * @package    tool_log
39  * @copyright  2018 Frédéric Massart
40  * @author     Frédéric Massart <fred@branchup.tech>
41  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
42  */
43 interface logstore_provider extends \core_privacy\local\request\plugin\subplugin_provider {
45     /**
46      * Add contexts that contain user information for the specified user.
47      *
48      * @param contextlist $contextlist The contextlist to add the contexts to.
49      * @param int $userid The user to find the contexts for.
50      * @return void
51      */
52     public static function add_contexts_for_userid(contextlist $contextlist, $userid);
54     /**
55      * Export all user data for the specified user, in the specified contexts.
56      *
57      * @param approved_contextlist $contextlist The approved contexts to export information for.
58      * @return void
59      */
60     public static function export_user_data(approved_contextlist $contextlist);
62     /**
63      * Delete all data for all users in the specified context.
64      *
65      * @param context $context The specific context to delete data for.
66      * @return void
67      */
68     public static function delete_data_for_all_users_in_context(context $context);
70     /**
71      * Delete all user data for the specified user, in the specified contexts.
72      *
73      * @param approved_contextlist $contextlist The approved contexts and user information to delete information for.
74      * @return void
75      */
76     public static function delete_data_for_user(approved_contextlist $contextlist);
78 }