MDL-61407 mod_quiz: Add initial privacy implementation
[moodle.git] / mod / quiz / classes / privacy / helper.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 Subsystem helper for mod_quiz.
19  *
20  * @package    mod_quiz
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 mod_quiz\privacy;
27 use \core_privacy\local\request\writer;
28 use \core_privacy\local\request\transform;
29 use \core_privacy\local\request\contextlist;
30 use \core_privacy\local\request\approved_contextlist;
31 use \core_privacy\local\request\deletion_criteria;
32 use \core_privacy\local\metadata\collection;
33 use \core_privacy\manager;
35 defined('MOODLE_INTERNAL') || die();
37 require_once($CFG->dirroot . '/mod/quiz/lib.php');
38 require_once($CFG->dirroot . '/mod/quiz/locallib.php');
40 /**
41  * Privacy Subsystem implementation for mod_quiz.
42  *
43  * @copyright  2018 Andrew Nicols <andrew@nicols.co.uk>
44  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
45  */
46 class helper {
47     /**
48      * Determine the subcontext for the specified quiz attempt.
49      *
50      * @param   \stdClass       $attempt    The attempt data retrieved from the database.
51      * @param   \stdClass       $user       The user record.
52      * @return  \array                      The calculated subcontext.
53      */
54     public static function get_quiz_attempt_subcontext(\stdClass $attempt, \stdClass $user) {
55         $subcontext = [
56             get_string('attempts', 'mod_quiz'),
57         ];
58         if ($attempt->userid != $user->id) {
59             $subcontext[] = fullname($user);
60         }
61         $subcontext[] = $attempt->attempt;
63         return $subcontext;
64     }
65 }