MDL-61951 core_grading: Several fixes to the privacy implementation
[moodle.git] / grade / grading / classes / privacy / gradingform_provider.php
CommitLineData
6416e87f
SA
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 * This file contains the grading method interface.
19 *
20 * Grading method plugins should implement this if they store personal information.
21 *
22 * @package core_grading
23 * @copyright 2018 Sara Arjona <sara@moodle.com>
24 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25 */
26
27namespace core_grading\privacy;
28
29defined('MOODLE_INTERNAL') || die();
30
31use core_privacy\local\request\approved_contextlist;
32
33interface gradingform_provider extends
7feac024 34 \core_privacy\local\request\plugin\subsystem_provider {
6416e87f
SA
35
36 /**
37 * This method is used to export any user data this sub-plugin has using the object to get the context and userid.
38 *
39 * @param \context $context Context owner of the data.
40 * @param \stdClass $definition Grading definition entry to export.
41 * @param int $userid The user whose information is to be exported.
42 *
43 * @return \stdClass The data to export.
44 */
45 public static function get_gradingform_export_data(\context $context, $definition, int $userid);
46
47 /**
48 * Any call to this method should delete all user data for the context defined.
49 *
50 * @param \context $context Context owner of the data.
51 */
52 public static function delete_gradingform_for_context(\context $context);
53
54 /**
55 * A call to this method should delete user data (where practicle) from the userid and context.
56 *
7feac024
JD
57 * @param int $userid The user to delete.
58 * @param \context $context the context to refine the deletion.
6416e87f 59 */
7feac024 60 public static function delete_gradingform_for_userid(int $userid, \context $context);
6416e87f 61}