MDL-61951 grading: Implement privacy API
[moodle.git] / grade / grading / form / guide / classes / privacy / 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    gradingform_guide
21  * @copyright  2018 Sara Arjona <sara@moodle.com>
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 namespace gradingform_guide\privacy;
27 defined('MOODLE_INTERNAL') || die();
29 use \core_privacy\local\metadata\collection;
30 use \core_privacy\local\request\transform;
31 use \core_privacy\local\request\writer;
33 /**
34  * Privacy class for requesting user data.
35  *
36  * @copyright  2018 Sara Arjona <sara@moodle.com>
37  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
38  */
39 class provider implements
40         \core_privacy\local\request\user_preference_provider {
42     /**
43      * Return the fields which contain personal data.
44      *
45      * @param   collection $collection The initialised collection to add items to.
46      * @return  collection A listing of user data stored through this system.
47      */
48     public static function get_metadata(collection $collection) : collection {
49         $collection->add_user_preference(
50             'gradingform_guide-showmarkerdesc',
51             'privacy:metadata:preference:showmarkerdesc'
52         );
53         $collection->add_user_preference(
54             'gradingform_guide-showstudentdesc',
55             'privacy:metadata:preference:showstudentdesc'
56         );
58         return $collection;
59     }
61     /**
62      * Store all user preferences for the plugin.
63      *
64      * @param int $userid The userid of the user whose data is to be exported.
65      */
66     public static function export_user_preferences(int $userid) {
67         $prefvalue = get_user_preferences('gradingform_guide-showmarkerdesc', null, $userid);
68         if ($prefvalue !== null) {
69             $transformedvalue = transform::yesno($prefvalue);
70             writer::export_user_preference(
71                 'gradingform_guide',
72                 'gradingform_guide-showmarkerdesc',
73                 $transformedvalue,
74                 get_string('privacy:metadata:preference:showmarkerdesc', 'gradingform_guide')
75             );
76         }
78         $prefvalue = get_user_preferences('gradingform_guide-showstudentdesc', null, $userid);
79         if ($prefvalue !== null) {
80             $transformedvalue = transform::yesno($prefvalue);
81             writer::export_user_preference(
82                 'gradingform_guide',
83                 'gradingform_guide-showstudentdesc',
84                 $transformedvalue,
85                 get_string('privacy:metadata:preference:showstudentdesc', 'gradingform_guide')
86             );
87         }
88     }
89 }