MDL-22388 Added some checks to kill these scripts dead with an unequivocal notice...
[moodle.git] / grade / edit / tree / grade_form.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 if (!defined('MOODLE_INTERNAL')) {
19     die('Direct access to this script is forbidden.');    ///  It must be included from a Moodle page
20 }
22 require_once $CFG->libdir.'/formslib.php';
24 class edit_grade_form extends moodleform {
26     function definition() {
27         global $CFG, $COURSE, $DB;
29         $mform =& $this->_form;
31         $grade_item = $this->_customdata['grade_item'];
32         $gpr        = $this->_customdata['gpr'];
34         if ($grade_item->is_course_item()) {
35             $grade_category = null;
36         } else if ($grade_item->is_category_item()) {
37             $grade_category = $grade_item->get_item_category();
38             $grade_category = $grade_category->get_parent_category();
39         } else {
40             $grade_category = $grade_item->get_parent_category();
41         }
43         /// information fields
44         $mform->addElement('static', 'user', get_string('user'));
45         $mform->addElement('static', 'itemname', get_string('itemname', 'grades'));
47         $mform->addElement('checkbox', 'overridden', get_string('overridden', 'grades'));
48         $mform->setHelpButton('overridden', array('overridden', get_string('overridden', 'grades'), 'grade'));
50         /// actual grade - numeric or scale
51         if ($grade_item->gradetype == GRADE_TYPE_VALUE) {
52             // numeric grade
53             $mform->addElement('text', 'finalgrade', get_string('finalgrade', 'grades'));
54             $mform->setHelpButton('finalgrade', array('finalgrade', get_string('finalgrade', 'grades'), 'grade'));
55             $mform->disabledIf('finalgrade', 'overridden', 'notchecked');
57         } else if ($grade_item->gradetype == GRADE_TYPE_SCALE) {
58             // scale grade
59             $scaleopt = array();
61             if (empty($grade_item->outcomeid)) {
62                 $scaleopt[-1] = get_string('nograde');
63             } else {
64                 $scaleopt[-1] = get_string('nooutcome', 'grades');
65             }
67             $i = 1;
68             if ($scale = $DB->get_record('scale', array('id' => $grade_item->scaleid))) {
69                 foreach (split(",", $scale->scale) as $option) {
70                     $scaleopt[$i] = $option;
71                     $i++;
72                 }
73             }
75             $mform->addElement('select', 'finalgrade', get_string('finalgrade', 'grades'), $scaleopt);
76             $mform->setHelpButton('finalgrade', array('finalgrade', get_string('finalgrade', 'grades'), 'grade'));
77             $mform->disabledIf('finalgrade', 'overridden', 'notchecked');
78         }
80         if ($grade_category and $grade_category->aggregation == GRADE_AGGREGATE_SUM) {
81             $mform->addElement('advcheckbox', 'excluded', get_string('excluded', 'grades'), '<small>('.get_string('warningexcludedsum', 'grades').')</small>');
82         } else {
83             $mform->addElement('advcheckbox', 'excluded', get_string('excluded', 'grades'));
84         }
85         $mform->setHelpButton('excluded', array('excluded', get_string('excluded', 'grades'), 'grade'));
87         /// hiding
88         /// advcheckbox is not compatible with disabledIf !!
89         $mform->addElement('checkbox', 'hidden', get_string('hidden', 'grades'));
90         $mform->setHelpButton('hidden', array('hidden', get_string('hidden', 'grades'), 'grade'));
91         $mform->addElement('date_time_selector', 'hiddenuntil', get_string('hiddenuntil', 'grades'), array('optional'=>true));
92         $mform->setHelpButton('hiddenuntil', array('hiddenuntil', get_string('hiddenuntil', 'grades'), 'grade'));
93         $mform->disabledIf('hidden', 'hiddenuntil[off]', 'notchecked');
95         /// locking
96         $mform->addElement('advcheckbox', 'locked', get_string('locked', 'grades'));
97         $mform->setHelpButton('locked', array('locked', get_string('locked', 'grades'), 'grade'));
98         $mform->addElement('date_time_selector', 'locktime', get_string('locktime', 'grades'), array('optional'=>true));
99         $mform->setHelpButton('locktime', array('lockedafter', get_string('locktime', 'grades'), 'grade'));
100         $mform->disabledIf('locktime', 'gradetype', 'eq', GRADE_TYPE_NONE);
102         // Feedback format is automatically converted to html if user has enabled editor
103         $feedbackoptions = array('maxfiles'=>0, 'maxbytes'=>0, 'trusttext'=>true);
104         $mform->addElement('editor', 'feedback', get_string('feedback', 'grades'), null, $feedbackoptions);
105         $mform->setHelpButton('feedback', array('feedback', get_string('feedback', 'grades'), 'grade'));
106         $mform->setType('text', PARAM_RAW); // to be cleaned before display, no XSS risk
108         // hidden params
109         $mform->addElement('hidden', 'oldgrade');
110         $mform->setType('oldgrade', PARAM_RAW);
111         $mform->addElement('hidden', 'oldfeedback');
112         $mform->setType('oldfeedback', PARAM_RAW);
114         $mform->addElement('hidden', 'id', 0);
115         $mform->setType('id', PARAM_INT);
117         $mform->addElement('hidden', 'itemid', 0);
118         $mform->setType('itemid', PARAM_INT);
120         $mform->addElement('hidden', 'userid', 0);
121         $mform->setType('userid', PARAM_INT);
123         $mform->addElement('hidden', 'courseid', $COURSE->id);
124         $mform->setType('courseid', PARAM_INT);
126 /// add return tracking info
127         $gpr->add_mform_elements($mform);
129 //-------------------------------------------------------------------------------
130         // buttons
131         $this->add_action_buttons();
132     }
134     function definition_after_data() {
135         global $CFG, $COURSE, $DB;
137         $context = get_context_instance(CONTEXT_COURSE, $COURSE->id);
139         $mform =& $this->_form;
140         $grade_item = $this->_customdata['grade_item'];
142         // fill in user name if user still exists
143         $userid = $mform->getElementValue('userid');
144         if ($user = $DB->get_record('user', array('id' => $userid))) {
145             $username = '<a href="'.$CFG->wwwroot.'/user/view.php?id='.$userid.'">'.fullname($user).'</a>';
146             $user_el =& $mform->getElement('user');
147             $user_el->setValue($username);
148         }
150         // add activity name + link
151         if ($grade_item->itemtype == 'mod') {
152             $cm = get_coursemodule_from_instance($grade_item->itemmodule, $grade_item->iteminstance, $grade_item->courseid);
153             $itemname = '<a href="'.$CFG->wwwroot.'/mod/'.$grade_item->itemmodule.'/view.php?id='.$cm->id.'">'.$grade_item->get_name().'</a>';
154         } else {
155             $itemname = $grade_item->get_name();
156         }
157         $itemname_el =& $mform->getElement('itemname');
158         $itemname_el->setValue($itemname);
160         // access control - disable not allowed elements
161         if (!has_capability('moodle/grade:manage', $context)) {
162             $mform->hardFreeze('excluded');
163         }
165         if (!has_capability('moodle/grade:manage', $context) and !has_capability('moodle/grade:hide', $context)) {
166             $mform->hardFreeze('hidden');
167             $mform->hardFreeze('hiddenuntil');
168         }
170         $old_grade_grade = new grade_grade(array('itemid'=>$grade_item->id, 'userid'=>$userid));
172         if (!$grade_item->is_overridable_item()) {
173             $mform->removeElement('overridden');
174         }
176         if ($grade_item->is_hidden()) {
177             $mform->hardFreeze('hidden');
178         }
180         if ($old_grade_grade->is_locked()) {
181             if ($grade_item->is_locked()) {
182                 $mform->hardFreeze('locked');
183                 $mform->hardFreeze('locktime');
184             }
186             $mform->hardFreeze('overridden');
187             $mform->hardFreeze('finalgrade');
188             $mform->hardFreeze('feedback');
190         } else {
191             if (empty($old_grade_grade->id)) {
192                 $old_grade_grade->locked = $grade_item->locked;
193                 $old_grade_grade->locktime = $grade_item->locktime;
194             }
196             if (($old_grade_grade->locked or $old_grade_grade->locktime)
197               and (!has_capability('moodle/grade:manage', $context) and !has_capability('moodle/grade:unlock', $context))) {
198                 $mform->hardFreeze('locked');
199                 $mform->hardFreeze('locktime');
201             } else if ((!$old_grade_grade->locked and !$old_grade_grade->locktime)
202               and (!has_capability('moodle/grade:manage', $context) and !has_capability('moodle/grade:lock', $context))) {
203                 $mform->hardFreeze('locked');
204                 $mform->hardFreeze('locktime');
205             }
206         }
207     }