Proyectos de Subversion Moodle

Rev

| Ultima modificación | Ver Log |

Rev Autor Línea Nro. Línea
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
 * This file contains the assignfeedback_provider interface.
19
 *
20
 * Assignment Sub plugins should implement this if they store personal information.
21
 *
22
 * @package mod_assign
23
 * @copyright 2018 Adrian Greeve <adrian@moodle.com>
24
 *
25
 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26
 */
27
namespace mod_assign\privacy;
28
 
29
use core_privacy\local\request\contextlist;
30
 
31
defined('MOODLE_INTERNAL') || die();
32
 
33
interface assignfeedback_provider extends \core_privacy\local\request\plugin\subplugin_provider {
34
 
35
    /**
36
     * Retrieves the contextids associated with the provided userid for this subplugin.
37
     * NOTE if your subplugin must have an entry in the assign_grade table to work, then this
38
     * method can be empty.
39
     *
40
     * @param int $userid The user ID to get context IDs for.
41
     * @param \core_privacy\local\request\contextlist $contextlist Use add_from_sql with this object to add your context IDs.
42
     */
43
    public static function get_context_for_userid_within_feedback(int $userid, contextlist $contextlist);
44
 
45
    /**
46
     * Returns student user ids related to the provided teacher ID. If an entry must be present in the assign_grade table for
47
     * your plugin to work then there is no need to fill in this method. If you filled in get_context_for_userid_within_feedback()
48
     * then you probably have to fill this in as well.
49
     *
50
     * @param  useridlist $useridlist A list of user IDs of students graded by this user.
51
     */
52
    public static function get_student_user_ids(useridlist $useridlist);
53
 
54
    /**
55
     * Export feedback data with the available grade and userid information provided.
56
     * assign_plugin_request_data contains:
57
     * - context
58
     * - grade object
59
     * - current path (subcontext)
60
     * - user object
61
     *
62
     * @param  assign_plugin_request_data $exportdata Contains data to help export the user information.
63
     */
64
    public static function export_feedback_user_data(assign_plugin_request_data $exportdata);
65
 
66
    /**
67
     * Any call to this method should delete all user data for the context defined in the deletion_criteria.
68
     * assign_plugin_request_data contains:
69
     * - context
70
     * - assign object
71
     *
72
     * @param  assign_plugin_request_data $requestdata Data useful for deleting user data from this sub-plugin.
73
     */
74
    public static function delete_feedback_for_context(assign_plugin_request_data $requestdata);
75
 
76
    /**
77
     * Calling this function should delete all user data associated with this grade.
78
     * assign_plugin_request_data contains:
79
     * - context
80
     * - grade object
81
     * - user object
82
     * - assign object
83
     *
84
     * @param  assign_plugin_request_data $requestdata Data useful for deleting user data.
85
     */
86
    public static function delete_feedback_for_grade(assign_plugin_request_data $requestdata);
87
}