2d8eb30845a9dc62135009622240d952746cffcd
[moodle.git] / plagiarism / classes / privacy / plagiarism_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    core_plagiarism
21  * @copyright  2018 Andrew Nicols <andrew@nicols.co.uk>
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 namespace core_plagiarism\privacy;
27 defined('MOODLE_INTERNAL') || die();
29 /**
30  * Provider for the plagiarism API.
31  *
32  * @copyright  2018 Andrew Nicols <andrew@nicols.co.uk>
33  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
34  */
35 interface plagiarism_provider extends
36         // The plagiarism_provider should be implemented by plugins which only provide information to a subsystem.
37         \core_privacy\local\request\plugin\subsystem_provider,
39         // All plagiarism plugins should also implement the metadata provider.
40         \core_privacy\local\metadata\provider {
42     /**
43      * Export all plagiarism data from each plagiarism plugin for the specified userid and context.
44      *
45      * @param   int         $userid The user to export.
46      * @param   \context    $context The context to export.
47      * @param   array       $subcontext The subcontext within the context to export this information to.
48      * @param   array       $linkarray The weird and wonderful link array used to display information for a specific item
49      */
50     public static function export_plagiarism_user_data(int $userid, \context $context, array $subcontext, array $linkarray);
52     /**
53      * Delete all user information for the provided context.
54      *
55      * @param  \context $context The context to delete user data for.
56      */
57     public static function delete_plagiarism_for_context(\context $context);
59     /**
60      * Delete all user information for the provided user and context.
61      *
62      * @param  int      $userid    The user to delete
63      * @param  \context $context   The context to refine the deletion.
64      */
65     public static function delete_plagiarism_for_user(int $userid, \context $context);
66 }