[ Index ]

PHP Cross Reference of Unnamed Project

title

Body

[close]

/grade/edit/tree/ -> item_form.php (source)

   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   * A moodleform allowing the editing of the grade options for an individual grade item
  19   *
  20   * @package   core_grades
  21   * @copyright 2007 Petr Skoda
  22   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  if (!defined('MOODLE_INTERNAL')) {
  26      die('Direct access to this script is forbidden.');    ///  It must be included from a Moodle page
  27  }
  28  
  29  require_once $CFG->libdir.'/formslib.php';
  30  
  31  class edit_item_form extends moodleform {
  32      private $displayoptions;
  33  
  34      function definition() {
  35          global $COURSE, $CFG, $DB;
  36  
  37          $mform =& $this->_form;
  38  
  39          $item = $this->_customdata['current'];
  40  
  41  /// visible elements
  42          $mform->addElement('header', 'general', get_string('gradeitem', 'grades'));
  43  
  44          $mform->addElement('text', 'itemname', get_string('itemname', 'grades'));
  45          $mform->setType('itemname', PARAM_TEXT);
  46          $mform->addElement('text', 'iteminfo', get_string('iteminfo', 'grades'));
  47          $mform->addHelpButton('iteminfo', 'iteminfo', 'grades');
  48          $mform->setType('iteminfo', PARAM_TEXT);
  49  
  50          $mform->addElement('text', 'idnumber', get_string('idnumbermod'));
  51          $mform->addHelpButton('idnumber', 'idnumbermod');
  52          $mform->setType('idnumber', PARAM_RAW);
  53  
  54          if (!empty($item->id)) {
  55              $gradeitem = new grade_item(array('id' => $item->id, 'courseid' => $item->courseid));
  56              // If grades exist set a message so the user knows why they can not alter the grade type or scale.
  57              // We could never change the grade type for external items, so only need to show this for manual grade items.
  58              if ($gradeitem->has_grades() && !$gradeitem->is_external_item()) {
  59                  // Set a message so the user knows why they can not alter the grade type or scale.
  60                  if ($gradeitem->gradetype == GRADE_TYPE_SCALE) {
  61                      $gradesexistmsg = get_string('modgradecantchangegradetyporscalemsg', 'grades');
  62                  } else {
  63                      $gradesexistmsg = get_string('modgradecantchangegradetypemsg', 'grades');
  64                  }
  65  
  66                  $gradesexisthtml = '<div class=\'alert\'>' . $gradesexistmsg . '</div>';
  67                  $mform->addElement('static', 'gradesexistmsg', '', $gradesexisthtml);
  68              }
  69          }
  70  
  71          // Manual grade items cannot have grade type GRADE_TYPE_NONE.
  72          $options = array(GRADE_TYPE_VALUE => get_string('typevalue', 'grades'),
  73                           GRADE_TYPE_SCALE => get_string('typescale', 'grades'),
  74                           GRADE_TYPE_TEXT => get_string('typetext', 'grades'));
  75  
  76          $mform->addElement('select', 'gradetype', get_string('gradetype', 'grades'), $options);
  77          $mform->addHelpButton('gradetype', 'gradetype', 'grades');
  78          $mform->setDefault('gradetype', GRADE_TYPE_VALUE);
  79  
  80          //$mform->addElement('text', 'calculation', get_string('calculation', 'grades'));
  81          //$mform->disabledIf('calculation', 'gradetype', 'eq', GRADE_TYPE_TEXT);
  82          //$mform->disabledIf('calculation', 'gradetype', 'eq', GRADE_TYPE_NONE);
  83  
  84          $options = array(0=>get_string('usenoscale', 'grades'));
  85          if ($scales = grade_scale::fetch_all_local($COURSE->id)) {
  86              foreach ($scales as $scale) {
  87                  $options[$scale->id] = $scale->get_name();
  88              }
  89          }
  90          if ($scales = grade_scale::fetch_all_global()) {
  91              foreach ($scales as $scale) {
  92                  $options[$scale->id] = $scale->get_name();
  93              }
  94          }
  95          // ugly BC hack - it was possible to use custom scale from other courses :-(
  96          if (!empty($item->scaleid) and !isset($options[$item->scaleid])) {
  97              if ($scale = grade_scale::fetch(array('id'=>$item->scaleid))) {
  98                  $options[$scale->id] = $scale->get_name().get_string('incorrectcustomscale', 'grades');
  99              }
 100          }
 101          $mform->addElement('select', 'scaleid', get_string('scale'), $options);
 102          $mform->addHelpButton('scaleid', 'typescale', 'grades');
 103          $mform->disabledIf('scaleid', 'gradetype', 'noteq', GRADE_TYPE_SCALE);
 104  
 105          $choices = array();
 106          $choices[''] = get_string('choose');
 107          $choices['no'] = get_string('no');
 108          $choices['yes'] = get_string('yes');
 109          $mform->addElement('select', 'rescalegrades', get_string('modgraderescalegrades', 'grades'), $choices);
 110          $mform->addHelpButton('rescalegrades', 'modgraderescalegrades', 'grades');
 111          $mform->disabledIf('rescalegrades', 'gradetype', 'noteq', GRADE_TYPE_VALUE);
 112  
 113          $mform->addElement('text', 'grademax', get_string('grademax', 'grades'));
 114          $mform->addHelpButton('grademax', 'grademax', 'grades');
 115          $mform->disabledIf('grademax', 'gradetype', 'noteq', GRADE_TYPE_VALUE);
 116          $mform->setType('grademax', PARAM_RAW);
 117  
 118          if ((bool) get_config('moodle', 'grade_report_showmin')) {
 119              $mform->addElement('text', 'grademin', get_string('grademin', 'grades'));
 120              $mform->addHelpButton('grademin', 'grademin', 'grades');
 121              $mform->disabledIf('grademin', 'gradetype', 'noteq', GRADE_TYPE_VALUE);
 122              $mform->setType('grademin', PARAM_RAW);
 123          }
 124  
 125          $mform->addElement('text', 'gradepass', get_string('gradepass', 'grades'));
 126          $mform->addHelpButton('gradepass', 'gradepass', 'grades');
 127          $mform->disabledIf('gradepass', 'gradetype', 'eq', GRADE_TYPE_NONE);
 128          $mform->disabledIf('gradepass', 'gradetype', 'eq', GRADE_TYPE_TEXT);
 129          $mform->setType('gradepass', PARAM_RAW);
 130  
 131          $mform->addElement('text', 'multfactor', get_string('multfactor', 'grades'));
 132          $mform->addHelpButton('multfactor', 'multfactor', 'grades');
 133          $mform->setAdvanced('multfactor');
 134          $mform->disabledIf('multfactor', 'gradetype', 'eq', GRADE_TYPE_NONE);
 135          $mform->disabledIf('multfactor', 'gradetype', 'eq', GRADE_TYPE_TEXT);
 136          $mform->setType('multfactor', PARAM_RAW);
 137  
 138          $mform->addElement('text', 'plusfactor', get_string('plusfactor', 'grades'));
 139          $mform->addHelpButton('plusfactor', 'plusfactor', 'grades');
 140          $mform->setAdvanced('plusfactor');
 141          $mform->disabledIf('plusfactor', 'gradetype', 'eq', GRADE_TYPE_NONE);
 142          $mform->disabledIf('plusfactor', 'gradetype', 'eq', GRADE_TYPE_TEXT);
 143          $mform->setType('plusfactor', PARAM_RAW);
 144  
 145          /// grade display prefs
 146          $default_gradedisplaytype = grade_get_setting($COURSE->id, 'displaytype', $CFG->grade_displaytype);
 147          $options = array(GRADE_DISPLAY_TYPE_DEFAULT            => get_string('default', 'grades'),
 148                           GRADE_DISPLAY_TYPE_REAL               => get_string('real', 'grades'),
 149                           GRADE_DISPLAY_TYPE_PERCENTAGE         => get_string('percentage', 'grades'),
 150                           GRADE_DISPLAY_TYPE_LETTER             => get_string('letter', 'grades'),
 151                           GRADE_DISPLAY_TYPE_REAL_PERCENTAGE    => get_string('realpercentage', 'grades'),
 152                           GRADE_DISPLAY_TYPE_REAL_LETTER        => get_string('realletter', 'grades'),
 153                           GRADE_DISPLAY_TYPE_LETTER_REAL        => get_string('letterreal', 'grades'),
 154                           GRADE_DISPLAY_TYPE_LETTER_PERCENTAGE  => get_string('letterpercentage', 'grades'),
 155                           GRADE_DISPLAY_TYPE_PERCENTAGE_LETTER  => get_string('percentageletter', 'grades'),
 156                           GRADE_DISPLAY_TYPE_PERCENTAGE_REAL    => get_string('percentagereal', 'grades')
 157                           );
 158  
 159          asort($options);
 160  
 161          foreach ($options as $key=>$option) {
 162              if ($key == $default_gradedisplaytype) {
 163                  $options[GRADE_DISPLAY_TYPE_DEFAULT] = get_string('defaultprev', 'grades', $option);
 164                  break;
 165              }
 166          }
 167          $mform->addElement('select', 'display', get_string('gradedisplaytype', 'grades'), $options);
 168          $mform->addHelpButton('display', 'gradedisplaytype', 'grades');
 169  
 170          $default_gradedecimals = grade_get_setting($COURSE->id, 'decimalpoints', $CFG->grade_decimalpoints);
 171          $options = array(-1=>get_string('defaultprev', 'grades', $default_gradedecimals), 0=>0, 1=>1, 2=>2, 3=>3, 4=>4, 5=>5);
 172          $mform->addElement('select', 'decimals', get_string('decimalpoints', 'grades'), $options);
 173          $mform->addHelpButton('decimals', 'decimalpoints', 'grades');
 174          $mform->setDefault('decimals', -1);
 175          $mform->disabledIf('decimals', 'display', 'eq', GRADE_DISPLAY_TYPE_LETTER);
 176          if ($default_gradedisplaytype == GRADE_DISPLAY_TYPE_LETTER) {
 177              $mform->disabledIf('decimals', 'display', "eq", GRADE_DISPLAY_TYPE_DEFAULT);
 178          }
 179  
 180          /// hiding
 181          if ($item->cancontrolvisibility) {
 182              // advcheckbox is not compatible with disabledIf!
 183              $mform->addElement('checkbox', 'hidden', get_string('hidden', 'grades'));
 184              $mform->addElement('date_time_selector', 'hiddenuntil', get_string('hiddenuntil', 'grades'), array('optional'=>true));
 185              $mform->disabledIf('hidden', 'hiddenuntil[off]', 'notchecked');
 186          } else {
 187              $mform->addElement('static', 'hidden', get_string('hidden', 'grades'),
 188                      get_string('componentcontrolsvisibility', 'grades'));
 189              // Unset hidden to avoid data override.
 190              unset($item->hidden);
 191          }
 192          $mform->addHelpButton('hidden', 'hidden', 'grades');
 193  
 194          /// locking
 195          $mform->addElement('advcheckbox', 'locked', get_string('locked', 'grades'));
 196          $mform->addHelpButton('locked', 'locked', 'grades');
 197  
 198          $mform->addElement('date_time_selector', 'locktime', get_string('locktime', 'grades'), array('optional'=>true));
 199          $mform->disabledIf('locktime', 'gradetype', 'eq', GRADE_TYPE_NONE);
 200  
 201  /// parent category related settings
 202          $mform->addElement('header', 'headerparent', get_string('parentcategory', 'grades'));
 203  
 204          $mform->addElement('advcheckbox', 'weightoverride', get_string('adjustedweight', 'grades'));
 205          $mform->addHelpButton('weightoverride', 'weightoverride', 'grades');
 206          $mform->disabledIf('weightoverride', 'gradetype', 'eq', GRADE_TYPE_NONE);
 207          $mform->disabledIf('weightoverride', 'gradetype', 'eq', GRADE_TYPE_TEXT);
 208  
 209          $mform->addElement('text', 'aggregationcoef2', get_string('weight', 'grades'));
 210          $mform->addHelpButton('aggregationcoef2', 'weight', 'grades');
 211          $mform->setType('aggregationcoef2', PARAM_RAW);
 212          $mform->disabledIf('aggregationcoef2', 'weightoverride');
 213          $mform->disabledIf('aggregationcoef2', 'gradetype', 'eq', GRADE_TYPE_NONE);
 214          $mform->disabledIf('aggregationcoef2', 'gradetype', 'eq', GRADE_TYPE_TEXT);
 215  
 216          $options = array();
 217          $coefstring = '';
 218          $categories = grade_category::fetch_all(array('courseid'=>$COURSE->id));
 219  
 220          foreach ($categories as $cat) {
 221              $cat->apply_forced_settings();
 222              $options[$cat->id] = $cat->get_name();
 223          }
 224  
 225          if (count($categories) > 1) {
 226              $mform->addElement('select', 'parentcategory', get_string('gradecategory', 'grades'), $options);
 227          }
 228  
 229  /// hidden params
 230          $mform->addElement('hidden', 'id', 0);
 231          $mform->setType('id', PARAM_INT);
 232  
 233          $mform->addElement('hidden', 'courseid', $COURSE->id);
 234          $mform->setType('courseid', PARAM_INT);
 235  
 236          $mform->addElement('hidden', 'itemtype', 'manual'); // all new items are manual only
 237          $mform->setType('itemtype', PARAM_ALPHA);
 238  
 239  /// add return tracking info
 240          $gpr = $this->_customdata['gpr'];
 241          $gpr->add_mform_elements($mform);
 242  
 243  /// mark advanced according to site settings
 244          if (isset($CFG->grade_item_advanced)) {
 245              $advanced = explode(',', $CFG->grade_item_advanced);
 246              foreach ($advanced as $el) {
 247                  if ($mform->elementExists($el)) {
 248                      $mform->setAdvanced($el);
 249                  }
 250              }
 251          }
 252  //-------------------------------------------------------------------------------
 253          // buttons
 254          $this->add_action_buttons();
 255  //-------------------------------------------------------------------------------
 256          $this->set_data($item);
 257      }
 258  
 259  
 260  /// tweak the form - depending on existing data
 261      function definition_after_data() {
 262          global $CFG, $COURSE;
 263  
 264          $mform =& $this->_form;
 265  
 266          if ($id = $mform->getElementValue('id')) {
 267              $grade_item = grade_item::fetch(array('id'=>$id));
 268  
 269              if (!$grade_item->is_raw_used()) {
 270                  $mform->removeElement('plusfactor');
 271                  $mform->removeElement('multfactor');
 272              }
 273  
 274              if ($grade_item->is_outcome_item()) {
 275                  // we have to prevent incompatible modifications of outcomes if outcomes disabled
 276                  $mform->removeElement('grademax');
 277                  if ($mform->elementExists('grademin')) {
 278                      $mform->removeElement('grademin');
 279                  }
 280                  $mform->removeElement('gradetype');
 281                  $mform->removeElement('display');
 282                  $mform->removeElement('decimals');
 283                  $mform->hardFreeze('scaleid');
 284  
 285              } else {
 286                  if ($grade_item->is_external_item()) {
 287                      // following items are set up from modules and should not be overrided by user
 288                      if ($mform->elementExists('grademin')) {
 289                          // The site setting grade_report_showmin may have prevented grademin being added to the form.
 290                          $mform->hardFreeze('grademin');
 291                      }
 292                      $mform->hardFreeze('itemname,gradetype,grademax,scaleid');
 293                      if ($grade_item->itemnumber == 0) {
 294                          // the idnumber of grade itemnumber 0 is synced with course_modules
 295                          $mform->hardFreeze('idnumber');
 296                      }
 297  
 298                      // For external items we can not change the grade type, even if no grades exist, so if it is set to
 299                      // scale, then remove the grademax and grademin fields from the form - no point displaying them.
 300                      if ($grade_item->gradetype == GRADE_TYPE_SCALE) {
 301                          $mform->removeElement('grademax');
 302                          if ($mform->elementExists('grademin')) {
 303                              $mform->removeElement('grademin');
 304                          }
 305                      } else { // Not using scale, so remove it.
 306                          $mform->removeElement('scaleid');
 307                      }
 308  
 309                      // Always remove the rescale grades element if it's an external item.
 310                      $mform->removeElement('rescalegrades');
 311                  } else if ($grade_item->has_grades()) {
 312                      // Can't change the grade type or the scale if there are grades.
 313                      $mform->hardFreeze('gradetype, scaleid');
 314  
 315                      // If we are using scales then remove the unnecessary rescale and grade fields.
 316                      if ($grade_item->gradetype == GRADE_TYPE_SCALE) {
 317                          $mform->removeElement('rescalegrades');
 318                          $mform->removeElement('grademax');
 319                          if ($mform->elementExists('grademin')) {
 320                              $mform->removeElement('grademin');
 321                          }
 322                      } else { // Remove the scale field.
 323                          $mform->removeElement('scaleid');
 324                          // Set the maximum grade to disabled unless a grade is chosen.
 325                          $mform->disabledIf('grademax', 'rescalegrades', 'eq', '');
 326                      }
 327                  } else {
 328                      // Remove the rescale element if there are no grades.
 329                      $mform->removeElement('rescalegrades');
 330                  }
 331              }
 332  
 333              // if we wanted to change parent of existing item - we would have to verify there are no circular references in parents!!!
 334              if ($mform->elementExists('parentcategory')) {
 335                  $mform->hardFreeze('parentcategory');
 336              }
 337  
 338              $parent_category = $grade_item->get_parent_category();
 339              $parent_category->apply_forced_settings();
 340  
 341              if (!$parent_category->is_aggregationcoef_used()) {
 342                  if ($mform->elementExists('aggregationcoef')) {
 343                      $mform->removeElement('aggregationcoef');
 344                  }
 345  
 346              } else {
 347                  $coefstring = $grade_item->get_coefstring();
 348  
 349                  if ($coefstring !== '') {
 350                      if ($coefstring == 'aggregationcoefextrasum' || $coefstring == 'aggregationcoefextraweightsum') {
 351                          // advcheckbox is not compatible with disabledIf!
 352                          $coefstring = 'aggregationcoefextrasum';
 353                          $element =& $mform->createElement('checkbox', 'aggregationcoef', get_string($coefstring, 'grades'));
 354                      } else {
 355                          $element =& $mform->createElement('text', 'aggregationcoef', get_string($coefstring, 'grades'));
 356                      }
 357                      if ($mform->elementExists('parentcategory')) {
 358                          $mform->insertElementBefore($element, 'parentcategory');
 359                      } else {
 360                          $mform->insertElementBefore($element, 'id');
 361                      }
 362                      $mform->addHelpButton('aggregationcoef', $coefstring, 'grades');
 363                  }
 364                  $mform->disabledIf('aggregationcoef', 'gradetype', 'eq', GRADE_TYPE_NONE);
 365                  $mform->disabledIf('aggregationcoef', 'gradetype', 'eq', GRADE_TYPE_TEXT);
 366                  $mform->disabledIf('aggregationcoef', 'parentcategory', 'eq', $parent_category->id);
 367              }
 368  
 369              // Remove fields used by natural weighting if the parent category is not using natural weighting.
 370              // Or if the item is a scale and scales are not used in aggregation.
 371              if ($parent_category->aggregation != GRADE_AGGREGATE_SUM
 372                      || (empty($CFG->grade_includescalesinaggregation) && $grade_item->gradetype == GRADE_TYPE_SCALE)) {
 373                  if ($mform->elementExists('weightoverride')) {
 374                      $mform->removeElement('weightoverride');
 375                  }
 376                  if ($mform->elementExists('aggregationcoef2')) {
 377                      $mform->removeElement('aggregationcoef2');
 378                  }
 379              }
 380  
 381              if ($category = $grade_item->get_item_category()) {
 382                  if ($category->aggregation == GRADE_AGGREGATE_SUM) {
 383                      if ($mform->elementExists('gradetype')) {
 384                          $mform->hardFreeze('gradetype');
 385                      }
 386                      if ($mform->elementExists('grademin')) {
 387                          $mform->hardFreeze('grademin');
 388                      }
 389                      if ($mform->elementExists('grademax')) {
 390                          $mform->hardFreeze('grademax');
 391                      }
 392                      if ($mform->elementExists('scaleid')) {
 393                          $mform->removeElement('scaleid');
 394                      }
 395                  }
 396              }
 397  
 398          } else {
 399              // all new items are manual, children of course category
 400              $mform->removeElement('plusfactor');
 401              $mform->removeElement('multfactor');
 402              $mform->removeElement('rescalegrades');
 403          }
 404  
 405          // no parent header for course category
 406          if (!$mform->elementExists('aggregationcoef') and !$mform->elementExists('parentcategory')) {
 407              $mform->removeElement('headerparent');
 408          }
 409      }
 410  
 411  /// perform extra validation before submission
 412      function validation($data, $files) {
 413          global $COURSE;
 414          $grade_item = false;
 415          if ($data['id']) {
 416              $grade_item = new grade_item(array('id' => $data['id'], 'courseid' => $data['courseid']));
 417          }
 418  
 419          $errors = parent::validation($data, $files);
 420  
 421          if (array_key_exists('idnumber', $data)) {
 422              if ($grade_item) {
 423                  if ($grade_item->itemtype == 'mod') {
 424                      $cm = get_coursemodule_from_instance($grade_item->itemmodule, $grade_item->iteminstance, $grade_item->courseid);
 425                  } else {
 426                      $cm = null;
 427                  }
 428              } else {
 429                  $grade_item = null;
 430                  $cm = null;
 431              }
 432              if (!grade_verify_idnumber($data['idnumber'], $COURSE->id, $grade_item, $cm)) {
 433                  $errors['idnumber'] = get_string('idnumbertaken');
 434              }
 435          }
 436  
 437          if (array_key_exists('gradetype', $data) and $data['gradetype'] == GRADE_TYPE_SCALE) {
 438              if (empty($data['scaleid'])) {
 439                  $errors['scaleid'] = get_string('missingscale', 'grades');
 440              }
 441          }
 442  
 443          if (array_key_exists('grademin', $data) and array_key_exists('grademax', $data)) {
 444              if ($data['grademax'] == $data['grademin'] or $data['grademax'] < $data['grademin']) {
 445                  $errors['grademin'] = get_string('incorrectminmax', 'grades');
 446                  $errors['grademax'] = get_string('incorrectminmax', 'grades');
 447              }
 448          }
 449  
 450          // We do not want the user to be able to change the grade type or scale for this item if grades exist.
 451          if ($grade_item && $grade_item->has_grades()) {
 452              // Check that grade type is set - should never not be set unless form has been modified.
 453              if (!isset($data['gradetype'])) {
 454                  $errors['gradetype'] = get_string('modgradecantchangegradetype', 'grades');
 455              } else if ($data['gradetype'] !== $grade_item->gradetype) { // Check if we are changing the grade type.
 456                  $errors['gradetype'] = get_string('modgradecantchangegradetype', 'grades');
 457              } else if ($data['gradetype'] == GRADE_TYPE_SCALE) {
 458                  // Check if we are changing the scale - can't do this when grades exist.
 459                  if (isset($data['scaleid']) && ($data['scaleid'] !== $grade_item->scaleid)) {
 460                      $errors['scaleid'] = get_string('modgradecantchangescale', 'grades');
 461                  }
 462              }
 463          }
 464          if ($grade_item) {
 465              if ($grade_item->gradetype == GRADE_TYPE_VALUE) {
 466                  if (grade_floats_different($data['grademin'], $grade_item->grademin) ||
 467                      grade_floats_different($data['grademax'], $grade_item->grademax)) {
 468                      if ($grade_item->has_grades() && empty($data['rescalegrades'])) {
 469                          $errors['rescalegrades'] = get_string('mustchooserescaleyesorno', 'grades');
 470                      }
 471                  }
 472              }
 473          }
 474  
 475          return $errors;
 476      }
 477  
 478  }
 479  


Generated: Thu Aug 11 10:00:09 2016 Cross-referenced by PHPXref 0.7.1