1 |
efrain |
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/>.
|
|
|
16 |
|
|
|
17 |
/**
|
|
|
18 |
* Privacy class for requesting user data.
|
|
|
19 |
*
|
|
|
20 |
* @package search_solr
|
|
|
21 |
* @copyright 2018 David Monllao
|
|
|
22 |
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
|
23 |
*/
|
|
|
24 |
namespace search_solr\privacy;
|
|
|
25 |
|
|
|
26 |
defined('MOODLE_INTERNAL') || die();
|
|
|
27 |
|
|
|
28 |
use core_privacy\local\metadata\collection;
|
|
|
29 |
use core_privacy\local\request\contextlist;
|
|
|
30 |
use core_privacy\local\request\approved_contextlist;
|
|
|
31 |
use core_privacy\local\request\approved_userlist;
|
|
|
32 |
use core_privacy\local\request\userlist;
|
|
|
33 |
|
|
|
34 |
/**
|
|
|
35 |
* Provider for the search_solr plugin.
|
|
|
36 |
*
|
|
|
37 |
* @copyright 2018 David Monllao
|
|
|
38 |
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
|
39 |
*/
|
|
|
40 |
class provider implements
|
|
|
41 |
// This search engine plugin does not store any data itself.
|
|
|
42 |
// It has no database tables, and it purely acts as a conduit, sending data externally.
|
|
|
43 |
// This plugin is capable of determining which users have data within it.
|
|
|
44 |
\core_privacy\local\metadata\provider,
|
|
|
45 |
\core_privacy\local\request\core_userlist_provider,
|
|
|
46 |
\core_privacy\local\request\plugin\provider {
|
|
|
47 |
|
|
|
48 |
/**
|
|
|
49 |
* Returns meta data about this system.
|
|
|
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 |
return $collection->add_external_location_link('solr', ['data' => 'privacy:metadata:data'],
|
|
|
56 |
'privacy:metadata');
|
|
|
57 |
}
|
|
|
58 |
|
|
|
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): contextlist {
|
|
|
66 |
return new contextlist();
|
|
|
67 |
}
|
|
|
68 |
|
|
|
69 |
/**
|
|
|
70 |
* Get the list of users who have data within a context.
|
|
|
71 |
*
|
|
|
72 |
* @param userlist $userlist The userlist containing the list of users who have data in this context/plugin combination.
|
|
|
73 |
*/
|
|
|
74 |
public static function get_users_in_context(userlist $userlist) {
|
|
|
75 |
}
|
|
|
76 |
|
|
|
77 |
/**
|
|
|
78 |
* Export all user data for the specified user, in the specified contexts.
|
|
|
79 |
*
|
|
|
80 |
* @param approved_contextlist $contextlist The approved contexts to export information for.
|
|
|
81 |
*/
|
|
|
82 |
public static function export_user_data(approved_contextlist $contextlist) {
|
|
|
83 |
}
|
|
|
84 |
|
|
|
85 |
/**
|
|
|
86 |
* Delete all data for all users in the specified context.
|
|
|
87 |
*
|
|
|
88 |
* @param context $context The specific context to delete data for.
|
|
|
89 |
*/
|
|
|
90 |
public static function delete_data_for_all_users_in_context(\context $context) {
|
|
|
91 |
}
|
|
|
92 |
|
|
|
93 |
/**
|
|
|
94 |
* Delete all user data for the specified user, in the specified contexts.
|
|
|
95 |
*
|
|
|
96 |
* @param approved_contextlist $contextlist The approved contexts and user information to delete information for.
|
|
|
97 |
*/
|
|
|
98 |
public static function delete_data_for_user(approved_contextlist $contextlist) {
|
|
|
99 |
}
|
|
|
100 |
|
|
|
101 |
/**
|
|
|
102 |
* Delete multiple users within a single context.
|
|
|
103 |
*
|
|
|
104 |
* @param approved_userlist $userlist The approved context and user information to delete information for.
|
|
|
105 |
*/
|
|
|
106 |
public static function delete_data_for_users(approved_userlist $userlist) {
|
|
|
107 |
}
|
|
|
108 |
}
|