[Summary view] [Print] [Text view]

   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: http://docs.moodle.org/dev/lib/formslib.php
  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  /**
  36   * Module settings form for Workshop instances
  37   */
  38  class mod_workshop_mod_form extends moodleform_mod {
  39  
  40      /** @var object the course this instance is part of */
  41      protected $course = null;
  42  
  43      /**
  44       * Constructor
  45       */
  46      public function __construct($current, $section, $cm, $course) {
  47          $this->course = $course;
  48          parent::__construct($current, $section, $cm, $course);
  49      }
  50  
  51      /**
  52       * Defines the workshop instance configuration form
  53       *
  54       * @return void
  55       */
  56      public function definition() {
  57          global $CFG;
  58  
  59          $workshopconfig = get_config('workshop');
  60          $mform = $this->_form;
  61  
  62          // General --------------------------------------------------------------------
  63          $mform->addElement('header', 'general', get_string('general', 'form'));
  64  
  65          // Workshop name
  66          $label = get_string('workshopname', 'workshop');
  67          $mform->addElement('text', 'name', $label, array('size' => '64'));
  68          if (!empty($CFG->formatstringstriptags)) {
  69              $mform->setType('name', PARAM_TEXT);
  70          } else {
  71              $mform->setType('name', PARAM_CLEANHTML);
  72          }
  73          $mform->addRule('name', null, 'required', null, 'client');
  74          $mform->addRule('name', get_string('maximumchars', '', 255), 'maxlength', 255, 'client');
  75  
  76          // Introduction
  77          $this->standard_intro_elements(get_string('introduction', 'workshop'));
  78  
  79          // Grading settings -----------------------------------------------------------
  80          $mform->addElement('header', 'gradingsettings', get_string('gradingsettings', 'workshop'));
  81          $mform->setExpanded('gradingsettings');
  82  
  83          $label = get_string('strategy', 'workshop');
  84          $mform->addElement('select', 'strategy', $label, workshop::available_strategies_list());
  85          $mform->setDefault('strategy', $workshopconfig->strategy);
  86          $mform->addHelpButton('strategy', 'strategy', 'workshop');
  87  
  88          $grades = workshop::available_maxgrades_list();
  89          $gradecategories = grade_get_categories_menu($this->course->id);
  90  
  91          $label = get_string('submissiongrade', 'workshop');
  92          $mform->addGroup(array(
  93              $mform->createElement('select', 'grade', '', $grades),
  94              $mform->createElement('select', 'gradecategory', '', $gradecategories),
  95              ), 'submissiongradegroup', $label, ' ', false);
  96          $mform->setDefault('grade', $workshopconfig->grade);
  97          $mform->addHelpButton('submissiongradegroup', 'submissiongrade', 'workshop');
  98  
  99          $mform->addElement('text', 'submissiongradepass', get_string('gradetopasssubmission', 'workshop'));
 100          $mform->addHelpButton('submissiongradepass', 'gradepass', 'grades');
 101          $mform->setDefault('submissiongradepass', '');
 102          $mform->setType('submissiongradepass', PARAM_RAW);
 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('text', 'gradinggradepass', get_string('gradetopassgrading', 'workshop'));
 113          $mform->addHelpButton('gradinggradepass', 'gradepass', 'grades');
 114          $mform->setDefault('gradinggradepass', '');
 115          $mform->setType('gradinggradepass', PARAM_RAW);
 116  
 117          $options = array();
 118          for ($i = 5; $i >= 0; $i--) {
 119              $options[$i] = $i;
 120          }
 121          $label = get_string('gradedecimals', 'workshop');
 122          $mform->addElement('select', 'gradedecimals', $label, $options);
 123          $mform->setDefault('gradedecimals', $workshopconfig->gradedecimals);
 124  
 125          // Submission settings --------------------------------------------------------
 126          $mform->addElement('header', 'submissionsettings', get_string('submissionsettings', 'workshop'));
 127  
 128          $label = get_string('instructauthors', 'workshop');
 129          $mform->addElement('editor', 'instructauthorseditor', $label, null,
 130                              workshop::instruction_editors_options($this->context));
 131  
 132          $options = array();
 133          for ($i = 7; $i >= 0; $i--) {
 134              $options[$i] = $i;
 135          }
 136          $label = get_string('nattachments', 'workshop');
 137          $mform->addElement('select', 'nattachments', $label, $options);
 138          $mform->setDefault('nattachments', 1);
 139  
 140          $label = get_string('allowedfiletypesforsubmission', 'workshop');
 141          $mform->addElement('text', 'submissionfiletypes', $label, array('maxlength' => 255, 'size' => 64));
 142          $mform->addHelpButton('submissionfiletypes', 'allowedfiletypesforsubmission', 'workshop');
 143          $mform->setType('submissionfiletypes', PARAM_TEXT);
 144          $mform->addRule('submissionfiletypes', get_string('maximumchars', '', 255), 'maxlength', 255, 'client');
 145          $mform->disabledIf('submissionfiletypes', 'nattachments', 'eq', 0);
 146  
 147          $options = get_max_upload_sizes($CFG->maxbytes, $this->course->maxbytes, 0, $workshopconfig->maxbytes);
 148          $mform->addElement('select', 'maxbytes', get_string('maxbytes', 'workshop'), $options);
 149          $mform->setDefault('maxbytes', $workshopconfig->maxbytes);
 150          $mform->disabledIf('maxbytes', 'nattachments', 'eq', 0);
 151  
 152          $label = get_string('latesubmissions', 'workshop');
 153          $text = get_string('latesubmissions_desc', 'workshop');
 154          $mform->addElement('checkbox', 'latesubmissions', $label, $text);
 155          $mform->addHelpButton('latesubmissions', 'latesubmissions', 'workshop');
 156  
 157          // Assessment settings --------------------------------------------------------
 158          $mform->addElement('header', 'assessmentsettings', get_string('assessmentsettings', 'workshop'));
 159  
 160          $label = get_string('instructreviewers', 'workshop');
 161          $mform->addElement('editor', 'instructreviewerseditor', $label, null,
 162                              workshop::instruction_editors_options($this->context));
 163  
 164          $label = get_string('useselfassessment', 'workshop');
 165          $text = get_string('useselfassessment_desc', 'workshop');
 166          $mform->addElement('checkbox', 'useselfassessment', $label, $text);
 167          $mform->addHelpButton('useselfassessment', 'useselfassessment', 'workshop');
 168  
 169          // Feedback -------------------------------------------------------------------
 170          $mform->addElement('header', 'feedbacksettings', get_string('feedbacksettings', 'workshop'));
 171  
 172          $mform->addElement('select', 'overallfeedbackmode', get_string('overallfeedbackmode', 'mod_workshop'), array(
 173              0 => get_string('overallfeedbackmode_0', 'mod_workshop'),
 174              1 => get_string('overallfeedbackmode_1', 'mod_workshop'),
 175              2 => get_string('overallfeedbackmode_2', 'mod_workshop')));
 176          $mform->addHelpButton('overallfeedbackmode', 'overallfeedbackmode', 'mod_workshop');
 177          $mform->setDefault('overallfeedbackmode', 1);
 178  
 179          $options = array();
 180          for ($i = 7; $i >= 0; $i--) {
 181              $options[$i] = $i;
 182          }
 183          $mform->addElement('select', 'overallfeedbackfiles', get_string('overallfeedbackfiles', 'workshop'), $options);
 184          $mform->setDefault('overallfeedbackfiles', 0);
 185          $mform->disabledIf('overallfeedbackfiles', 'overallfeedbackmode', 'eq', 0);
 186  
 187          $label = get_string('allowedfiletypesforoverallfeedback', 'workshop');
 188          $mform->addElement('text', 'overallfeedbackfiletypes', $label, array('maxlength' => 255, 'size' => 64));
 189          $mform->addHelpButton('overallfeedbackfiletypes', 'allowedfiletypesforoverallfeedback', 'workshop');
 190          $mform->setType('overallfeedbackfiletypes', PARAM_TEXT);
 191          $mform->addRule('overallfeedbackfiletypes', get_string('maximumchars', '', 255), 'maxlength', 255, 'client');
 192          $mform->disabledIf('overallfeedbackfiletypes', 'overallfeedbackfiles', 'eq', 0);
 193  
 194          $options = get_max_upload_sizes($CFG->maxbytes, $this->course->maxbytes);
 195          $mform->addElement('select', 'overallfeedbackmaxbytes', get_string('overallfeedbackmaxbytes', 'workshop'), $options);
 196          $mform->setDefault('overallfeedbackmaxbytes', $workshopconfig->maxbytes);
 197          $mform->disabledIf('overallfeedbackmaxbytes', 'overallfeedbackmode', 'eq', 0);
 198          $mform->disabledIf('overallfeedbackmaxbytes', 'overallfeedbackfiles', 'eq', 0);
 199  
 200          $label = get_string('conclusion', 'workshop');
 201          $mform->addElement('editor', 'conclusioneditor', $label, null,
 202                              workshop::instruction_editors_options($this->context));
 203          $mform->addHelpButton('conclusioneditor', 'conclusion', 'workshop');
 204  
 205          // Example submissions --------------------------------------------------------
 206          $mform->addElement('header', 'examplesubmissionssettings', get_string('examplesubmissions', 'workshop'));
 207  
 208          $label = get_string('useexamples', 'workshop');
 209          $text = get_string('useexamples_desc', 'workshop');
 210          $mform->addElement('checkbox', 'useexamples', $label, $text);
 211          $mform->addHelpButton('useexamples', 'useexamples', 'workshop');
 212  
 213          $label = get_string('examplesmode', 'workshop');
 214          $options = workshop::available_example_modes_list();
 215          $mform->addElement('select', 'examplesmode', $label, $options);
 216          $mform->setDefault('examplesmode', $workshopconfig->examplesmode);
 217          $mform->disabledIf('examplesmode', 'useexamples');
 218  
 219          // Availability ---------------------------------------------------------------
 220          $mform->addElement('header', 'accesscontrol', get_string('availability', 'core'));
 221  
 222          $label = get_string('submissionstart', 'workshop');
 223          $mform->addElement('date_time_selector', 'submissionstart', $label, array('optional' => true));
 224  
 225          $label = get_string('submissionend', 'workshop');
 226          $mform->addElement('date_time_selector', 'submissionend', $label, array('optional' => true));
 227  
 228          $label = get_string('submissionendswitch', 'mod_workshop');
 229          $mform->addElement('checkbox', 'phaseswitchassessment', $label);
 230          $mform->disabledIf('phaseswitchassessment', 'submissionend[enabled]');
 231          $mform->addHelpButton('phaseswitchassessment', 'submissionendswitch', 'mod_workshop');
 232  
 233          $label = get_string('assessmentstart', 'workshop');
 234          $mform->addElement('date_time_selector', 'assessmentstart', $label, array('optional' => true));
 235  
 236          $label = get_string('assessmentend', 'workshop');
 237          $mform->addElement('date_time_selector', 'assessmentend', $label, array('optional' => true));
 238  
 239          $coursecontext = context_course::instance($this->course->id);
 240          plagiarism_get_form_elements_module($mform, $coursecontext, 'mod_workshop');
 241  
 242          // Common module settings, Restrict availability, Activity completion etc. ----
 243          $features = array('groups' => true, 'groupings' => true,
 244                  'outcomes' => true, 'gradecat' => false, 'idnumber' => false);
 245  
 246          $this->standard_coursemodule_elements();
 247  
 248          // Standard buttons, common to all modules ------------------------------------
 249          $this->add_action_buttons();
 250      }
 251  
 252      /**
 253       * Prepares the form before data are set
 254       *
 255       * Additional wysiwyg editor are prepared here, the introeditor is prepared automatically by core.
 256       * Grade items are set here because the core modedit supports single grade item only.
 257       *
 258       * @param array $data to be set
 259       * @return void
 260       */
 261      public function data_preprocessing(&$data) {
 262          if ($this->current->instance) {
 263              // editing an existing workshop - let us prepare the added editor elements (intro done automatically)
 264              $draftitemid = file_get_submitted_draft_itemid('instructauthors');
 265              $data['instructauthorseditor']['text'] = file_prepare_draft_area($draftitemid, $this->context->id,
 266                                  'mod_workshop', 'instructauthors', 0,
 267                                  workshop::instruction_editors_options($this->context),
 268                                  $data['instructauthors']);
 269              $data['instructauthorseditor']['format'] = $data['instructauthorsformat'];
 270              $data['instructauthorseditor']['itemid'] = $draftitemid;
 271  
 272              $draftitemid = file_get_submitted_draft_itemid('instructreviewers');
 273              $data['instructreviewerseditor']['text'] = file_prepare_draft_area($draftitemid, $this->context->id,
 274                                  'mod_workshop', 'instructreviewers', 0,
 275                                  workshop::instruction_editors_options($this->context),
 276                                  $data['instructreviewers']);
 277              $data['instructreviewerseditor']['format'] = $data['instructreviewersformat'];
 278              $data['instructreviewerseditor']['itemid'] = $draftitemid;
 279  
 280              $draftitemid = file_get_submitted_draft_itemid('conclusion');
 281              $data['conclusioneditor']['text'] = file_prepare_draft_area($draftitemid, $this->context->id,
 282                                  'mod_workshop', 'conclusion', 0,
 283                                  workshop::instruction_editors_options($this->context),
 284                                  $data['conclusion']);
 285              $data['conclusioneditor']['format'] = $data['conclusionformat'];
 286              $data['conclusioneditor']['itemid'] = $draftitemid;
 287          } else {
 288              // adding a new workshop instance
 289              $draftitemid = file_get_submitted_draft_itemid('instructauthors');
 290              file_prepare_draft_area($draftitemid, null, 'mod_workshop', 'instructauthors', 0);    // no context yet, itemid not used
 291              $data['instructauthorseditor'] = array('text' => '', 'format' => editors_get_preferred_format(), 'itemid' => $draftitemid);
 292  
 293              $draftitemid = file_get_submitted_draft_itemid('instructreviewers');
 294              file_prepare_draft_area($draftitemid, null, 'mod_workshop', 'instructreviewers', 0);    // no context yet, itemid not used
 295              $data['instructreviewerseditor'] = array('text' => '', 'format' => editors_get_preferred_format(), 'itemid' => $draftitemid);
 296  
 297              $draftitemid = file_get_submitted_draft_itemid('conclusion');
 298              file_prepare_draft_area($draftitemid, null, 'mod_workshop', 'conclusion', 0);    // no context yet, itemid not used
 299              $data['conclusioneditor'] = array('text' => '', 'format' => editors_get_preferred_format(), 'itemid' => $draftitemid);
 300          }
 301      }
 302  
 303      /**
 304       * Set the grade item categories when editing an instance
 305       */
 306      public function definition_after_data() {
 307  
 308          $mform =& $this->_form;
 309  
 310          if ($id = $mform->getElementValue('update')) {
 311              $instance   = $mform->getElementValue('instance');
 312  
 313              $gradeitems = grade_item::fetch_all(array(
 314                  'itemtype'      => 'mod',
 315                  'itemmodule'    => 'workshop',
 316                  'iteminstance'  => $instance,
 317                  'courseid'      => $this->course->id));
 318  
 319              if (!empty($gradeitems)) {
 320                  foreach ($gradeitems as $gradeitem) {
 321                      // here comes really crappy way how to set the value of the fields
 322                      // gradecategory and gradinggradecategory - grrr QuickForms
 323                      $decimalpoints = $gradeitem->get_decimals();
 324                      if ($gradeitem->itemnumber == 0) {
 325                          $submissiongradepass = $mform->getElement('submissiongradepass');
 326                          $submissiongradepass->setValue(format_float($gradeitem->gradepass, $decimalpoints));
 327                          $group = $mform->getElement('submissiongradegroup');
 328                          $elements = $group->getElements();
 329                          foreach ($elements as $element) {
 330                              if ($element->getName() == 'gradecategory') {
 331                                  $element->setValue($gradeitem->categoryid);
 332                              }
 333                          }
 334                      } else if ($gradeitem->itemnumber == 1) {
 335                          $gradinggradepass = $mform->getElement('gradinggradepass');
 336                          $gradinggradepass->setValue(format_float($gradeitem->gradepass, $decimalpoints));
 337                          $group = $mform->getElement('gradinggradegroup');
 338                          $elements = $group->getElements();
 339                          foreach ($elements as $element) {
 340                              if ($element->getName() == 'gradinggradecategory') {
 341                                  $element->setValue($gradeitem->categoryid);
 342                              }
 343                          }
 344                      }
 345                  }
 346              }
 347          }
 348  
 349          parent::definition_after_data();
 350      }
 351  
 352      /**
 353       * Validates the form input
 354       *
 355       * @param array $data submitted data
 356       * @param array $files submitted files
 357       * @return array eventual errors indexed by the field name
 358       */
 359      public function validation($data, $files) {
 360          $errors = parent::validation($data, $files);
 361  
 362          // Validate lists of allowed extensions.
 363          foreach (array('submissionfiletypes', 'overallfeedbackfiletypes') as $fieldname) {
 364              if (isset($data[$fieldname])) {
 365                  $invalidextensions = workshop::invalid_file_extensions($data[$fieldname], array_keys(core_filetypes::get_types()));
 366                  if ($invalidextensions) {
 367                      $errors[$fieldname] = get_string('err_unknownfileextension', 'mod_workshop',
 368                          workshop::clean_file_extensions($invalidextensions));
 369                  }
 370              }
 371          }
 372  
 373          // check the phases borders are valid
 374          if ($data['submissionstart'] > 0 and $data['submissionend'] > 0 and $data['submissionstart'] >= $data['submissionend']) {
 375              $errors['submissionend'] = get_string('submissionendbeforestart', 'mod_workshop');
 376          }
 377          if ($data['assessmentstart'] > 0 and $data['assessmentend'] > 0 and $data['assessmentstart'] >= $data['assessmentend']) {
 378              $errors['assessmentend'] = get_string('assessmentendbeforestart', 'mod_workshop');
 379          }
 380  
 381          // check the phases do not overlap
 382          if (max($data['submissionstart'], $data['submissionend']) > 0 and max($data['assessmentstart'], $data['assessmentend']) > 0) {
 383              $phasesubmissionend = max($data['submissionstart'], $data['submissionend']);
 384              $phaseassessmentstart = min($data['assessmentstart'], $data['assessmentend']);
 385              if ($phaseassessmentstart == 0) {
 386                  $phaseassessmentstart = max($data['assessmentstart'], $data['assessmentend']);
 387              }
 388              if ($phasesubmissionend > 0 and $phaseassessmentstart > 0 and $phaseassessmentstart < $phasesubmissionend) {
 389                  foreach (array('submissionend', 'submissionstart', 'assessmentstart', 'assessmentend') as $f) {
 390                      if ($data[$f] > 0) {
 391                          $errors[$f] = get_string('phasesoverlap', 'mod_workshop');
 392                          break;
 393                      }
 394                  }
 395              }
 396          }
 397  
 398          // Check that the submission grade pass is a valid number.
 399          if (!empty($data['submissiongradepass'])) {
 400              $submissiongradefloat = unformat_float($data['submissiongradepass'], true);
 401              if ($submissiongradefloat === false) {
 402                  $errors['submissiongradepass'] = get_string('err_numeric', 'form');
 403              } else {
 404                  if ($submissiongradefloat > $data['grade']) {
 405                      $errors['submissiongradepass'] = get_string('gradepassgreaterthangrade', 'grades', $data['grade']);
 406                  }
 407              }
 408          }
 409  
 410          // Check that the grade pass is a valid number.
 411          if (!empty($data['gradinggradepass'])) {
 412              $gradepassfloat = unformat_float($data['gradinggradepass'], true);
 413              if ($gradepassfloat === false) {
 414                  $errors['gradinggradepass'] = get_string('err_numeric', 'form');
 415              } else {
 416                  if ($gradepassfloat > $data['gradinggrade']) {
 417                      $errors['gradinggradepass'] = get_string('gradepassgreaterthangrade', 'grades', $data['gradinggrade']);
 418                  }
 419              }
 420          }
 421  
 422          return $errors;
 423      }
 424  }