252ba509e2fb8cb1fa00582dbc7a81f7c4132588
[moodle.git] / admin / tool / log / 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  * Data provider.
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\privacy;
27 defined('MOODLE_INTERNAL') || die();
29 use context;
30 use core_privacy\local\metadata\collection;
31 use core_privacy\local\request\approved_contextlist;
32 use core_privacy\local\request\transform;
33 use core_privacy\local\request\writer;
34 use tool_log\log\manager;
36 /**
37  * Data provider class.
38  *
39  * @package    tool_log
40  * @copyright  2018 Frédéric Massart
41  * @author     Frédéric Massart <fred@branchup.tech>
42  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
43  */
44 class provider implements
45     \core_privacy\local\metadata\provider,
46     \core_privacy\local\request\subsystem\provider {
48     /**
49      * Returns metadata.
50      *
51      * @param collection $collection The initialised collection to add items to.
52      * @return collection A listing of user data stored through this system.
53      */
54     public static function get_metadata(collection $collection) : collection {
55         $collection->add_plugintype_link('logstore', [], 'privacy:metadata:logstore');
56         return $collection;
57     }
59     /**
60      * Get the list of contexts that contain user information for the specified user.
61      *
62      * @param int $userid The user to search.
63      * @return contextlist $contextlist The contextlist containing the list of contexts used in this plugin.
64      */
65     public static function get_contexts_for_userid(int $userid) : \core_privacy\local\request\contextlist {
66         $contextlist = new \core_privacy\local\request\contextlist();
67         static::call_subplugins_method_with_args('add_contexts_for_userid', [$contextlist, $userid]);
68         return $contextlist;
69     }
71     /**
72      * Export all user data for the specified user, in the specified contexts.
73      *
74      * @param approved_contextlist $contextlist The approved contexts to export information for.
75      */
76     public static function export_user_data(approved_contextlist $contextlist) {
77         if (get_config('tool_log', 'exportlog')) {
78             static::call_subplugins_method_with_args('export_user_data', [$contextlist]);
79         }
80     }
82     /**
83      * Delete all data for all users in the specified context.
84      *
85      * @param context $context The specific context to delete data for.
86      */
87     public static function delete_data_for_all_users_in_context(context $context) {
88         static::call_subplugins_method_with_args('delete_data_for_all_users_in_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         static::call_subplugins_method_with_args('delete_data_for_user', [$contextlist]);
98     }
100     /**
101      * Invoke the subplugins method with arguments.
102      *
103      * @param string $method The method name.
104      * @param array $args The arguments.
105      * @return void
106      */
107     protected static function call_subplugins_method_with_args($method, array $args = []) {
108         $interface = \tool_log\local\privacy\logstore_provider::class;
109         \core_privacy\manager::plugintype_class_callback('logstore', $interface, $method, $args);
110     }