Merge branch 'MDL-62414-master' of git://github.com/junpataleta/moodle
[moodle.git] / admin / tool / dataprivacy / createdatarequest_form.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  * The contact form to the site's Data Protection Officer
19  *
20  * @copyright 2018 onwards Jun Pataleta
21  * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
22  * @package tool_dataprivacy
23  */
25 use tool_dataprivacy\api;
26 use tool_dataprivacy\local\helper;
28 defined('MOODLE_INTERNAL') || die();
30 require_once($CFG->libdir.'/formslib.php');
32 /**
33  * The contact form to the site's Data Protection Officer
34  *
35  * @copyright 2018 onwards Jun Pataleta
36  * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
37  * @package tool_dataprivacy
38  */
39 class tool_dataprivacy_data_request_form extends moodleform {
41     /** @var bool Flag to indicate whether this form is being rendered for managing data requests or for regular requests. */
42     protected $manage = false;
44     /**
45      * Form definition.
46      *
47      * @throws HTML_QuickForm_Error
48      * @throws coding_exception
49      * @throws dml_exception
50      */
51     public function definition() {
52         global $DB, $USER;
53         $mform =& $this->_form;
55         $this->manage = $this->_customdata['manage'];
56         if ($this->manage) {
57             $options = [
58                 'ajax' => 'tool_dataprivacy/form-user-selector',
59                 'multiple' => false
60             ];
61             $mform->addElement('autocomplete', 'userid', get_string('requestfor', 'tool_dataprivacy'), [], $options);
62             $mform->addRule('userid', null, 'required', null, 'client');
64         } else {
65             // Get users whom you are being a guardian to if your role has the capability to make data requests for children.
66             if ($children = helper::get_children_of_user($USER->id)) {
67                 $useroptions = [
68                     $USER->id => fullname($USER)
69                 ];
70                 foreach ($children as $key => $child) {
71                     $useroptions[$key] = fullname($child);
72                 }
73                 $mform->addElement('autocomplete', 'userid', get_string('requestfor', 'tool_dataprivacy'), $useroptions);
74                 $mform->addRule('userid', null, 'required', null, 'client');
76             } else {
77                 // Requesting for self.
78                 $mform->addElement('hidden', 'userid', $USER->id);
79             }
80         }
82         $mform->setType('userid', PARAM_INT);
84         // Subject access request type.
85         $options = [
86             api::DATAREQUEST_TYPE_EXPORT => get_string('requesttypeexport', 'tool_dataprivacy'),
87             api::DATAREQUEST_TYPE_DELETE => get_string('requesttypedelete', 'tool_dataprivacy')
88         ];
89         $mform->addElement('select', 'type', get_string('requesttype', 'tool_dataprivacy'), $options);
90         $mform->setType('type', PARAM_INT);
91         $mform->addHelpButton('type', 'requesttype', 'tool_dataprivacy');
93         // Request comments text area.
94         $textareaoptions = ['cols' => 60, 'rows' => 10];
95         $mform->addElement('textarea', 'comments', get_string('requestcomments', 'tool_dataprivacy'), $textareaoptions);
96         $mform->setType('type', PARAM_ALPHANUM);
97         $mform->addHelpButton('comments', 'requestcomments', 'tool_dataprivacy');
99         // Action buttons.
100         $this->add_action_buttons();
102     }
104     /**
105      * Form validation.
106      *
107      * @param array $data
108      * @param array $files
109      * @return array
110      * @throws coding_exception
111      * @throws dml_exception
112      */
113     public function validation($data, $files) {
114         $errors = [];
116         $validrequesttypes = [
117             api::DATAREQUEST_TYPE_EXPORT,
118             api::DATAREQUEST_TYPE_DELETE
119         ];
120         if (!in_array($data['type'], $validrequesttypes)) {
121             $errors['type'] = get_string('errorinvalidrequesttype', 'tool_dataprivacy');
122         }
124         if (api::has_ongoing_request($data['userid'], $data['type'])) {
125             $errors['type'] = get_string('errorrequestalreadyexists', 'tool_dataprivacy');
126         }
128         return $errors;
129     }