grade/edit/tree/item_form.php

   1 <?php  //$Id$
   2
   3 require_once $CFG->libdir.'/formslib.php';
   4
   5 class edit_item_form extends moodleform {
   6     function definition() {
   7         global $COURSE, $CFG;
   8
   9         $mform =& $this->_form;
  10
  11 /// visible elements
  12         $mform->addElement('header', 'general', get_string('gradeitem', 'grades'));
  13
  14         $mform->addElement('text', 'itemname', get_string('itemname', 'grades'));
  15         $mform->addElement('text', 'iteminfo', get_string('iteminfo', 'grades'));
  16         $mform->setHelpButton('iteminfo', array(false, get_string('iteminfo', 'grades'),
  17                 false, true, false, get_string('iteminfohelp', 'grades')));
  18
  19         $mform->addElement('text', 'idnumber', get_string('idnumber'));
  20         $mform->setHelpButton('idnumber', array(false, get_string('idnumber'),
  21                 false, true, false, get_string('idnumberhelp', 'grades')));
  22
  23         $options = array(GRADE_TYPE_NONE=>get_string('typenone', 'grades'),
  24                          GRADE_TYPE_VALUE=>get_string('typevalue', 'grades'),
  25                          GRADE_TYPE_SCALE=>get_string('typescale', 'grades'),
  26                          GRADE_TYPE_TEXT=>get_string('typetext', 'grades'));
  27
  28         $mform->addElement('select', 'gradetype', get_string('gradetype', 'grades'), $options);
  29         $mform->setHelpButton('gradetype', array(false, get_string('gradetype', 'grades'),
  30                 false, true, false, get_string('gradetypehelp', 'grades')));
  31         $mform->setDefault('gradetype', GRADE_TYPE_VALUE);
  32
  33         //$mform->addElement('text', 'calculation', get_string('calculation', 'grades'));
  34         //$mform->disabledIf('calculation', 'gradetype', 'eq', GRADE_TYPE_TEXT);
  35         //$mform->disabledIf('calculation', 'gradetype', 'eq', GRADE_TYPE_NONE);
  36
  37         $options = array(0=>get_string('usenoscale', 'grades'));
  38         if ($scales = get_records('scale')) {
  39             foreach ($scales as $scale) {
  40                 $options[$scale->id] = format_string($scale->name);
  41             }
  42         }
  43         $mform->addElement('select', 'scaleid', get_string('scale'), $options);
  44         $mform->setHelpButton('scaleid', array(false, get_string('scaleid', 'grades'),
  45                 false, true, false, get_string('scaleidhelp', 'grades', get_string('gradeitem', 'grades'))));
  46         $mform->disabledIf('scaleid', 'gradetype', 'noteq', GRADE_TYPE_SCALE);
  47
  48         $mform->addElement('text', 'grademax', get_string('grademax', 'grades'));
  49         $mform->setHelpButton('grademax', array(false, get_string('grademax', 'grades'),
  50                 false, true, false, get_string('grademaxhelp', 'grades')));
  51         $mform->disabledIf('grademax', 'gradetype', 'noteq', GRADE_TYPE_VALUE);
  52
  53         $mform->addElement('text', 'grademin', get_string('grademin', 'grades'));
  54         $mform->setHelpButton('grademin', array(false, get_string('grademin', 'grades'),
  55                 false, true, false, get_string('grademinhelp', 'grades')));
  56         $mform->disabledIf('grademin', 'gradetype', 'noteq', GRADE_TYPE_VALUE);
  57
  58         $mform->addElement('text', 'gradepass', get_string('gradepass', 'grades'));
  59         $mform->setHelpButton('gradepass', array(false, get_string('gradepass', 'grades'),
  60                 false, true, false, get_string('gradepasshelp', 'grades')));
  61         $mform->disabledIf('gradepass', 'gradetype', 'eq', GRADE_TYPE_NONE);
  62         $mform->disabledIf('gradepass', 'gradetype', 'eq', GRADE_TYPE_TEXT);
  63
  64         $mform->addElement('text', 'multfactor', get_string('multfactor', 'grades'));
  65         $mform->setHelpButton('multfactor', array(false, get_string('multfactor', 'grades'),
  66                 false, true, false, get_string('multfactorhelp', 'grades')));
  67         $mform->setAdvanced('multfactor');
  68         $mform->disabledIf('multfactor', 'gradetype', 'eq', GRADE_TYPE_NONE);
  69         $mform->disabledIf('multfactor', 'gradetype', 'eq', GRADE_TYPE_TEXT);
  70
  71         $mform->addElement('text', 'plusfactor', get_string('plusfactor', 'grades'));
  72         $mform->setHelpButton('plusfactor', array(false, get_string('plusfactor', 'grades'),
  73                 false, true, false, get_string('plusfactorhelp', 'grades')));
  74         $mform->setAdvanced('plusfactor');
  75         $mform->disabledIf('plusfactor', 'gradetype', 'eq', GRADE_TYPE_NONE);
  76         $mform->disabledIf('plusfactor', 'gradetype', 'eq', GRADE_TYPE_TEXT);
  77
  78         $mform->addElement('text', 'aggregationcoef', get_string('aggregationcoef', 'grades'));
  79         $mform->setHelpButton('aggregationcoef', array(false, get_string('aggregationcoef', 'grades'),
  80                 false, true, false, get_string('aggregationcoefhelp', 'grades')));
  81
  82         // Determine default value for gradedisplaytype (site or course)
  83         $course_gradedisplaytype = get_field('grade_items', 'display', 'courseid', $COURSE->id, 'itemtype', 'course');
  84         $site_gradedisplaytype = $CFG->grade_report_gradedisplaytype;
  85         $default_gradedisplaytype = $course_gradedisplaytype;
  86
  87         if ($course_gradedisplaytype == GRADE_REPORT_PREFERENCE_DEFAULT) {
  88             $default_gradedisplaytype = $site_gradedisplaytype;
  89         }
  90
  91         $options = array(GRADE_DISPLAY_TYPE_DEFAULT => get_string('default', 'grades'),
  92                          GRADE_DISPLAY_TYPE_REAL => get_string('real', 'grades'),
  93                          GRADE_DISPLAY_TYPE_PERCENTAGE => get_string('percentage', 'grades'),
  94                          GRADE_DISPLAY_TYPE_LETTER => get_string('letter', 'grades'));
  95         $label = get_string('gradedisplaytype', 'grades') . ' (' . get_string('default', 'grades') . ': ' . $options[$default_gradedisplaytype] . ')';
  96         $mform->addElement('select', 'display', $label, $options);
  97         $mform->setHelpButton('display', array(false, get_string('gradedisplaytype', 'grades'),
  98                               false, true, false, get_string("configgradedisplaytype", 'grades')));
  99
 100         // Determine default value for decimalpoints (site or course)
 101         $course_gradedecimals = get_field('grade_items', 'decimals', 'courseid', $COURSE->id, 'itemtype', 'course');
 102         $site_gradedecimals = $CFG->grade_report_decimalpoints;
 103         $default_gradedecimals = $course_gradedecimals;
 104
 105         if ($course_gradedecimals == GRADE_DECIMALS_DEFAULT) {
 106             $default_gradedecimals = $site_gradedecimals;
 107         }
 108         $options = array(GRADE_DECIMALS_DEFAULT => get_string('default', 'grades'), 0, 1, 2, 3, 4, 5);
 109         $label = get_string('decimalpoints', 'grades') . ' (' . get_string('default', 'grades') . ': ' . $options[$default_gradedecimals] . ')';
 110         $mform->addElement('select', 'decimals', $label, $options);
 111         $mform->setHelpButton('decimals', array(false, get_string('decimalpoints', 'grades'),
 112                               false, true, false, get_string("configdecimalpoints", 'grades')));
 113         $mform->setDefault('decimals', GRADE_REPORT_PREFERENCE_DEFAULT);
 114
 115         // Disable decimals if displaytype is not REAL or PERCENTAGE
 116         $mform->disabledIf('decimals', 'display', "eq", GRADE_DISPLAY_TYPE_LETTER);
 117
 118         // Disable decimals if displaytype is DEFAULT and course or site displaytype is LETTER
 119         if ($default_gradedisplaytype == GRADE_DISPLAY_TYPE_LETTER) {
 120             $mform->disabledIf('decimals', 'display', "eq", GRADE_DISPLAY_TYPE_DEFAULT);
 121         }
 122
 123         /// hiding
 124         /// advcheckbox is not compatible with disabledIf !!
 125         $mform->addElement('checkbox', 'hidden', get_string('hidden', 'grades'));
 126         $mform->setHelpButton('hidden', array('hidden', get_string('hidden', 'grades'), 'grade'));
 127         $mform->addElement('date_time_selector', 'hiddenuntil', get_string('hiddenuntil', 'grades'), array('optional'=>true));
 128         $mform->setHelpButton('hiddenuntil', array('hiddenuntil', get_string('hiddenuntil', 'grades'), 'grade'));
 129         $mform->disabledIf('hidden', 'hiddenuntil[off]', 'notchecked');
 130
 131         /// locking
 132         $mform->addElement('advcheckbox', 'locked', get_string('locked', 'grades'));
 133         $mform->setHelpButton('locked', array('locked', get_string('locked', 'grades'), 'grade'));
 134
 135         $mform->addElement('date_time_selector', 'locktime', get_string('locktime', 'grades'), array('optional'=>true));
 136         $mform->setHelpButton('locktime', array('locktime', get_string('locktime', 'grades'), 'grade'));
 137         $mform->disabledIf('locktime', 'gradetype', 'eq', GRADE_TYPE_NONE);
 138
 139 /// hidden params
 140         $mform->addElement('hidden', 'id', 0);
 141         $mform->setType('id', PARAM_INT);
 142
 143         $mform->addElement('hidden', 'courseid', $COURSE->id);
 144         $mform->setType('courseid', PARAM_INT);
 145
 146         $mform->addElement('hidden', 'itemtype', 'manual'); // all new items are manual only
 147         $mform->setType('itemtype', PARAM_ALPHA);
 148
 149 /// add return tracking info
 150         $gpr = $this->_customdata['gpr'];
 151         $gpr->add_mform_elements($mform);
 152
 153 //-------------------------------------------------------------------------------
 154         // buttons
 155         $this->add_action_buttons();
 156     }
 157
 158
 159 /// tweak the form - depending on existing data
 160     function definition_after_data() {
 161         global $CFG, $COURSE;
 162
 163         $mform =& $this->_form;
 164
 165         if ($id = $mform->getElementValue('id')) {
 166             $grade_item = grade_item::fetch(array('id'=>$id));
 167
 168             $mform->setDefault('display', $grade_item->display);
 169
 170             if (!$grade_item->is_raw_used()) {
 171                 $mform->removeElement('plusfactor');
 172                 $mform->removeElement('multfactor');
 173             }
 174
 175             if ($grade_item->is_outcome_item()) {
 176                 // we have to prevent incompatible modifications of outcomes
 177                 $mform->removeElement('grademax');
 178                 $mform->removeElement('grademin');
 179                 $mform->removeElement('gradetype');
 180                 $mform->hardFreeze('scaleid');
 181
 182             } else {
 183                 if ($grade_item->is_normal_item()) {
 184                     // following items are set up from modules and should not be overrided by user
 185                     $mform->hardFreeze('itemname,idnumber,gradetype,grademax,grademin,scaleid');
 186                     //$mform->removeElement('calculation');
 187                 }
 188             }
 189             //remove the aggregation coef element if not needed
 190             if ($grade_item->is_course_item()) {
 191                 $mform->removeElement('aggregationcoef');
 192
 193             } else if ($grade_item->is_category_item()) {
 194                 $category = $grade_item->get_item_category();
 195                 $parent_category = $category->get_parent_category();
 196                 if (!$parent_category->is_aggregationcoef_used()) {
 197                     $mform->removeElement('aggregationcoef');
 198                 }
 199
 200             } else {
 201                 $parent_category = $grade_item->get_parent_category();
 202                 if (!$parent_category->is_aggregationcoef_used()) {
 203                     $mform->removeElement('aggregationcoef');
 204                 }
 205             }
 206
 207         } else {
 208             // all new items are manual, children of course category
 209             $mform->removeElement('plusfactor');
 210             $mform->removeElement('multfactor');
 211
 212             $course_category = grade_category::fetch_course_category($COURSE->id);
 213             if (!$course_category->is_aggregationcoef_used()) {
 214                 $mform->removeElement('aggregationcoef');
 215             }
 216         }
 217     }
 218
 219
 220 /// perform extra validation before submission
 221     function validation($data){
 222         $errors = array();
 223
 224         if (array_key_exists('idnumber', $data)) {
 225             if ($data['id']) {
 226                 $grade_item = new grade_item(array('id'=>$data['id'], 'courseid'=>$data['courseid']));
 227                 if ($grade_item->itemtype == 'mod') {
 228                     $cm = get_coursemodule_from_instance($grade_item->itemmodule, $grade_item->iteminstance, $grade_item->courseid);
 229                 } else {
 230                     $cm = null;
 231                 }
 232             } else {
 233                 $grade_item = null;
 234                 $cm = null;
 235             }
 236             if (!grade_verify_idnumber($data['idnumber'], $grade_item, $cm)) {
 237                 $errors['idnumber'] = get_string('idnumbertaken');
 238             }
 239         }
 240
 241         /*
 242         if (array_key_exists('calculation', $data) and $data['calculation'] != '') {
 243             $grade_item = new grade_item(array('id'=>$data['id'], 'itemtype'=>$data['itemtype'], 'courseid'=>$data['courseid']));
 244             $result = $grade_item->validate_formula($data['calculation']);
 245             if ($result !== true) {
 246                 $errors['calculation'] = $result;
 247             }
 248         }
 249         */
 250
 251         if (array_key_exists('grademin', $data) and array_key_exists('grademax', $data)) {
 252             if ($data['grademax'] == $data['grademin'] or $data['grademax'] < $data['grademin']) {
 253                 $errors['grademin'] = get_String('incorrectminmax', 'grades');
 254                 $errors['grademax'] = get_String('incorrectminmax', 'grades');
 255             }
 256         }
 257
 258         if (0 == count($errors)){
 259             return true;
 260         } else {
 261             return $errors;
 262         }
 263     }
 264
 265 }
 266 ?>