PageRenderTime 51ms CodeModel.GetById 22ms RepoModel.GetById 0ms app.codeStats 1ms

/grade/edit/tree/item_form.php

https://bitbucket.org/synergylearning/campusconnect
PHP | 360 lines | 251 code | 60 blank | 49 comment | 53 complexity | b56a11737e9210e3e7499b606c427f29 MD5 | raw file
Possible License(s): MPL-2.0-no-copyleft-exception, LGPL-3.0, GPL-3.0, LGPL-2.1, Apache-2.0, BSD-3-Clause, AGPL-3.0
  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. * A moodleform allowing the editing of the grade options for an individual grade item
  18. *
  19. * @package core_grades
  20. * @copyright 2007 Petr Skoda
  21. * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  22. */
  23. if (!defined('MOODLE_INTERNAL')) {
  24. die('Direct access to this script is forbidden.'); /// It must be included from a Moodle page
  25. }
  26. require_once $CFG->libdir.'/formslib.php';
  27. class edit_item_form extends moodleform {
  28. private $displayoptions;
  29. function definition() {
  30. global $COURSE, $CFG, $DB;
  31. $mform =& $this->_form;
  32. $item = $this->_customdata['current'];
  33. /// visible elements
  34. $mform->addElement('header', 'general', get_string('gradeitem', 'grades'));
  35. $mform->addElement('text', 'itemname', get_string('itemname', 'grades'));
  36. $mform->setType('itemname', PARAM_TEXT);
  37. $mform->addElement('text', 'iteminfo', get_string('iteminfo', 'grades'));
  38. $mform->addHelpButton('iteminfo', 'iteminfo', 'grades');
  39. $mform->setType('iteminfo', PARAM_TEXT);
  40. $mform->addElement('text', 'idnumber', get_string('idnumbermod'));
  41. $mform->addHelpButton('idnumber', 'idnumbermod');
  42. $mform->setType('idnumber', PARAM_RAW);
  43. // Manual grade items cannot have grade type GRADE_TYPE_NONE.
  44. $options = array(GRADE_TYPE_VALUE => get_string('typevalue', 'grades'),
  45. GRADE_TYPE_SCALE => get_string('typescale', 'grades'),
  46. GRADE_TYPE_TEXT => get_string('typetext', 'grades'));
  47. $mform->addElement('select', 'gradetype', get_string('gradetype', 'grades'), $options);
  48. $mform->addHelpButton('gradetype', 'gradetype', 'grades');
  49. $mform->setDefault('gradetype', GRADE_TYPE_VALUE);
  50. //$mform->addElement('text', 'calculation', get_string('calculation', 'grades'));
  51. //$mform->disabledIf('calculation', 'gradetype', 'eq', GRADE_TYPE_TEXT);
  52. //$mform->disabledIf('calculation', 'gradetype', 'eq', GRADE_TYPE_NONE);
  53. $options = array(0=>get_string('usenoscale', 'grades'));
  54. if ($scales = grade_scale::fetch_all_local($COURSE->id)) {
  55. foreach ($scales as $scale) {
  56. $options[$scale->id] = $scale->get_name();
  57. }
  58. }
  59. if ($scales = grade_scale::fetch_all_global()) {
  60. foreach ($scales as $scale) {
  61. $options[$scale->id] = $scale->get_name();
  62. }
  63. }
  64. // ugly BC hack - it was possible to use custom scale from other courses :-(
  65. if (!empty($item->scaleid) and !isset($options[$item->scaleid])) {
  66. if ($scale = grade_scale::fetch(array('id'=>$item->scaleid))) {
  67. $options[$scale->id] = $scale->get_name().get_string('incorrectcustomscale', 'grades');
  68. }
  69. }
  70. $mform->addElement('select', 'scaleid', get_string('scale'), $options);
  71. $mform->addHelpButton('scaleid', 'typescale', 'grades');
  72. $mform->disabledIf('scaleid', 'gradetype', 'noteq', GRADE_TYPE_SCALE);
  73. $mform->addElement('text', 'grademax', get_string('grademax', 'grades'));
  74. $mform->addHelpButton('grademax', 'grademax', 'grades');
  75. $mform->disabledIf('grademax', 'gradetype', 'noteq', GRADE_TYPE_VALUE);
  76. $mform->setType('grademax', PARAM_RAW);
  77. $mform->addElement('text', 'grademin', get_string('grademin', 'grades'));
  78. $mform->addHelpButton('grademin', 'grademin', 'grades');
  79. $mform->disabledIf('grademin', 'gradetype', 'noteq', GRADE_TYPE_VALUE);
  80. $mform->setType('grademin', PARAM_RAW);
  81. $mform->addElement('text', 'gradepass', get_string('gradepass', 'grades'));
  82. $mform->addHelpButton('gradepass', 'gradepass', 'grades');
  83. $mform->disabledIf('gradepass', 'gradetype', 'eq', GRADE_TYPE_NONE);
  84. $mform->disabledIf('gradepass', 'gradetype', 'eq', GRADE_TYPE_TEXT);
  85. $mform->setType('gradepass', PARAM_RAW);
  86. $mform->addElement('text', 'multfactor', get_string('multfactor', 'grades'));
  87. $mform->addHelpButton('multfactor', 'multfactor', 'grades');
  88. $mform->setAdvanced('multfactor');
  89. $mform->disabledIf('multfactor', 'gradetype', 'eq', GRADE_TYPE_NONE);
  90. $mform->disabledIf('multfactor', 'gradetype', 'eq', GRADE_TYPE_TEXT);
  91. $mform->setType('multfactor', PARAM_RAW);
  92. $mform->addElement('text', 'plusfactor', get_string('plusfactor', 'grades'));
  93. $mform->addHelpButton('plusfactor', 'plusfactor', 'grades');
  94. $mform->setAdvanced('plusfactor');
  95. $mform->disabledIf('plusfactor', 'gradetype', 'eq', GRADE_TYPE_NONE);
  96. $mform->disabledIf('plusfactor', 'gradetype', 'eq', GRADE_TYPE_TEXT);
  97. $mform->setType('plusfactor', PARAM_RAW);
  98. /// grade display prefs
  99. $default_gradedisplaytype = grade_get_setting($COURSE->id, 'displaytype', $CFG->grade_displaytype);
  100. $options = array(GRADE_DISPLAY_TYPE_DEFAULT => get_string('default', 'grades'),
  101. GRADE_DISPLAY_TYPE_REAL => get_string('real', 'grades'),
  102. GRADE_DISPLAY_TYPE_PERCENTAGE => get_string('percentage', 'grades'),
  103. GRADE_DISPLAY_TYPE_LETTER => get_string('letter', 'grades'),
  104. GRADE_DISPLAY_TYPE_REAL_PERCENTAGE => get_string('realpercentage', 'grades'),
  105. GRADE_DISPLAY_TYPE_REAL_LETTER => get_string('realletter', 'grades'),
  106. GRADE_DISPLAY_TYPE_LETTER_REAL => get_string('letterreal', 'grades'),
  107. GRADE_DISPLAY_TYPE_LETTER_PERCENTAGE => get_string('letterpercentage', 'grades'),
  108. GRADE_DISPLAY_TYPE_PERCENTAGE_LETTER => get_string('percentageletter', 'grades'),
  109. GRADE_DISPLAY_TYPE_PERCENTAGE_REAL => get_string('percentagereal', 'grades')
  110. );
  111. asort($options);
  112. foreach ($options as $key=>$option) {
  113. if ($key == $default_gradedisplaytype) {
  114. $options[GRADE_DISPLAY_TYPE_DEFAULT] = get_string('defaultprev', 'grades', $option);
  115. break;
  116. }
  117. }
  118. $mform->addElement('select', 'display', get_string('gradedisplaytype', 'grades'), $options);
  119. $mform->addHelpButton('display', 'gradedisplaytype', 'grades');
  120. $default_gradedecimals = grade_get_setting($COURSE->id, 'decimalpoints', $CFG->grade_decimalpoints);
  121. $options = array(-1=>get_string('defaultprev', 'grades', $default_gradedecimals), 0=>0, 1=>1, 2=>2, 3=>3, 4=>4, 5=>5);
  122. $mform->addElement('select', 'decimals', get_string('decimalpoints', 'grades'), $options);
  123. $mform->addHelpButton('decimals', 'decimalpoints', 'grades');
  124. $mform->setDefault('decimals', -1);
  125. $mform->disabledIf('decimals', 'display', 'eq', GRADE_DISPLAY_TYPE_LETTER);
  126. if ($default_gradedisplaytype == GRADE_DISPLAY_TYPE_LETTER) {
  127. $mform->disabledIf('decimals', 'display', "eq", GRADE_DISPLAY_TYPE_DEFAULT);
  128. }
  129. /// hiding
  130. if ($item->cancontrolvisibility) {
  131. // advcheckbox is not compatible with disabledIf!
  132. $mform->addElement('checkbox', 'hidden', get_string('hidden', 'grades'));
  133. $mform->addElement('date_time_selector', 'hiddenuntil', get_string('hiddenuntil', 'grades'), array('optional'=>true));
  134. $mform->disabledIf('hidden', 'hiddenuntil[off]', 'notchecked');
  135. } else {
  136. $mform->addElement('static', 'hidden', get_string('hidden', 'grades'),
  137. get_string('componentcontrolsvisibility', 'grades'));
  138. // Unset hidden to avoid data override.
  139. unset($item->hidden);
  140. }
  141. $mform->addHelpButton('hidden', 'hidden', 'grades');
  142. /// locking
  143. $mform->addElement('advcheckbox', 'locked', get_string('locked', 'grades'));
  144. $mform->addHelpButton('locked', 'locked', 'grades');
  145. $mform->addElement('date_time_selector', 'locktime', get_string('locktime', 'grades'), array('optional'=>true));
  146. $mform->disabledIf('locktime', 'gradetype', 'eq', GRADE_TYPE_NONE);
  147. /// parent category related settings
  148. $mform->addElement('header', 'headerparent', get_string('parentcategory', 'grades'));
  149. $options = array();
  150. $coefstring = '';
  151. $categories = grade_category::fetch_all(array('courseid'=>$COURSE->id));
  152. foreach ($categories as $cat) {
  153. $cat->apply_forced_settings();
  154. $options[$cat->id] = $cat->get_name();
  155. }
  156. if (count($categories) > 1) {
  157. $mform->addElement('select', 'parentcategory', get_string('gradecategory', 'grades'), $options);
  158. }
  159. /// hidden params
  160. $mform->addElement('hidden', 'id', 0);
  161. $mform->setType('id', PARAM_INT);
  162. $mform->addElement('hidden', 'courseid', $COURSE->id);
  163. $mform->setType('courseid', PARAM_INT);
  164. $mform->addElement('hidden', 'itemtype', 'manual'); // all new items are manual only
  165. $mform->setType('itemtype', PARAM_ALPHA);
  166. /// add return tracking info
  167. $gpr = $this->_customdata['gpr'];
  168. $gpr->add_mform_elements($mform);
  169. /// mark advanced according to site settings
  170. if (isset($CFG->grade_item_advanced)) {
  171. $advanced = explode(',', $CFG->grade_item_advanced);
  172. foreach ($advanced as $el) {
  173. if ($mform->elementExists($el)) {
  174. $mform->setAdvanced($el);
  175. }
  176. }
  177. }
  178. //-------------------------------------------------------------------------------
  179. // buttons
  180. $this->add_action_buttons();
  181. //-------------------------------------------------------------------------------
  182. $this->set_data($item);
  183. }
  184. /// tweak the form - depending on existing data
  185. function definition_after_data() {
  186. global $CFG, $COURSE;
  187. $mform =& $this->_form;
  188. if ($id = $mform->getElementValue('id')) {
  189. $grade_item = grade_item::fetch(array('id'=>$id));
  190. if (!$grade_item->is_raw_used()) {
  191. $mform->removeElement('plusfactor');
  192. $mform->removeElement('multfactor');
  193. }
  194. if ($grade_item->is_outcome_item()) {
  195. // we have to prevent incompatible modifications of outcomes if outcomes disabled
  196. $mform->removeElement('grademax');
  197. $mform->removeElement('grademin');
  198. $mform->removeElement('gradetype');
  199. $mform->removeElement('display');
  200. $mform->removeElement('decimals');
  201. $mform->hardFreeze('scaleid');
  202. } else {
  203. if ($grade_item->is_external_item()) {
  204. // following items are set up from modules and should not be overrided by user
  205. $mform->hardFreeze('itemname,gradetype,grademax,grademin,scaleid');
  206. if ($grade_item->itemnumber == 0) {
  207. // the idnumber of grade itemnumber 0 is synced with course_modules
  208. $mform->hardFreeze('idnumber');
  209. }
  210. //$mform->removeElement('calculation');
  211. }
  212. }
  213. // if we wanted to change parent of existing item - we would have to verify there are no circular references in parents!!!
  214. if ($mform->elementExists('parentcategory')) {
  215. $mform->hardFreeze('parentcategory');
  216. }
  217. $parent_category = $grade_item->get_parent_category();
  218. $parent_category->apply_forced_settings();
  219. if (!$parent_category->is_aggregationcoef_used()) {
  220. if ($mform->elementExists('aggregationcoef')) {
  221. $mform->removeElement('aggregationcoef');
  222. }
  223. } else {
  224. $coefstring = $grade_item->get_coefstring();
  225. if ($coefstring !== '') {
  226. if ($coefstring == 'aggregationcoefextrasum') {
  227. // advcheckbox is not compatible with disabledIf!
  228. $element =& $mform->createElement('checkbox', 'aggregationcoef', get_string($coefstring, 'grades'));
  229. } else {
  230. $element =& $mform->createElement('text', 'aggregationcoef', get_string($coefstring, 'grades'));
  231. }
  232. if ($mform->elementExists('parentcategory')) {
  233. $mform->insertElementBefore($element, 'parentcategory');
  234. } else {
  235. $mform->insertElementBefore($element, 'id');
  236. }
  237. $mform->addHelpButton('aggregationcoef', $coefstring, 'grades');
  238. }
  239. $mform->disabledIf('aggregationcoef', 'parentcategory', 'eq', $parent_category->id);
  240. }
  241. if ($category = $grade_item->get_item_category()) {
  242. if ($category->aggregation == GRADE_AGGREGATE_SUM) {
  243. if ($mform->elementExists('gradetype')) {
  244. $mform->hardFreeze('gradetype');
  245. }
  246. if ($mform->elementExists('grademin')) {
  247. $mform->hardFreeze('grademin');
  248. }
  249. if ($mform->elementExists('grademax')) {
  250. $mform->hardFreeze('grademax');
  251. }
  252. if ($mform->elementExists('scaleid')) {
  253. $mform->removeElement('scaleid');
  254. }
  255. }
  256. }
  257. } else {
  258. // all new items are manual, children of course category
  259. $mform->removeElement('plusfactor');
  260. $mform->removeElement('multfactor');
  261. }
  262. // no parent header for course category
  263. if (!$mform->elementExists('aggregationcoef') and !$mform->elementExists('parentcategory')) {
  264. $mform->removeElement('headerparent');
  265. }
  266. }
  267. /// perform extra validation before submission
  268. function validation($data, $files) {
  269. global $COURSE;
  270. $errors = parent::validation($data, $files);
  271. if (array_key_exists('idnumber', $data)) {
  272. if ($data['id']) {
  273. $grade_item = new grade_item(array('id'=>$data['id'], 'courseid'=>$data['courseid']));
  274. if ($grade_item->itemtype == 'mod') {
  275. $cm = get_coursemodule_from_instance($grade_item->itemmodule, $grade_item->iteminstance, $grade_item->courseid);
  276. } else {
  277. $cm = null;
  278. }
  279. } else {
  280. $grade_item = null;
  281. $cm = null;
  282. }
  283. if (!grade_verify_idnumber($data['idnumber'], $COURSE->id, $grade_item, $cm)) {
  284. $errors['idnumber'] = get_string('idnumbertaken');
  285. }
  286. }
  287. if (array_key_exists('gradetype', $data) and $data['gradetype'] == GRADE_TYPE_SCALE) {
  288. if (empty($data['scaleid'])) {
  289. $errors['scaleid'] = get_string('missingscale', 'grades');
  290. }
  291. }
  292. if (array_key_exists('grademin', $data) and array_key_exists('grademax', $data)) {
  293. if ($data['grademax'] == $data['grademin'] or $data['grademax'] < $data['grademin']) {
  294. $errors['grademin'] = get_string('incorrectminmax', 'grades');
  295. $errors['grademax'] = get_string('incorrectminmax', 'grades');
  296. }
  297. }
  298. return $errors;
  299. }
  300. }