See Release Notes
Long Term Support Release
Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401] [Versions 400 and 401] [Versions 401 and 402] [Versions 401 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 * The main workshop configuration form 19 * 20 * The UI mockup has been proposed in MDL-18688 21 * It uses the standard core Moodle formslib. For more info about them, please 22 * visit: https://moodledev.io/docs/apis/subsystems/form 23 * 24 * @package mod_workshop 25 * @copyright 2009 David Mudrak <david.mudrak@gmail.com> 26 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 27 */ 28 29 defined('MOODLE_INTERNAL') || die(); 30 31 require_once($CFG->dirroot . '/course/moodleform_mod.php'); 32 require_once (__DIR__ . '/locallib.php'); 33 require_once($CFG->libdir . '/filelib.php'); 34 35 use core_grades\component_gradeitems; 36 /** 37 * Module settings form for Workshop instances 38 */ 39 class mod_workshop_mod_form extends moodleform_mod { 40 41 /** @var object the course this instance is part of */ 42 protected $course = null; 43 44 /** 45 * Constructor 46 */ 47 public function __construct($current, $section, $cm, $course) { 48 $this->course = $course; 49 parent::__construct($current, $section, $cm, $course); 50 } 51 52 /** 53 * Defines the workshop instance configuration form 54 * 55 * @return void 56 */ 57 public function definition() { 58 global $CFG, $PAGE; 59 60 $workshopconfig = get_config('workshop'); 61 $mform = $this->_form; 62 63 // General -------------------------------------------------------------------- 64 $mform->addElement('header', 'general', get_string('general', 'form')); 65 66 // Workshop name 67 $label = get_string('workshopname', 'workshop'); 68 $mform->addElement('text', 'name', $label, array('size' => '64')); 69 if (!empty($CFG->formatstringstriptags)) { 70 $mform->setType('name', PARAM_TEXT); 71 } else { 72 $mform->setType('name', PARAM_CLEANHTML); 73 } 74 $mform->addRule('name', null, 'required', null, 'client'); 75 $mform->addRule('name', get_string('maximumchars', '', 255), 'maxlength', 255, 'client'); 76 77 // Introduction 78 $this->standard_intro_elements(get_string('introduction', 'workshop')); 79 80 // Grading settings ----------------------------------------------------------- 81 $mform->addElement('header', 'gradingsettings', get_string('gradingsettings', 'workshop')); 82 $mform->setExpanded('gradingsettings'); 83 84 $label = get_string('strategy', 'workshop'); 85 $mform->addElement('select', 'strategy', $label, workshop::available_strategies_list()); 86 $mform->setDefault('strategy', $workshopconfig->strategy); 87 $mform->addHelpButton('strategy', 'strategy', 'workshop'); 88 89 $grades = workshop::available_maxgrades_list(); 90 $gradecategories = grade_get_categories_menu($this->course->id); 91 92 $label = get_string('submissiongrade', 'workshop'); 93 $mform->addGroup(array( 94 $mform->createElement('select', 'grade', '', $grades), 95 $mform->createElement('select', 'gradecategory', '', $gradecategories), 96 ), 'submissiongradegroup', $label, ' ', false); 97 $mform->setDefault('grade', $workshopconfig->grade); 98 $mform->addHelpButton('submissiongradegroup', 'submissiongrade', 'workshop'); 99 100 $mform->addElement('float', 'submissiongradepass', get_string('gradetopasssubmission', 'workshop')); 101 $mform->addHelpButton('submissiongradepass', 'gradepass', 'grades'); 102 $mform->setDefault('submissiongradepass', ''); 103 104 $label = get_string('gradinggrade', 'workshop'); 105 $mform->addGroup(array( 106 $mform->createElement('select', 'gradinggrade', '', $grades), 107 $mform->createElement('select', 'gradinggradecategory', '', $gradecategories), 108 ), 'gradinggradegroup', $label, ' ', false); 109 $mform->setDefault('gradinggrade', $workshopconfig->gradinggrade); 110 $mform->addHelpButton('gradinggradegroup', 'gradinggrade', 'workshop'); 111 112 $mform->addElement('float', 'gradinggradepass', get_string('gradetopassgrading', 'workshop')); 113 $mform->addHelpButton('gradinggradepass', 'gradepass', 'grades'); 114 $mform->setDefault('gradinggradepass', ''); 115 116 $options = array(); 117 for ($i = 5; $i >= 0; $i--) { 118 $options[$i] = $i; 119 } 120 $label = get_string('gradedecimals', 'workshop'); 121 $mform->addElement('select', 'gradedecimals', $label, $options); 122 $mform->setDefault('gradedecimals', $workshopconfig->gradedecimals); 123 124 // Submission settings -------------------------------------------------------- 125 $mform->addElement('header', 'submissionsettings', get_string('submissionsettings', 'workshop')); 126 127 $label = get_string('instructauthors', 'workshop'); 128 $mform->addElement('editor', 'instructauthorseditor', $label, null, 129 workshop::instruction_editors_options($this->context)); 130 131 $typeelements = []; 132 foreach (['submissiontypetext', 'submissiontypefile'] as $type) { 133 $available = $type . 'available'; 134 $required = $type . 'required'; 135 $availablelabel = get_string($available, 'workshop'); 136 $requiredlabel = get_string($required, 'workshop'); 137 $typeelements[] = $mform->createElement('advcheckbox', $available, '', $availablelabel); 138 $typeelements[] = $mform->createElement('advcheckbox', $required, '', $requiredlabel); 139 $mform->setDefault($available, 1); 140 } 141 // We can't use <br> as the separator as it does not work well in this case with the Boost theme. 142 // Instead, separate both tuples with a full-width empty div. 143 $mform->addGroup($typeelements, 'submissiontypes', get_string('submissiontypes', 'workshop'), 144 array(' ', '<div style="width:100%"></div>'), false); 145 146 $options = array(); 147 for ($i = 7; $i >= 1; $i--) { 148 $options[$i] = $i; 149 } 150 $label = get_string('nattachments', 'workshop'); 151 $mform->addElement('select', 'nattachments', $label, $options); 152 $mform->setDefault('nattachments', 1); 153 $mform->hideIf('nattachments', 'submissiontypefileavailable'); 154 155 $label = get_string('allowedfiletypesforsubmission', 'workshop'); 156 $mform->addElement('filetypes', 'submissionfiletypes', $label); 157 $mform->addHelpButton('submissionfiletypes', 'allowedfiletypesforsubmission', 'workshop'); 158 $mform->hideIf('submissionfiletypes', 'submissiontypefileavailable'); 159 160 $options = get_max_upload_sizes($CFG->maxbytes, $this->course->maxbytes, 0, $workshopconfig->maxbytes); 161 $mform->addElement('select', 'maxbytes', get_string('maxbytes', 'workshop'), $options); 162 $mform->setDefault('maxbytes', $workshopconfig->maxbytes); 163 $mform->hideIf('maxbytes', 'submissiontypefileavailable'); 164 165 $label = get_string('latesubmissions', 'workshop'); 166 $text = get_string('latesubmissions_desc', 'workshop'); 167 $mform->addElement('checkbox', 'latesubmissions', $label, $text); 168 $mform->addHelpButton('latesubmissions', 'latesubmissions', 'workshop'); 169 170 // Assessment settings -------------------------------------------------------- 171 $mform->addElement('header', 'assessmentsettings', get_string('assessmentsettings', 'workshop')); 172 173 $label = get_string('instructreviewers', 'workshop'); 174 $mform->addElement('editor', 'instructreviewerseditor', $label, null, 175 workshop::instruction_editors_options($this->context)); 176 177 $label = get_string('useselfassessment', 'workshop'); 178 $text = get_string('useselfassessment_desc', 'workshop'); 179 $mform->addElement('checkbox', 'useselfassessment', $label, $text); 180 $mform->addHelpButton('useselfassessment', 'useselfassessment', 'workshop'); 181 182 // Feedback ------------------------------------------------------------------- 183 $mform->addElement('header', 'feedbacksettings', get_string('feedbacksettings', 'workshop')); 184 185 $mform->addElement('select', 'overallfeedbackmode', get_string('overallfeedbackmode', 'mod_workshop'), array( 186 0 => get_string('overallfeedbackmode_0', 'mod_workshop'), 187 1 => get_string('overallfeedbackmode_1', 'mod_workshop'), 188 2 => get_string('overallfeedbackmode_2', 'mod_workshop'))); 189 $mform->addHelpButton('overallfeedbackmode', 'overallfeedbackmode', 'mod_workshop'); 190 $mform->setDefault('overallfeedbackmode', 1); 191 192 $options = array(); 193 for ($i = 7; $i >= 0; $i--) { 194 $options[$i] = $i; 195 } 196 $mform->addElement('select', 'overallfeedbackfiles', get_string('overallfeedbackfiles', 'workshop'), $options); 197 $mform->setDefault('overallfeedbackfiles', 0); 198 $mform->hideIf('overallfeedbackfiles', 'overallfeedbackmode', 'eq', 0); 199 200 $label = get_string('allowedfiletypesforoverallfeedback', 'workshop'); 201 $mform->addElement('filetypes', 'overallfeedbackfiletypes', $label); 202 $mform->addHelpButton('overallfeedbackfiletypes', 'allowedfiletypesforoverallfeedback', 'workshop'); 203 $mform->hideIf('overallfeedbackfiletypes', 'overallfeedbackfiles', 'eq', 0); 204 205 $options = get_max_upload_sizes($CFG->maxbytes, $this->course->maxbytes); 206 $mform->addElement('select', 'overallfeedbackmaxbytes', get_string('overallfeedbackmaxbytes', 'workshop'), $options); 207 $mform->setDefault('overallfeedbackmaxbytes', $workshopconfig->maxbytes); 208 $mform->hideIf('overallfeedbackmaxbytes', 'overallfeedbackmode', 'eq', 0); 209 $mform->hideIf('overallfeedbackmaxbytes', 'overallfeedbackfiles', 'eq', 0); 210 211 $label = get_string('conclusion', 'workshop'); 212 $mform->addElement('editor', 'conclusioneditor', $label, null, 213 workshop::instruction_editors_options($this->context)); 214 $mform->addHelpButton('conclusioneditor', 'conclusion', 'workshop'); 215 216 // Example submissions -------------------------------------------------------- 217 $mform->addElement('header', 'examplesubmissionssettings', get_string('examplesubmissions', 'workshop')); 218 219 $label = get_string('useexamples', 'workshop'); 220 $text = get_string('useexamples_desc', 'workshop'); 221 $mform->addElement('checkbox', 'useexamples', $label, $text); 222 $mform->addHelpButton('useexamples', 'useexamples', 'workshop'); 223 224 $label = get_string('examplesmode', 'workshop'); 225 $options = workshop::available_example_modes_list(); 226 $mform->addElement('select', 'examplesmode', $label, $options); 227 $mform->setDefault('examplesmode', $workshopconfig->examplesmode); 228 $mform->hideIf('examplesmode', 'useexamples'); 229 230 // Availability --------------------------------------------------------------- 231 $mform->addElement('header', 'accesscontrol', get_string('availability', 'core')); 232 233 $label = get_string('submissionstart', 'workshop'); 234 $mform->addElement('date_time_selector', 'submissionstart', $label, array('optional' => true)); 235 236 $label = get_string('submissionend', 'workshop'); 237 $mform->addElement('date_time_selector', 'submissionend', $label, array('optional' => true)); 238 239 $label = get_string('submissionendswitch', 'mod_workshop'); 240 $mform->addElement('checkbox', 'phaseswitchassessment', $label); 241 $mform->hideIf('phaseswitchassessment', 'submissionend[enabled]'); 242 $mform->addHelpButton('phaseswitchassessment', 'submissionendswitch', 'mod_workshop'); 243 244 $label = get_string('assessmentstart', 'workshop'); 245 $mform->addElement('date_time_selector', 'assessmentstart', $label, array('optional' => true)); 246 247 $label = get_string('assessmentend', 'workshop'); 248 $mform->addElement('date_time_selector', 'assessmentend', $label, array('optional' => true)); 249 250 $coursecontext = context_course::instance($this->course->id); 251 // To be removed (deprecated) with MDL-67526. 252 plagiarism_get_form_elements_module($mform, $coursecontext, 'mod_workshop'); 253 254 // Common module settings, Restrict availability, Activity completion etc. ---- 255 $features = array('groups' => true, 'groupings' => true, 256 'outcomes' => true, 'gradecat' => false, 'idnumber' => false); 257 258 $this->standard_coursemodule_elements(); 259 260 // Standard buttons, common to all modules ------------------------------------ 261 $this->add_action_buttons(); 262 263 $PAGE->requires->js_call_amd('mod_workshop/modform', 'init'); 264 } 265 266 /** 267 * Prepares the form before data are set 268 * 269 * Additional wysiwyg editor are prepared here, the introeditor is prepared automatically by core. 270 * Grade items are set here because the core modedit supports single grade item only. 271 * 272 * @param array $data to be set 273 * @return void 274 */ 275 public function data_preprocessing(&$data) { 276 if ($this->current->instance) { 277 // editing an existing workshop - let us prepare the added editor elements (intro done automatically) 278 $draftitemid = file_get_submitted_draft_itemid('instructauthors'); 279 $data['instructauthorseditor']['text'] = file_prepare_draft_area($draftitemid, $this->context->id, 280 'mod_workshop', 'instructauthors', 0, 281 workshop::instruction_editors_options($this->context), 282 $data['instructauthors']); 283 $data['instructauthorseditor']['format'] = $data['instructauthorsformat']; 284 $data['instructauthorseditor']['itemid'] = $draftitemid; 285 286 $draftitemid = file_get_submitted_draft_itemid('instructreviewers'); 287 $data['instructreviewerseditor']['text'] = file_prepare_draft_area($draftitemid, $this->context->id, 288 'mod_workshop', 'instructreviewers', 0, 289 workshop::instruction_editors_options($this->context), 290 $data['instructreviewers']); 291 $data['instructreviewerseditor']['format'] = $data['instructreviewersformat']; 292 $data['instructreviewerseditor']['itemid'] = $draftitemid; 293 294 $draftitemid = file_get_submitted_draft_itemid('conclusion'); 295 $data['conclusioneditor']['text'] = file_prepare_draft_area($draftitemid, $this->context->id, 296 'mod_workshop', 'conclusion', 0, 297 workshop::instruction_editors_options($this->context), 298 $data['conclusion']); 299 $data['conclusioneditor']['format'] = $data['conclusionformat']; 300 $data['conclusioneditor']['itemid'] = $draftitemid; 301 // Set submission type checkboxes. 302 foreach (['submissiontypetext', 'submissiontypefile'] as $type) { 303 $data[$type . 'available'] = 1; 304 $data[$type . 'required'] = 0; 305 if ($data[$type] == WORKSHOP_SUBMISSION_TYPE_DISABLED) { 306 $data[$type . 'available'] = 0; 307 } else if ($data[$type] == WORKSHOP_SUBMISSION_TYPE_REQUIRED) { 308 $data[$type . 'required'] = 1; 309 } 310 } 311 } else { 312 // adding a new workshop instance 313 $draftitemid = file_get_submitted_draft_itemid('instructauthors'); 314 file_prepare_draft_area($draftitemid, null, 'mod_workshop', 'instructauthors', 0); // no context yet, itemid not used 315 $data['instructauthorseditor'] = array('text' => '', 'format' => editors_get_preferred_format(), 'itemid' => $draftitemid); 316 317 $draftitemid = file_get_submitted_draft_itemid('instructreviewers'); 318 file_prepare_draft_area($draftitemid, null, 'mod_workshop', 'instructreviewers', 0); // no context yet, itemid not used 319 $data['instructreviewerseditor'] = array('text' => '', 'format' => editors_get_preferred_format(), 'itemid' => $draftitemid); 320 321 $draftitemid = file_get_submitted_draft_itemid('conclusion'); 322 file_prepare_draft_area($draftitemid, null, 'mod_workshop', 'conclusion', 0); // no context yet, itemid not used 323 $data['conclusioneditor'] = array('text' => '', 'format' => editors_get_preferred_format(), 'itemid' => $draftitemid); 324 } 325 } 326 327 /** 328 * Combine submission type checkboxes into integer values for the database. 329 * 330 * @param stdClass $data The submitted form data. 331 */ 332 public function data_postprocessing($data) { 333 parent::data_postprocessing($data); 334 335 foreach (['text', 'file'] as $type) { 336 $field = 'submissiontype' . $type; 337 $available = $field . 'available'; 338 $required = $field . 'required'; 339 if ($data->$required) { 340 $data->$field = WORKSHOP_SUBMISSION_TYPE_REQUIRED; 341 } else if ($data->$available) { 342 $data->$field = WORKSHOP_SUBMISSION_TYPE_AVAILABLE; 343 } else { 344 $data->$field = WORKSHOP_SUBMISSION_TYPE_DISABLED; 345 } 346 unset($data->$available); 347 unset($data->$required); 348 } 349 } 350 351 /** 352 * Set the grade item categories when editing an instance 353 */ 354 public function definition_after_data() { 355 356 $mform =& $this->_form; 357 358 if ($id = $mform->getElementValue('update')) { 359 $instance = $mform->getElementValue('instance'); 360 361 $gradeitems = grade_item::fetch_all(array( 362 'itemtype' => 'mod', 363 'itemmodule' => 'workshop', 364 'iteminstance' => $instance, 365 'courseid' => $this->course->id)); 366 367 if (!empty($gradeitems)) { 368 foreach ($gradeitems as $gradeitem) { 369 // here comes really crappy way how to set the value of the fields 370 // gradecategory and gradinggradecategory - grrr QuickForms 371 $decimalpoints = $gradeitem->get_decimals(); 372 if ($gradeitem->itemnumber == 0) { 373 $mform->setDefault('submissiongradepass', format_float($gradeitem->gradepass, $decimalpoints)); 374 $group = $mform->getElement('submissiongradegroup'); 375 $elements = $group->getElements(); 376 foreach ($elements as $element) { 377 if ($element->getName() == 'gradecategory') { 378 $element->setValue($gradeitem->categoryid); 379 } 380 } 381 } else if ($gradeitem->itemnumber == 1) { 382 $mform->setDefault('gradinggradepass', format_float($gradeitem->gradepass, $decimalpoints)); 383 $group = $mform->getElement('gradinggradegroup'); 384 $elements = $group->getElements(); 385 foreach ($elements as $element) { 386 if ($element->getName() == 'gradinggradecategory') { 387 $element->setValue($gradeitem->categoryid); 388 } 389 } 390 } 391 } 392 } 393 } 394 $typevalues = $mform->getElementValue('submissiontypes'); 395 foreach (['submissiontypetext', 'submissiontypefile'] as $type) { 396 // Don't leave a disabled "required" checkbox checked. 397 if (!$typevalues[$type . 'available']) { 398 $mform->setDefault($type . 'required', 0); 399 } 400 } 401 402 parent::definition_after_data(); 403 } 404 405 /** 406 * Validates the form input 407 * 408 * @param array $data submitted data 409 * @param array $files submitted files 410 * @return array eventual errors indexed by the field name 411 */ 412 public function validation($data, $files) { 413 $errors = parent::validation($data, $files); 414 415 // check the phases borders are valid 416 if ($data['submissionstart'] > 0 and $data['submissionend'] > 0 and $data['submissionstart'] >= $data['submissionend']) { 417 $errors['submissionend'] = get_string('submissionendbeforestart', 'mod_workshop'); 418 } 419 if ($data['assessmentstart'] > 0 and $data['assessmentend'] > 0 and $data['assessmentstart'] >= $data['assessmentend']) { 420 $errors['assessmentend'] = get_string('assessmentendbeforestart', 'mod_workshop'); 421 } 422 423 // check the phases do not overlap 424 if (max($data['submissionstart'], $data['submissionend']) > 0 and max($data['assessmentstart'], $data['assessmentend']) > 0) { 425 $phasesubmissionend = max($data['submissionstart'], $data['submissionend']); 426 $phaseassessmentstart = min($data['assessmentstart'], $data['assessmentend']); 427 if ($phaseassessmentstart == 0) { 428 $phaseassessmentstart = max($data['assessmentstart'], $data['assessmentend']); 429 } 430 if ($phasesubmissionend > 0 and $phaseassessmentstart > 0 and $phaseassessmentstart < $phasesubmissionend) { 431 foreach (array('submissionend', 'submissionstart', 'assessmentstart', 'assessmentend') as $f) { 432 if ($data[$f] > 0) { 433 $errors[$f] = get_string('phasesoverlap', 'mod_workshop'); 434 break; 435 } 436 } 437 } 438 } 439 440 // Check that the submission grade pass is a valid number. 441 if (!empty($data['submissiongradepass'])) { 442 $submissiongradefloat = unformat_float($data['submissiongradepass'], true); 443 if ($submissiongradefloat === false) { 444 $errors['submissiongradepass'] = get_string('err_numeric', 'form'); 445 } else { 446 if ($submissiongradefloat > $data['grade']) { 447 $errors['submissiongradepass'] = get_string('gradepassgreaterthangrade', 'grades', $data['grade']); 448 } 449 } 450 } 451 452 // Check that the grade pass is a valid number. 453 if (!empty($data['gradinggradepass'])) { 454 $gradepassfloat = unformat_float($data['gradinggradepass'], true); 455 if ($gradepassfloat === false) { 456 $errors['gradinggradepass'] = get_string('err_numeric', 'form'); 457 } else { 458 if ($gradepassfloat > $data['gradinggrade']) { 459 $errors['gradinggradepass'] = get_string('gradepassgreaterthangrade', 'grades', $data['gradinggrade']); 460 } 461 } 462 } 463 464 // We need to do a custom completion validation because workshop grade items identifiers divert from standard. 465 // Refer to validation defined in moodleform_mod.php. 466 if (isset($data['completionpassgrade']) && $data['completionpassgrade'] && 467 isset($data['completiongradeitemnumber'])) { 468 $itemnames = component_gradeitems::get_itemname_mapping_for_component('mod_workshop'); 469 $gradepassfield = $itemnames[(int) $data['completiongradeitemnumber']] . 'gradepass'; 470 // We need to make all the validations related with $gradepassfield 471 // with them being correct floats, keeping the originals unmodified for 472 // later validations / showing the form back... 473 // TODO: Note that once MDL-73994 is fixed we'll have to re-visit this and 474 // adapt the code below to the new values arriving here, without forgetting 475 // the special case of empties and nulls. 476 $gradepass = isset($data[$gradepassfield]) ? unformat_float($data[$gradepassfield]) : null; 477 if (is_null($gradepass) || $gradepass == 0) { 478 $errors['completionpassgrade'] = get_string( 479 'activitygradetopassnotset', 480 'completion' 481 ); 482 } else { 483 // We have validated grade pass. Unset any errors. 484 unset($errors['completionpassgrade']); 485 } 486 } 487 488 if (!$data['submissiontypetextavailable'] && !$data['submissiontypefileavailable']) { 489 // One submission type must be available. 490 $errors['submissiontypes'] = get_string('nosubmissiontype', 'workshop'); 491 } 492 493 return $errors; 494 } 495 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body