Differences Between: [Versions 310 and 400] [Versions 311 and 400] [Versions 39 and 400] [Versions 400 and 401] [Versions 400 and 402] [Versions 400 and 403]
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 * Settings form for overrides in the lesson module. 19 * 20 * @package mod_lesson 21 * @copyright 2015 Jean-Michel Vedrine 22 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 23 */ 24 25 26 defined('MOODLE_INTERNAL') || die(); 27 28 require_once($CFG->libdir . '/formslib.php'); 29 require_once($CFG->dirroot . '/mod/lesson/mod_form.php'); 30 31 32 /** 33 * Form for editing settings overrides. 34 * 35 * @copyright 2015 Jean-Michel Vedrine 36 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 37 */ 38 class lesson_override_form extends moodleform { 39 40 /** @var object course module object. */ 41 protected $cm; 42 43 /** @var object the lesson settings object. */ 44 protected $lesson; 45 46 /** @var context the lesson context. */ 47 protected $context; 48 49 /** @var bool editing group override (true) or user override (false). */ 50 protected $groupmode; 51 52 /** @var int groupid, if provided. */ 53 protected $groupid; 54 55 /** @var int userid, if provided. */ 56 protected $userid; 57 58 /** 59 * Constructor. 60 * @param moodle_url $submiturl the form action URL. 61 * @param object $cm course module object. 62 * @param object $lesson the lesson settings object. 63 * @param object $context the lesson context. 64 * @param bool $groupmode editing group override (true) or user override (false). 65 * @param object $override the override being edited, if it already exists. 66 */ 67 public function __construct($submiturl, $cm, $lesson, $context, $groupmode, $override) { 68 69 $this->cm = $cm; 70 $this->lesson = $lesson; 71 $this->context = $context; 72 $this->groupmode = $groupmode; 73 $this->groupid = empty($override->groupid) ? 0 : $override->groupid; 74 $this->userid = empty($override->userid) ? 0 : $override->userid; 75 76 parent::__construct($submiturl, null, 'post'); 77 78 } 79 80 /** 81 * Define this form - called by the parent constructor 82 */ 83 protected function definition() { 84 global $DB; 85 86 $cm = $this->cm; 87 $mform = $this->_form; 88 89 $mform->addElement('header', 'override', get_string('override', 'lesson')); 90 91 $lessongroupmode = groups_get_activity_groupmode($cm); 92 $accessallgroups = ($lessongroupmode == NOGROUPS) || has_capability('moodle/site:accessallgroups', $this->context); 93 94 if ($this->groupmode) { 95 // Group override. 96 if ($this->groupid) { 97 // There is already a groupid, so freeze the selector. 98 $groupchoices = [ 99 $this->groupid => format_string(groups_get_group_name($this->groupid), true, $this->context), 100 ]; 101 $mform->addElement('select', 'groupid', 102 get_string('overridegroup', 'lesson'), $groupchoices); 103 $mform->freeze('groupid'); 104 } else { 105 // Prepare the list of groups. 106 // Only include the groups the current can access. 107 $groups = $accessallgroups ? groups_get_all_groups($cm->course) : groups_get_activity_allowed_groups($cm); 108 if (empty($groups)) { 109 // Generate an error. 110 $link = new moodle_url('/mod/lesson/overrides.php', array('cmid' => $cm->id)); 111 print_error('groupsnone', 'lesson', $link); 112 } 113 114 $groupchoices = array(); 115 foreach ($groups as $group) { 116 $groupchoices[$group->id] = format_string($group->name, true, $this->context); 117 } 118 unset($groups); 119 120 if (count($groupchoices) == 0) { 121 $groupchoices[0] = get_string('none'); 122 } 123 124 $mform->addElement('select', 'groupid', 125 get_string('overridegroup', 'lesson'), $groupchoices); 126 $mform->addRule('groupid', get_string('required'), 'required', null, 'client'); 127 } 128 } else { 129 // User override. 130 if ($this->userid) { 131 // There is already a userid, so freeze the selector. 132 $user = $DB->get_record('user', array('id' => $this->userid)); 133 $userchoices = array(); 134 $userchoices[$this->userid] = fullname($user); 135 $mform->addElement('select', 'userid', 136 get_string('overrideuser', 'lesson'), $userchoices); 137 $mform->freeze('userid'); 138 } else { 139 // Prepare the list of users. 140 $users = []; 141 list($sort) = users_order_by_sql('u'); 142 143 // Get the list of appropriate users, depending on whether and how groups are used. 144 $userfieldsapi = \core_user\fields::for_name(); 145 if ($accessallgroups) { 146 $users = get_enrolled_users($this->context, '', 0, 147 'u.id, u.email, ' . $userfieldsapi->get_sql('u', false, '', '', false)->selects, $sort); 148 } else if ($groups = groups_get_activity_allowed_groups($cm)) { 149 $enrolledjoin = get_enrolled_join($this->context, 'u.id'); 150 $userfields = 'u.id, u.email, ' . $userfieldsapi->get_sql('u', false, '', '', false)->selects; 151 list($ingroupsql, $ingroupparams) = $DB->get_in_or_equal(array_keys($groups), SQL_PARAMS_NAMED); 152 $params = $enrolledjoin->params + $ingroupparams; 153 $sql = "SELECT $userfields 154 FROM {user} u 155 JOIN {groups_members} gm ON gm.userid = u.id 156 {$enrolledjoin->joins} 157 WHERE gm.groupid $ingroupsql 158 AND {$enrolledjoin->wheres} 159 ORDER BY $sort"; 160 $users = $DB->get_records_sql($sql, $params); 161 } 162 163 // Filter users based on any fixed restrictions (groups, profile). 164 $info = new \core_availability\info_module($cm); 165 $users = $info->filter_user_list($users); 166 167 if (empty($users)) { 168 // Generate an error. 169 $link = new moodle_url('/mod/lesson/overrides.php', array('cmid' => $cm->id)); 170 print_error('usersnone', 'lesson', $link); 171 } 172 173 $userchoices = array(); 174 // TODO Does not support custom user profile fields (MDL-70456). 175 $canviewemail = in_array('email', \core_user\fields::get_identity_fields($this->context, false)); 176 foreach ($users as $id => $user) { 177 if (empty($invalidusers[$id]) || (!empty($override) && 178 $id == $override->userid)) { 179 if ($canviewemail) { 180 $userchoices[$id] = fullname($user) . ', ' . $user->email; 181 } else { 182 $userchoices[$id] = fullname($user); 183 } 184 } 185 } 186 unset($users); 187 188 if (count($userchoices) == 0) { 189 $userchoices[0] = get_string('none'); 190 } 191 $mform->addElement('searchableselector', 'userid', 192 get_string('overrideuser', 'lesson'), $userchoices); 193 $mform->addRule('userid', get_string('required'), 'required', null, 'client'); 194 } 195 } 196 197 // Password. 198 // This field has to be above the date and timelimit fields, 199 // otherwise browsers will clear it when those fields are changed. 200 $mform->addElement('passwordunmask', 'password', get_string('usepassword', 'lesson')); 201 $mform->setType('password', PARAM_TEXT); 202 $mform->addHelpButton('password', 'usepassword', 'lesson'); 203 $mform->setDefault('password', $this->lesson->password);; 204 205 // Open and close dates. 206 $mform->addElement('date_time_selector', 'available', get_string('available', 'lesson'), array('optional' => true)); 207 $mform->setDefault('available', $this->lesson->available); 208 209 $mform->addElement('date_time_selector', 'deadline', get_string('deadline', 'lesson'), array('optional' => true)); 210 $mform->setDefault('deadline', $this->lesson->deadline); 211 212 // Lesson time limit. 213 $mform->addElement('duration', 'timelimit', 214 get_string('timelimit', 'lesson'), array('optional' => true)); 215 if ($this->lesson->timelimit != 0) { 216 $mform->setDefault('timelimit', 0); 217 } else { 218 $mform->setDefault('timelimit', $this->lesson->timelimit); 219 } 220 221 // Try a question again. 222 $mform->addElement('selectyesno', 'review', get_string('displayreview', 'lesson')); 223 $mform->addHelpButton('review', 'displayreview', 'lesson'); 224 $mform->setDefault('review', $this->lesson->review); 225 226 // Number of attempts. 227 $numbers = ['0' => get_string('unlimited')]; 228 for ($i = 10; $i > 0; $i--) { 229 $numbers[$i] = $i; 230 } 231 $mform->addElement('select', 'maxattempts', get_string('maximumnumberofattempts', 'lesson'), $numbers); 232 $mform->addHelpButton('maxattempts', 'maximumnumberofattempts', 'lesson'); 233 $mform->setDefault('maxattempts', $this->lesson->maxattempts); 234 235 // Retake allowed. 236 $mform->addElement('selectyesno', 'retake', get_string('retakesallowed', 'lesson')); 237 $mform->addHelpButton('retake', 'retakesallowed', 'lesson'); 238 $mform->setDefault('retake', $this->lesson->retake); 239 240 // Submit buttons. 241 $mform->addElement('submit', 'resetbutton', 242 get_string('reverttodefaults', 'lesson')); 243 244 $buttonarray = array(); 245 $buttonarray[] = $mform->createElement('submit', 'submitbutton', 246 get_string('save', 'lesson')); 247 $buttonarray[] = $mform->createElement('submit', 'againbutton', 248 get_string('saveoverrideandstay', 'lesson')); 249 $buttonarray[] = $mform->createElement('cancel'); 250 251 $mform->addGroup($buttonarray, 'buttonbar', '', array(' '), false); 252 $mform->closeHeaderBefore('buttonbar'); 253 254 } 255 256 /** 257 * Validate the submitted form data. 258 * 259 * @param array $data array of ("fieldname"=>value) of submitted data 260 * @param array $files array of uploaded files "element_name"=>tmp_file_path 261 * @return array of "element_name"=>"error_description" if there are errors 262 */ 263 public function validation($data, $files) { 264 $errors = parent::validation($data, $files); 265 266 $mform =& $this->_form; 267 $lesson = $this->lesson; 268 269 if ($mform->elementExists('userid')) { 270 if (empty($data['userid'])) { 271 $errors['userid'] = get_string('required'); 272 } 273 } 274 275 if ($mform->elementExists('groupid')) { 276 if (empty($data['groupid'])) { 277 $errors['groupid'] = get_string('required'); 278 } 279 } 280 281 // Ensure that the dates make sense. 282 if (!empty($data['available']) && !empty($data['deadline'])) { 283 if ($data['deadline'] < $data['available'] ) { 284 $errors['deadline'] = get_string('closebeforeopen', 'lesson'); 285 } 286 } 287 288 // Ensure that at least one lesson setting was changed. 289 $changed = false; 290 $keys = array('available', 'deadline', 'review', 'timelimit', 'maxattempts', 'retake', 'password'); 291 foreach ($keys as $key) { 292 if ($data[$key] != $lesson->{$key}) { 293 $changed = true; 294 break; 295 } 296 } 297 298 if (!$changed) { 299 $errors['available'] = get_string('nooverridedata', 'lesson'); 300 } 301 302 return $errors; 303 } 304 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body