Merge branch 'wip-mdl-41266' of https://github.com/rajeshtaneja/moodle
[moodle.git] / mod / quiz / override_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  * Settings form for overrides in the quiz module.
19  *
20  * @package    mod
21  * @subpackage quiz
22  * @copyright  2010 Matt Petro
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
27 defined('MOODLE_INTERNAL') || die();
29 require_once($CFG->libdir . '/formslib.php');
30 require_once($CFG->dirroot . '/mod/quiz/mod_form.php');
33 /**
34  * Form for editing settings overrides.
35  *
36  * @copyright  2010 Matt Petro
37  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
38  */
39 class quiz_override_form extends moodleform {
41     /** @var object course module object. */
42     protected $cm;
44     /** @var object the quiz settings object. */
45     protected $quiz;
47     /** @var context the quiz context. */
48     protected $context;
50     /** @var bool editing group override (true) or user override (false). */
51     protected $groupmode;
53     /** @var int groupid, if provided. */
54     protected $groupid;
56     /** @var int userid, if provided. */
57     protected $userid;
59     /**
60      * Constructor.
61      * @param moodle_url $submiturl the form action URL.
62      * @param object course module object.
63      * @param object the quiz settings object.
64      * @param context the quiz context.
65      * @param bool editing group override (true) or user override (false).
66      * @param object $override the override being edited, if it already exists.
67      */
68     public function __construct($submiturl, $cm, $quiz, $context, $groupmode, $override) {
70         $this->cm = $cm;
71         $this->quiz = $quiz;
72         $this->context = $context;
73         $this->groupmode = $groupmode;
74         $this->groupid = empty($override->groupid) ? 0 : $override->groupid;
75         $this->userid = empty($override->userid) ? 0 : $override->userid;
77         parent::__construct($submiturl, null, 'post');
79     }
81     protected function definition() {
82         global $CFG, $DB;
84         $cm = $this->cm;
85         $mform = $this->_form;
87         $mform->addElement('header', 'override', get_string('override', 'quiz'));
89         if ($this->groupmode) {
90             // Group override.
91             if ($this->groupid) {
92                 // There is already a groupid, so freeze the selector.
93                 $groupchoices = array();
94                 $groupchoices[$this->groupid] = groups_get_group_name($this->groupid);
95                 $mform->addElement('select', 'groupid',
96                         get_string('overridegroup', 'quiz'), $groupchoices);
97                 $mform->freeze('groupid');
98             } else {
99                 // Prepare the list of groups.
100                 $groups = groups_get_all_groups($cm->course);
101                 if (empty($groups)) {
102                     // Generate an error.
103                     $link = new moodle_url('/mod/quiz/overrides.php', array('cmid'=>$cm->id));
104                     print_error('groupsnone', 'quiz', $link);
105                 }
107                 $groupchoices = array();
108                 foreach ($groups as $group) {
109                     $groupchoices[$group->id] = $group->name;
110                 }
111                 unset($groups);
113                 if (count($groupchoices) == 0) {
114                     $groupchoices[0] = get_string('none');
115                 }
117                 $mform->addElement('select', 'groupid',
118                         get_string('overridegroup', 'quiz'), $groupchoices);
119                 $mform->addRule('groupid', get_string('required'), 'required', null, 'client');
120             }
121         } else {
122             // User override.
123             if ($this->userid) {
124                 // There is already a userid, so freeze the selector.
125                 $user = $DB->get_record('user', array('id'=>$this->userid));
126                 $userchoices = array();
127                 $userchoices[$this->userid] = fullname($user);
128                 $mform->addElement('select', 'userid',
129                         get_string('overrideuser', 'quiz'), $userchoices);
130                 $mform->freeze('userid');
131             } else {
132                 // Prepare the list of users.
133                 $users = array();
134                 list($sort, $sortparams) = users_order_by_sql('u');
135                 if (!empty($sortparams)) {
136                     throw new coding_exception('users_order_by_sql returned some query parameters. ' .
137                             'This is unexpected, and a problem because there is no way to pass these ' .
138                             'parameters to get_users_by_capability. See MDL-34657.');
139                 }
140                 if (!empty($CFG->enablegroupmembersonly) && $cm->groupmembersonly) {
141                     // Only users from the grouping.
142                     $groups = groups_get_all_groups($cm->course, 0, $cm->groupingid);
143                     if (!empty($groups)) {
144                         $users = get_users_by_capability($this->context, 'mod/quiz:attempt',
145                                 'u.id, u.email, ' . get_all_user_name_fields(true, 'u'),
146                                 $sort, '', '', array_keys($groups),
147                                 '', false, true);
148                     }
149                 } else {
150                     $users = get_users_by_capability($this->context, 'mod/quiz:attempt',
151                             'u.id, u.email, ' . get_all_user_name_fields(true, 'u'),
152                             $sort, '', '', '', '', false, true);
153                 }
154                 if (empty($users)) {
155                     // Generate an error.
156                     $link = new moodle_url('/mod/quiz/overrides.php', array('cmid'=>$cm->id));
157                     print_error('usersnone', 'quiz', $link);
158                 }
160                 $userchoices = array();
161                 $canviewemail = in_array('email', get_extra_user_fields($this->context));
162                 foreach ($users as $id => $user) {
163                     if (empty($invalidusers[$id]) || (!empty($override) &&
164                             $id == $override->userid)) {
165                         if ($canviewemail) {
166                             $userchoices[$id] = fullname($user) . ', ' . $user->email;
167                         } else {
168                             $userchoices[$id] = fullname($user);
169                         }
170                     }
171                 }
172                 unset($users);
174                 if (count($userchoices) == 0) {
175                     $userchoices[0] = get_string('none');
176                 }
177                 $mform->addElement('searchableselector', 'userid',
178                         get_string('overrideuser', 'quiz'), $userchoices);
179                 $mform->addRule('userid', get_string('required'), 'required', null, 'client');
180             }
181         }
183         // Password.
184         // This field has to be above the date and timelimit fields,
185         // otherwise browsers will clear it when those fields are changed.
186         $mform->addElement('passwordunmask', 'password', get_string('requirepassword', 'quiz'));
187         $mform->setType('password', PARAM_TEXT);
188         $mform->addHelpButton('password', 'requirepassword', 'quiz');
189         $mform->setDefault('password', $this->quiz->password);
191         // Open and close dates.
192         $mform->addElement('date_time_selector', 'timeopen',
193                 get_string('quizopen', 'quiz'), mod_quiz_mod_form::$datefieldoptions);
194         $mform->setDefault('timeopen', $this->quiz->timeopen);
196         $mform->addElement('date_time_selector', 'timeclose',
197                 get_string('quizclose', 'quiz'), mod_quiz_mod_form::$datefieldoptions);
198         $mform->setDefault('timeclose', $this->quiz->timeclose);
200         // Time limit.
201         $mform->addElement('duration', 'timelimit',
202                 get_string('timelimit', 'quiz'), array('optional' => true));
203         $mform->addHelpButton('timelimit', 'timelimit', 'quiz');
204         $mform->setDefault('timelimit', $this->quiz->timelimit);
206         // Number of attempts.
207         $attemptoptions = array('0' => get_string('unlimited'));
208         for ($i = 1; $i <= QUIZ_MAX_ATTEMPT_OPTION; $i++) {
209             $attemptoptions[$i] = $i;
210         }
211         $mform->addElement('select', 'attempts',
212                 get_string('attemptsallowed', 'quiz'), $attemptoptions);
213         $mform->setDefault('attempts', $this->quiz->attempts);
215         // Submit buttons.
216         $mform->addElement('submit', 'resetbutton',
217                 get_string('reverttodefaults', 'quiz'));
219         $buttonarray = array();
220         $buttonarray[] = $mform->createElement('submit', 'submitbutton',
221                 get_string('save', 'quiz'));
222         $buttonarray[] = $mform->createElement('submit', 'againbutton',
223                 get_string('saveoverrideandstay', 'quiz'));
224         $buttonarray[] = $mform->createElement('cancel');
226         $mform->addGroup($buttonarray, 'buttonbar', '', array(' '), false);
227         $mform->closeHeaderBefore('buttonbar');
229     }
231     public function validation($data, $files) {
232         global $COURSE, $DB;
233         $errors = parent::validation($data, $files);
235         $mform =& $this->_form;
236         $quiz = $this->quiz;
238         if ($mform->elementExists('userid')) {
239             if (empty($data['userid'])) {
240                 $errors['userid'] = get_string('required');
241             }
242         }
244         if ($mform->elementExists('groupid')) {
245             if (empty($data['groupid'])) {
246                 $errors['groupid'] = get_string('required');
247             }
248         }
250         // Ensure that the dates make sense.
251         if (!empty($data['timeopen']) && !empty($data['timeclose'])) {
252             if ($data['timeclose'] < $data['timeopen'] ) {
253                 $errors['timeclose'] = get_string('closebeforeopen', 'quiz');
254             }
255         }
257         // Ensure that at least one quiz setting was changed.
258         $changed = false;
259         $keys = array('timeopen', 'timeclose', 'timelimit', 'attempts', 'password');
260         foreach ($keys as $key) {
261             if ($data[$key] != $quiz->{$key}) {
262                 $changed = true;
263                 break;
264             }
265         }
266         if (!$changed) {
267             $errors['timeopen'] = get_string('nooverridedata', 'quiz');
268         }
270         return $errors;
271     }