MDL-65448 gradebook: Restyle moving.
[moodle.git] / grade / edit / tree / lib.php
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/>.
17 /**
18  * A library of classes used by the grade edit pages
19  *
20  * @package   core_grades
21  * @copyright 2009 Nicolas Connault
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 class grade_edit_tree {
26     public $columns = array();
28     /**
29      * @var grade_tree $gtree   @see grade/lib.php
30      */
31     public $gtree;
33     /**
34      * @var grade_plugin_return @see grade/lib.php
35      */
36     public $gpr;
38     /**
39      * @var string              $moving The eid of the category or item being moved
40      */
41     public $moving;
43     public $deepest_level;
45     public $uses_weight = false;
47     public $table;
49     public $categories = array();
51     /**
52      * Show calculator icons next to manual grade items
53      * @var bool $show_calculations
54      */
55     private $show_calculations;
57     /**
58      * Constructor
59      */
60     public function __construct($gtree, $moving=false, $gpr) {
61         global $USER, $OUTPUT, $COURSE;
63         $systemdefault = get_config('moodle', 'grade_report_showcalculations');
64         $this->show_calculations = get_user_preferences('grade_report_showcalculations', $systemdefault);
66         $this->gtree = $gtree;
67         $this->moving = $moving;
68         $this->gpr = $gpr;
69         $this->deepest_level = $this->get_deepest_level($this->gtree->top_element);
71         $this->columns = array(grade_edit_tree_column::factory('name', array('deepest_level' => $this->deepest_level)));
73         if ($this->uses_weight) {
74             $this->columns[] = grade_edit_tree_column::factory('weight', array('adv' => 'weight'));
75         }
77         $this->columns[] = grade_edit_tree_column::factory('range'); // This is not a setting... How do we deal with it?
78         $this->columns[] = grade_edit_tree_column::factory('actions');
80         if ($this->deepest_level > 1) {
81             $this->columns[] = grade_edit_tree_column::factory('select');
82         }
84         $this->table = new html_table();
85         $this->table->id = "grade_edit_tree_table";
86         $this->table->attributes['class'] = 'generaltable simple setup-grades';
87         if ($this->moving) {
88             $this->table->attributes['class'] .= ' moving';
89         }
91         foreach ($this->columns as $column) {
92             if (!($this->moving && $column->hide_when_moving)) {
93                 $this->table->head[] = $column->get_header_cell();
94             }
95         }
97         $rowcount = 0;
98         $this->table->data = $this->build_html_tree($this->gtree->top_element, true, array(), 0, $rowcount);
99     }
101     /**
102      * Recursive function for building the table holding the grade categories and items,
103      * with CSS indentation and styles.
104      *
105      * @param array   $element The current tree element being rendered
106      * @param boolean $totals Whether or not to print category grade items (category totals)
107      * @param array   $parents An array of parent categories for the current element (used for indentation and row classes)
108      *
109      * @return string HTML
110      */
111     public function build_html_tree($element, $totals, $parents, $level, &$row_count) {
112         global $CFG, $COURSE, $PAGE, $OUTPUT;
114         $object = $element['object'];
115         $eid    = $element['eid'];
116         $object->name = $this->gtree->get_element_header($element, true, true, true, true, true);
117         $object->stripped_name = $this->gtree->get_element_header($element, false, false, false);
118         $is_category_item = false;
119         if ($element['type'] == 'categoryitem' || $element['type'] == 'courseitem') {
120             $is_category_item = true;
121         }
123         $rowclasses = array();
124         foreach ($parents as $parent_eid) {
125             $rowclasses[] = $parent_eid;
126         }
128         $moveaction = '';
129         $actionsmenu = new action_menu();
130         $actionsmenu->set_menu_trigger(get_string('edit'));
131         $actionsmenu->set_owner_selector('grade-item-' . $eid);
132         $actionsmenu->set_alignment(action_menu::TL, action_menu::BL);
134         if (!$is_category_item && ($icon = $this->gtree->get_edit_icon($element, $this->gpr, true))) {
135             $actionsmenu->add($icon);
136         }
137         // MDL-49281 if grade_item already has calculation, it should be editable even if global setting is off.
138         $type = $element['type'];
139         $iscalculated = ($type == 'item' or $type == 'courseitem' or $type == 'categoryitem') && $object->is_calculated();
140         $icon = $this->gtree->get_calculation_icon($element, $this->gpr, true);
141         if ($iscalculated || ($this->show_calculations && $icon)) {
142             $actionsmenu->add($icon);
143         }
145         if ($element['type'] == 'item' or ($element['type'] == 'category' and $element['depth'] > 1)) {
146             if ($this->element_deletable($element)) {
147                 $aurl = new moodle_url('index.php', array('id' => $COURSE->id, 'action' => 'delete', 'eid' => $eid, 'sesskey' => sesskey()));
148                 $icon = new action_menu_link_secondary($aurl, new pix_icon('t/delete', get_string('delete')), get_string('delete'));
149                 $actionsmenu->add($icon);
150             }
152             if ($this->element_duplicatable($element)) {
153                 $duplicateparams = array();
154                 $duplicateparams['id'] = $COURSE->id;
155                 $duplicateparams['action'] = 'duplicate';
156                 $duplicateparams['eid'] = $eid;
157                 $duplicateparams['sesskey'] = sesskey();
158                 $aurl = new moodle_url('index.php', $duplicateparams);
159                 $duplicateicon = new pix_icon('t/copy', get_string('duplicate'));
160                 $icon = new action_menu_link_secondary($aurl, $duplicateicon, get_string('duplicate'));
161                 $actionsmenu->add($icon);
162             }
164             $aurl = new moodle_url('index.php', array('id' => $COURSE->id, 'action' => 'moveselect', 'eid' => $eid, 'sesskey' => sesskey()));
165             $moveaction .= $OUTPUT->action_icon($aurl, new pix_icon('t/move', get_string('move')));
166         }
168         if ($icon = $this->gtree->get_hiding_icon($element, $this->gpr, true)) {
169             $actionsmenu->add($icon);
170         }
172         if ($icon = $this->gtree->get_reset_icon($element, $this->gpr, true)) {
173             $actionsmenu->add($icon);
174         }
176         $actions = $OUTPUT->render($actionsmenu);
178         $returnrows = array();
179         $root = false;
181         $id = required_param('id', PARAM_INT);
183         /// prepare move target if needed
184         $last = '';
186         /// print the list items now
187         if ($this->moving == $eid) {
188             // do not diplay children
189             $cell = new html_table_cell();
190             $cell->colspan = 12;
191             $cell->attributes['class'] = $element['type'] . ' moving column-name level' .
192                 ($level + 1) . ' level' . ($level % 2 ? 'even' : 'odd');
193             $cell->text = $object->name.' ('.get_string('move').')';
194             return array(new html_table_row(array($cell)));
195         }
197         if ($element['type'] == 'category') {
198             $level++;
199             $this->categories[$object->id] = $object->stripped_name;
200             $category = grade_category::fetch(array('id' => $object->id));
201             $item = $category->get_grade_item();
203             // Add aggregation coef input if not a course item and if parent category has correct aggregation type
204             $dimmed = ($item->is_hidden()) ? 'dimmed_text' : '';
206             // Before we print the category's row, we must find out how many rows will appear below it (for the filler cell's rowspan)
207             $aggregation_position = grade_get_setting($COURSE->id, 'aggregationposition', $CFG->grade_aggregationposition);
208             $category_total_data = null; // Used if aggregationposition is set to "last", so we can print it last
210             $html_children = array();
212             $row_count = 0;
214             foreach($element['children'] as $child_el) {
215                 $moveto = null;
217                 if (empty($child_el['object']->itemtype)) {
218                     $child_el['object']->itemtype = false;
219                 }
221                 if (($child_el['object']->itemtype == 'course' || $child_el['object']->itemtype == 'category') && !$totals) {
222                     continue;
223                 }
225                 $child_eid = $child_el['eid'];
226                 $first = '';
228                 if ($child_el['object']->itemtype == 'course' || $child_el['object']->itemtype == 'category') {
229                     $first = array('first' => 1);
230                     $child_eid = $eid;
231                 }
233                 if ($this->moving && $this->moving != $child_eid) {
235                     $strmove     = get_string('move');
236                     $actions = $moveaction = ''; // no action icons when moving
238                     $aurl = new moodle_url('index.php', array('id' => $COURSE->id, 'action' => 'move', 'eid' => $this->moving, 'moveafter' => $child_eid, 'sesskey' => sesskey()));
239                     if ($first) {
240                         $aurl->params($first);
241                     }
243                     $cell = new html_table_cell();
244                     $cell->colspan = 12;
245                     $cell->attributes['class'] = 'movehere level' . ($level + 1) . ' level' . ($level % 2 ? 'even' : 'odd');
247                     $cell->text = html_writer::link($aurl, '', array('title' => get_string('movehere'), 'class' => 'movehere'));
249                     $moveto = new html_table_row(array($cell));
250                 }
252                 $newparents = $parents;
253                 $newparents[] = $eid;
255                 $row_count++;
256                 $child_row_count = 0;
258                 // If moving, do not print course and category totals, but still print the moveto target box
259                 if ($this->moving && ($child_el['object']->itemtype == 'course' || $child_el['object']->itemtype == 'category')) {
260                     $html_children[] = $moveto;
261                 } elseif ($child_el['object']->itemtype == 'course' || $child_el['object']->itemtype == 'category') {
262                     // We don't build the item yet because we first need to know the deepest level of categories (for category/name colspans)
263                     $category_total_item = $this->build_html_tree($child_el, $totals, $newparents, $level, $child_row_count);
264                     if (!$aggregation_position) {
265                         $html_children = array_merge($html_children, $category_total_item);
266                     }
267                 } else {
268                     $html_children = array_merge($html_children, $this->build_html_tree($child_el, $totals, $newparents, $level, $child_row_count));
269                     if (!empty($moveto)) {
270                         $html_children[] = $moveto;
271                     }
273                     if ($this->moving) {
274                         $row_count++;
275                     }
276                 }
278                 $row_count += $child_row_count;
280                 // If the child is a category, increment row_count by one more (for the extra coloured row)
281                 if ($child_el['type'] == 'category') {
282                     $row_count++;
283                 }
284             }
286             // Print category total at the end if aggregation position is "last" (1)
287             if (!empty($category_total_item) && $aggregation_position) {
288                 $html_children = array_merge($html_children, $category_total_item);
289             }
291             // Determine if we are at the root
292             if (isset($element['object']->grade_item) && $element['object']->grade_item->is_course_item()) {
293                 $root = true;
294             }
296             $levelclass = "level$level level" . ($level % 2 ? 'odd' : 'even');
298             $courseclass = '';
299             if ($level == 1) {
300                 $courseclass = 'coursecategory';
301             }
303             $row = new html_table_row();
304             $row->id = 'grade-item-' . $eid;
305             $row->attributes['class'] = $courseclass . ' category ' . $dimmed;
306             $row->attributes['data-category'] = $eid;
307             $row->attributes['data-itemid'] = $category->get_grade_item()->id;
308             foreach ($rowclasses as $class) {
309                 $row->attributes['class'] .= ' ' . $class;
310             }
312             $headercell = new html_table_cell();
313             $headercell->header = true;
314             $headercell->scope = 'row';
315             $headercell->attributes['title'] = $object->stripped_name;
316             $headercell->attributes['class'] = 'cell column-rowspan rowspan ' . $levelclass;
317             $headercell->rowspan = $row_count + 1;
318             $row->cells[] = $headercell;
320             foreach ($this->columns as $column) {
321                 if (!($this->moving && $column->hide_when_moving)) {
322                     $row->cells[] = $column->get_category_cell($category, $levelclass, [
323                         'id' => $id,
324                         'name' => $object->name,
325                         'level' => $level,
326                         'actions' => $actions,
327                         'moveaction' => $moveaction,
328                         'eid' => $eid,
329                     ]);
330                 }
331             }
333             $returnrows[] = $row;
335             $returnrows = array_merge($returnrows, $html_children);
337             // Print a coloured row to show the end of the category across the table
338             $endcell = new html_table_cell();
339             $endcell->colspan = (19 - $level);
340             $endcell->attributes['class'] = 'emptyrow colspan ' . $levelclass;
342             $returnrows[] = new html_table_row(array($endcell));
344         } else { // Dealing with a grade item
346             $item = grade_item::fetch(array('id' => $object->id));
347             $element['type'] = 'item';
348             $element['object'] = $item;
350             $categoryitemclass = '';
351             if ($item->itemtype == 'category') {
352                 $categoryitemclass = 'categoryitem';
353             }
354             if ($item->itemtype == 'course') {
355                 $categoryitemclass = 'courseitem';
356             }
358             $dimmed = ($item->is_hidden()) ? "dimmed_text" : "";
359             $gradeitemrow = new html_table_row();
360             $gradeitemrow->id = 'grade-item-' . $eid;
361             $gradeitemrow->attributes['class'] = $categoryitemclass . ' item ' . $dimmed;
362             $gradeitemrow->attributes['data-itemid'] = $object->id;
363             foreach ($rowclasses as $class) {
364                 $gradeitemrow->attributes['class'] .= ' ' . $class;
365             }
367             foreach ($this->columns as $column) {
368                 if (!($this->moving && $column->hide_when_moving)) {
369                     $gradeitemrow->cells[] = $column->get_item_cell($item, array('id' => $id, 'name' => $object->name,
370                         'level' => $level, 'actions' => $actions, 'element' => $element, 'eid' => $eid,
371                         'moveaction' => $moveaction, 'itemtype' => $object->itemtype));
372                 }
373             }
375             $returnrows[] = $gradeitemrow;
376         }
378         return $returnrows;
380     }
382     /**
383      * Given a grade_item object, returns a labelled input if an aggregation coefficient (weight or extra credit) applies to it.
384      * @param grade_item $item
385      * @return string HTML
386      */
387     static function get_weight_input($item) {
388         global $OUTPUT;
390         if (!is_object($item) || get_class($item) !== 'grade_item') {
391             throw new Exception('grade_edit_tree::get_weight_input($item) was given a variable that is not of the required type (grade_item object)');
392             return false;
393         }
395         if ($item->is_course_item()) {
396             return '';
397         }
399         $parent_category = $item->get_parent_category();
400         $parent_category->apply_forced_settings();
401         $aggcoef = $item->get_coefstring();
403         $itemname = $item->itemname;
404         if ($item->is_category_item()) {
405             // Remember, the parent category of a category item is the category itself.
406             $itemname = $parent_category->get_name();
407         }
408         $str = '';
410         if ($aggcoef == 'aggregationcoefweight' || $aggcoef == 'aggregationcoef' || $aggcoef == 'aggregationcoefextraweight') {
412             return $OUTPUT->render_from_template('core_grades/weight_field', [
413                 'id' => $item->id,
414                 'itemname' => $itemname,
415                 'value' => self::format_number($item->aggregationcoef)
416             ]);
418         } else if ($aggcoef == 'aggregationcoefextraweightsum') {
420             $tpldata = [
421                 'id' => $item->id,
422                 'itemname' => $itemname,
423                 'value' => self::format_number($item->aggregationcoef2 * 100.0),
424                 'checked' => $item->weightoverride,
425                 'disabled' => !$item->weightoverride
426             ];
427             $str .= $OUTPUT->render_from_template('core_grades/weight_override_field', $tpldata);
429         }
431         return $str;
432     }
434     // Trims trailing zeros.
435     // Used on the 'Gradebook setup' page for grade items settings like aggregation co-efficient.
436     // Grader report has its own decimal place settings so they are handled elsewhere.
437     static function format_number($number) {
438         $formatted = rtrim(format_float($number, 4),'0');
439         if (substr($formatted, -1)==get_string('decsep', 'langconfig')) { //if last char is the decimal point
440             $formatted .= '0';
441         }
442         return $formatted;
443     }
445     /**
446      * Given an element of the grade tree, returns whether it is deletable or not (only manual grade items are deletable)
447      *
448      * @param array $element
449      * @return bool
450      */
451     function element_deletable($element) {
452         global $COURSE;
454         if ($element['type'] != 'item') {
455             return true;
456         }
458         $grade_item = $element['object'];
460         if ($grade_item->itemtype != 'mod' or $grade_item->is_outcome_item() or $grade_item->gradetype == GRADE_TYPE_NONE) {
461             return true;
462         }
464         $modinfo = get_fast_modinfo($COURSE);
465         if (!isset($modinfo->instances[$grade_item->itemmodule][$grade_item->iteminstance])) {
466             // module does not exist
467             return true;
468         }
470         return false;
471     }
473     /**
474      * Given an element of the grade tree, returns whether it is duplicatable or not (only manual grade items are duplicatable)
475      *
476      * @param array $element
477      * @return bool
478      */
479     public function element_duplicatable($element) {
480         if ($element['type'] != 'item') {
481             return false;
482         }
484         $gradeitem = $element['object'];
485         if ($gradeitem->itemtype != 'mod') {
486             return true;
487         }
488         return false;
489     }
491     /**
492      * Given the grade tree and an array of element ids (e.g. c15, i42), and expecting the 'moveafter' URL param,
493      * moves the selected items to the requested location. Then redirects the user to the given $returnurl
494      *
495      * @param object $gtree The grade tree (a recursive representation of the grade categories and grade items)
496      * @param array $eids
497      * @param string $returnurl
498      */
499     function move_elements($eids, $returnurl) {
500         $moveafter = required_param('moveafter', PARAM_INT);
502         if (!is_array($eids)) {
503             $eids = array($eids);
504         }
506         if(!$after_el = $this->gtree->locate_element("cg$moveafter")) {
507             print_error('invalidelementid', '', $returnurl);
508         }
510         $after = $after_el['object'];
511         $parent = $after;
512         $sortorder = $after->get_sortorder();
514         foreach ($eids as $eid) {
515             if (!$element = $this->gtree->locate_element($eid)) {
516                 print_error('invalidelementid', '', $returnurl);
517             }
518             $object = $element['object'];
520             $object->set_parent($parent->id);
521             $object->move_after_sortorder($sortorder);
522             $sortorder++;
523         }
525         redirect($returnurl, '', 0);
526     }
528     /**
529      * Recurses through the entire grade tree to find and return the maximum depth of the tree.
530      * This should be run only once from the root element (course category), and is used for the
531      * indentation of the Name column's cells (colspan)
532      *
533      * @param array $element An array of values representing a grade tree's element (all grade items in this case)
534      * @param int $level The level of the current recursion
535      * @param int $deepest_level A value passed to each subsequent level of recursion and incremented if $level > $deepest_level
536      * @return int Deepest level
537      */
538     function get_deepest_level($element, $level=0, $deepest_level=1) {
539         $object = $element['object'];
541         $level++;
542         $coefstring = $element['object']->get_coefstring();
543         if ($element['type'] == 'category') {
544             if ($coefstring == 'aggregationcoefweight' || $coefstring == 'aggregationcoefextraweightsum' ||
545                     $coefstring == 'aggregationcoefextraweight') {
546                 $this->uses_weight = true;
547             }
549             foreach($element['children'] as $child_el) {
550                 if ($level > $deepest_level) {
551                     $deepest_level = $level;
552                 }
553                 $deepest_level = $this->get_deepest_level($child_el, $level, $deepest_level);
554             }
556             $category = grade_category::fetch(array('id' => $object->id));
557             $item = $category->get_grade_item();
558             if ($item->gradetype == GRADE_TYPE_NONE) {
559                 // Add 1 more level for grade category that has no total.
560                 $deepest_level++;
561             }
562         }
564         return $deepest_level;
565     }
567     /**
568      * Updates the provided gradecategory item with the provided data.
569      *
570      * @param grade_category $gradecategory The category to update.
571      * @param stdClass $data the data to update the category with.
572      * @return void
573      */
574     public static function update_gradecategory(grade_category $gradecategory, stdClass $data) {
575         // If no fullname is entered for a course category, put ? in the DB.
576         if (!isset($data->fullname) || $data->fullname == '') {
577             $data->fullname = '?';
578         }
580         if (!isset($data->aggregateonlygraded)) {
581             $data->aggregateonlygraded = 0;
582         }
583         if (!isset($data->aggregateoutcomes)) {
584             $data->aggregateoutcomes = 0;
585         }
586         grade_category::set_properties($gradecategory, $data);
588         // CATEGORY.
589         if (empty($gradecategory->id)) {
590             $gradecategory->insert();
592         } else {
593             $gradecategory->update();
594         }
596         // GRADE ITEM.
597         // Grade item data saved with prefix "grade_item_".
598         $itemdata = new stdClass();
599         foreach ($data as $k => $v) {
600             if (preg_match('/grade_item_(.*)/', $k, $matches)) {
601                 $itemdata->{$matches[1]} = $v;
602             }
603         }
605         if (!isset($itemdata->aggregationcoef)) {
606             $itemdata->aggregationcoef = 0;
607         }
609         if (!isset($itemdata->gradepass) || $itemdata->gradepass == '') {
610             $itemdata->gradepass = 0;
611         }
613         if (!isset($itemdata->grademax) || $itemdata->grademax == '') {
614             $itemdata->grademax = 0;
615         }
617         if (!isset($itemdata->grademin) || $itemdata->grademin == '') {
618             $itemdata->grademin = 0;
619         }
621         $hidden      = empty($itemdata->hidden) ? 0 : $itemdata->hidden;
622         $hiddenuntil = empty($itemdata->hiddenuntil) ? 0 : $itemdata->hiddenuntil;
623         unset($itemdata->hidden);
624         unset($itemdata->hiddenuntil);
626         $locked   = empty($itemdata->locked) ? 0 : $itemdata->locked;
627         $locktime = empty($itemdata->locktime) ? 0 : $itemdata->locktime;
628         unset($itemdata->locked);
629         unset($itemdata->locktime);
631         $convert = array('grademax', 'grademin', 'gradepass', 'multfactor', 'plusfactor', 'aggregationcoef', 'aggregationcoef2');
632         foreach ($convert as $param) {
633             if (property_exists($itemdata, $param)) {
634                 $itemdata->$param = unformat_float($itemdata->$param);
635             }
636         }
637         if (isset($itemdata->aggregationcoef2)) {
638             $itemdata->aggregationcoef2 = $itemdata->aggregationcoef2 / 100.0;
639         }
641         // When creating a new category, a number of grade item fields are filled out automatically, and are required.
642         // If the user leaves these fields empty during creation of a category, we let the default values take effect.
643         // Otherwise, we let the user-entered grade item values take effect.
644         $gradeitem = $gradecategory->load_grade_item();
645         $gradeitemcopy = fullclone($gradeitem);
646         grade_item::set_properties($gradeitem, $itemdata);
648         if (empty($gradeitem->id)) {
649             $gradeitem->id = $gradeitemcopy->id;
650         }
651         if (empty($gradeitem->grademax) && $gradeitem->grademax != '0') {
652             $gradeitem->grademax = $gradeitemcopy->grademax;
653         }
654         if (empty($gradeitem->grademin) && $gradeitem->grademin != '0') {
655             $gradeitem->grademin = $gradeitemcopy->grademin;
656         }
657         if (empty($gradeitem->gradepass) && $gradeitem->gradepass != '0') {
658             $gradeitem->gradepass = $gradeitemcopy->gradepass;
659         }
660         if (empty($gradeitem->aggregationcoef) && $gradeitem->aggregationcoef != '0') {
661             $gradeitem->aggregationcoef = $gradeitemcopy->aggregationcoef;
662         }
664         // Handle null decimals value - must be done before update!
665         if (!property_exists($itemdata, 'decimals') or $itemdata->decimals < 0) {
666             $gradeitem->decimals = null;
667         }
669         // Change weightoverride flag. Check if the value is set, because it is not when the checkbox is not ticked.
670         $itemdata->weightoverride = isset($itemdata->weightoverride) ? $itemdata->weightoverride : 0;
671         if ($gradeitem->weightoverride != $itemdata->weightoverride && $gradecategory->aggregation == GRADE_AGGREGATE_SUM) {
672             // If we are using natural weight and the weight has been un-overriden, force parent category to recalculate weights.
673             $gradecategory->force_regrading();
674         }
675         $gradeitem->weightoverride = $itemdata->weightoverride;
677         $gradeitem->outcomeid = null;
679         if (!empty($data->grade_item_rescalegrades) && $data->grade_item_rescalegrades == 'yes') {
680             $gradeitem->rescale_grades_keep_percentage($gradeitemcopy->grademin, $gradeitemcopy->grademax,
681                 $gradeitem->grademin, $gradeitem->grademax, 'gradebook');
682         }
684         // Update hiding flag.
685         if ($hiddenuntil) {
686             $gradeitem->set_hidden($hiddenuntil, false);
687         } else {
688             $gradeitem->set_hidden($hidden, false);
689         }
691         $gradeitem->set_locktime($locktime); // Locktime first - it might be removed when unlocking.
692         $gradeitem->set_locked($locked, false, true);
694         $gradeitem->update(); // We don't need to insert it, it's already created when the category is created.
696         // Set parent if needed.
697         if (isset($data->parentcategory)) {
698             $gradecategory->set_parent($data->parentcategory, 'gradebook');
699         }
700     }
703 /**
704  * Class grade_edit_tree_column
705  *
706  * @package   core_grades
707  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
708  */
709 abstract class grade_edit_tree_column {
710     public $forced;
711     public $hidden;
712     public $forced_hidden;
713     public $advanced_hidden;
714     public $hide_when_moving = true;
715     /**
716      * html_table_cell object used as a template for header cells in all categories.
717      * It must be cloned before being used.
718      * @var html_table_cell $headercell
719      */
720     public $headercell;
721     /**
722      * html_table_cell object used as a template for category cells in all categories.
723      * It must be cloned before being used.
724      * @var html_table_cell $categorycell
725      */
726     public $categorycell;
727     /**
728      * html_table_cell object used as a template for item cells in all categories.
729      * It must be cloned before being used.
730      * @var html_table_cell $itemcell
731      */
732     public $itemcell;
734     public static function factory($name, $params=array()) {
735         $class_name = "grade_edit_tree_column_$name";
736         if (class_exists($class_name)) {
737             return new $class_name($params);
738         }
739     }
741     public abstract function get_header_cell();
743     public function get_category_cell($category, $levelclass, $params) {
744         $cell = clone($this->categorycell);
745         $cell->attributes['class'] .= ' ' . $levelclass;
746         $cell->attributes['text'] = '';
747         return $cell;
748     }
750     public function get_item_cell($item, $params) {
751         $cell = clone($this->itemcell);
752         $cell->attributes['text'] = '';
753         if (isset($params['level'])) {
754             $level = $params['level'] + (($item->itemtype == 'category' || $item->itemtype == 'course') ? 0 : 1);
755             $cell->attributes['class'] .= ' level' . $level;
756             $cell->attributes['class'] .= ' level' . ($level % 2 ? 'odd' : 'even');
757         }
758         return $cell;
759     }
761     public function __construct() {
762         $this->headercell = new html_table_cell();
763         $this->headercell->header = true;
764         $this->headercell->attributes['class'] = 'header';
766         $this->categorycell = new html_table_cell();
767         $this->categorycell->attributes['class']  = 'cell';
769         $this->itemcell = new html_table_cell();
770         $this->itemcell->attributes['class'] = 'cell';
772         if (preg_match('/^grade_edit_tree_column_(\w*)$/', get_class($this), $matches)) {
773             $this->headercell->attributes['class'] .= ' column-' . $matches[1];
774             $this->categorycell->attributes['class'] .= ' column-' . $matches[1];
775             $this->itemcell->attributes['class'] .= ' column-' . $matches[1];
776         }
777     }
780 /**
781  * Class grade_edit_tree_column_name
782  *
783  * @package   core_grades
784  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
785  */
786 class grade_edit_tree_column_name extends grade_edit_tree_column {
787     public $forced = false;
788     public $hidden = false;
789     public $forced_hidden = false;
790     public $advanced_hidden = false;
791     public $deepest_level = 1;
792     public $hide_when_moving = false;
794     public function __construct($params) {
795         if (empty($params['deepest_level'])) {
796             throw new Exception('Tried to instantiate a grade_edit_tree_column_name object without the "deepest_level" param!');
797         }
799         $this->deepest_level = $params['deepest_level'];
800         parent::__construct();
801     }
803     public function get_header_cell() {
804         $headercell = clone($this->headercell);
805         $headercell->colspan = $this->deepest_level + 1;
806         $headercell->text = get_string('name');
807         return $headercell;
808     }
810     public function get_category_cell($category, $levelclass, $params) {
811         global $OUTPUT;
812         if (empty($params['name']) || empty($params['level'])) {
813             throw new Exception('Array key (name or level) missing from 3rd param of grade_edit_tree_column_name::get_category_cell($category, $levelclass, $params)');
814         }
815         $moveaction = isset($params['moveaction']) ? $params['moveaction'] : '';
816         $categorycell = parent::get_category_cell($category, $levelclass, $params);
817         $categorycell->colspan = ($this->deepest_level +1) - $params['level'];
818         $categorycell->text = $OUTPUT->heading($moveaction . $params['name'], 4);
819         return $categorycell;
820     }
822     public function get_item_cell($item, $params) {
823         global $CFG;
825         if (empty($params['element']) || empty($params['name']) || empty($params['level'])) {
826             throw new Exception('Array key (name, level or element) missing from 2nd param of grade_edit_tree_column_name::get_item_cell($item, $params)');
827         }
829         $name = $params['name'];
830         $moveaction = isset($params['moveaction']) ? $params['moveaction'] : '';
832         $itemcell = parent::get_item_cell($item, $params);
833         $itemcell->colspan = ($this->deepest_level + 1) - $params['level'];
834         $itemcell->text = $moveaction . $name;
835         return $itemcell;
836     }
839 /**
840  * Class grade_edit_tree_column_weight
841  *
842  * @package   core_grades
843  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
844  */
845 class grade_edit_tree_column_weight extends grade_edit_tree_column {
847     public function get_header_cell() {
848         global $OUTPUT;
849         $headercell = clone($this->headercell);
850         $headercell->text = get_string('weights', 'grades').$OUTPUT->help_icon('aggregationcoefweight', 'grades');
851         return $headercell;
852     }
854     public function get_category_cell($category, $levelclass, $params) {
856         $item = $category->get_grade_item();
857         $categorycell = parent::get_category_cell($category, $levelclass, $params);
858         $categorycell->text = grade_edit_tree::get_weight_input($item);
859         return $categorycell;
860     }
862     public function get_item_cell($item, $params) {
863         global $CFG;
864         if (empty($params['element'])) {
865             throw new Exception('Array key (element) missing from 2nd param of grade_edit_tree_column_weightorextracredit::get_item_cell($item, $params)');
866         }
867         $itemcell = parent::get_item_cell($item, $params);
868         $itemcell->text = '&nbsp;';
869         $object = $params['element']['object'];
871         if (!in_array($object->itemtype, array('courseitem', 'categoryitem', 'category'))
872                 && !in_array($object->gradetype, array(GRADE_TYPE_NONE, GRADE_TYPE_TEXT))
873                 && (!$object->is_outcome_item() || $object->load_parent_category()->aggregateoutcomes)
874                 && ($object->gradetype != GRADE_TYPE_SCALE || !empty($CFG->grade_includescalesinaggregation))) {
875             $itemcell->text = grade_edit_tree::get_weight_input($item);
876         }
878         return $itemcell;
879     }
882 /**
883  * Class grade_edit_tree_column_range
884  *
885  * @package   core_grades
886  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
887  */
888 class grade_edit_tree_column_range extends grade_edit_tree_column {
890     public function get_header_cell() {
891         $headercell = clone($this->headercell);
892         $headercell->text = get_string('maxgrade', 'grades');
893         return $headercell;
894     }
896     public function get_category_cell($category, $levelclass, $params) {
897         $categorycell = parent::get_category_cell($category, $levelclass, $params);
898         $categorycell->text = ' - ';
899         return $categorycell;
900     }
902     public function get_item_cell($item, $params) {
903         global $DB, $OUTPUT;
905         // If the parent aggregation is Natural, we should show the number, even for scales, as that value is used...
906         // ...in the computation. For text grades, the grademax is not used, so we can still show the no value string.
907         $parentcat = $item->get_parent_category();
908         if ($item->gradetype == GRADE_TYPE_TEXT) {
909             $grademax = ' - ';
910         } else if ($item->gradetype == GRADE_TYPE_SCALE) {
911             $scale = $DB->get_record('scale', array('id' => $item->scaleid));
912             $scale_items = null;
913             if (empty($scale)) { //if the item is using a scale that's been removed
914                 $scale_items = array();
915             } else {
916                 $scale_items = explode(',', $scale->scale);
917             }
918             if ($parentcat->aggregation == GRADE_AGGREGATE_SUM) {
919                 $grademax = end($scale_items) . ' (' .
920                         format_float($item->grademax, $item->get_decimals()) . ')';
921             } else {
922                 $grademax = end($scale_items) . ' (' . count($scale_items) . ')';
923             }
924         } else {
925             $grademax = format_float($item->grademax, $item->get_decimals());
926         }
928         $isextracredit = false;
929         if ($item->aggregationcoef > 0) {
930             // For category grade items, we need the grandparent category.
931             // The parent is just category the grade item represents.
932             if ($item->is_category_item()) {
933                 $grandparentcat = $parentcat->get_parent_category();
934                 if ($grandparentcat->is_extracredit_used()) {
935                     $isextracredit = true;
936                 }
937             } else if ($parentcat->is_extracredit_used()) {
938                 $isextracredit = true;
939             }
940         }
941         if ($isextracredit) {
942             $grademax .= ' ' . html_writer::tag('abbr', get_string('aggregationcoefextrasumabbr', 'grades'),
943                 array('title' => get_string('aggregationcoefextrasum', 'grades')));
944         }
946         $itemcell = parent::get_item_cell($item, $params);
947         $itemcell->text = $grademax;
948         return $itemcell;
949     }
952 /**
953  * Class grade_edit_tree_column_actions
954  *
955  * @package   core_grades
956  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
957  */
958 class grade_edit_tree_column_actions extends grade_edit_tree_column {
960     public function __construct($params) {
961         parent::__construct();
962     }
964     public function get_header_cell() {
965         $headercell = clone($this->headercell);
966         $headercell->text = get_string('actions');
967         return $headercell;
968     }
970     public function get_category_cell($category, $levelclass, $params) {
972         if (empty($params['actions'])) {
973             throw new Exception('Array key (actions) missing from 3rd param of grade_edit_tree_column_actions::get_category_actions($category, $levelclass, $params)');
974         }
976         $categorycell = parent::get_category_cell($category, $levelclass, $params);
977         $categorycell->text = $params['actions'];
978         return $categorycell;
979     }
981     public function get_item_cell($item, $params) {
982         if (empty($params['actions'])) {
983             throw new Exception('Array key (actions) missing from 2nd param of grade_edit_tree_column_actions::get_item_cell($item, $params)');
984         }
985         $itemcell = parent::get_item_cell($item, $params);
986         $itemcell->text = $params['actions'];
987         return $itemcell;
988     }
991 /**
992  * Class grade_edit_tree_column_select
993  *
994  * @package   core_grades
995  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
996  */
997 class grade_edit_tree_column_select extends grade_edit_tree_column {
999     public function get_header_cell() {
1000         $headercell = clone($this->headercell);
1001         $headercell->text = get_string('select');
1002         return $headercell;
1003     }
1005     public function get_category_cell($category, $levelclass, $params) {
1006         global $OUTPUT;
1008         if (empty($params['eid'])) {
1009             throw new Exception('Array key (eid) missing from 3rd param of grade_edit_tree_column_select::get_category_cell($category, $levelclass, $params)');
1010         }
1012         // Get toggle group for this master checkbox.
1013         $togglegroup = $this->get_checkbox_togglegroup($category);
1014         // Set label for this master checkbox.
1015         $masterlabel = get_string('all');
1016         // Use category name if available.
1017         if ($category->fullname !== '?') {
1018             $masterlabel = format_string($category->fullname);
1019             // Limit the displayed category name to prevent the Select column from getting too wide.
1020             if (core_text::strlen($masterlabel) > 20) {
1021                 $masterlabel = get_string('textellipsis', 'core', core_text::substr($masterlabel, 0, 12));
1022             }
1023         }
1024         // Build the master checkbox.
1025         $mastercheckbox = new \core\output\checkbox_toggleall($togglegroup, true, [
1026             'id' => $togglegroup,
1027             'name' => $togglegroup,
1028             'value' => 1,
1029             'classes' => 'itemselect ignoredirty',
1030             'label' => $masterlabel,
1031             // Consistent label to prevent the select column from resizing.
1032             'selectall' => $masterlabel,
1033             'deselectall' => $masterlabel,
1034             'labelclasses' => 'm-0',
1035         ]);
1037         $categorycell = parent::get_category_cell($category, $levelclass, $params);
1038         $categorycell->text = $OUTPUT->render($mastercheckbox);
1039         return $categorycell;
1040     }
1042     public function get_item_cell($item, $params) {
1043         if (empty($params['itemtype']) || empty($params['eid'])) {
1044             print_error('missingitemtypeoreid', 'core_grades');
1045         }
1046         $itemcell = parent::get_item_cell($item, $params);
1048         if ($params['itemtype'] != 'course' && $params['itemtype'] != 'category') {
1049             global $OUTPUT;
1051             // Fetch the grade item's category.
1052             $category = grade_category::fetch(['id' => $item->categoryid]);
1053             $togglegroup = $this->get_checkbox_togglegroup($category);
1055             $checkboxid = 'select_' . $params['eid'];
1056             $checkbox = new \core\output\checkbox_toggleall($togglegroup, false, [
1057                 'id' => $checkboxid,
1058                 'name' => $checkboxid,
1059                 'label' => get_string('select', 'grades', $item->itemname),
1060                 'labelclasses' => 'accesshide',
1061                 'classes' => 'itemselect ignoredirty',
1062             ]);
1063             $itemcell->text = $OUTPUT->render($checkbox);
1064         }
1065         return $itemcell;
1066     }
1068     /**
1069      * Generates a toggle group name for a bulk-action checkbox based on the given grade category.
1070      *
1071      * @param grade_category $category The grade category.
1072      * @return string
1073      */
1074     protected function get_checkbox_togglegroup(grade_category $category): string {
1075         $levels = [];
1076         $categories = explode('/', $category->path);
1077         foreach ($categories as $categoryid) {
1078             $level = 'category' . $categoryid;
1079             if (!in_array($level, $levels)) {
1080                 $levels[] = 'category' . $categoryid;
1081             }
1082         }
1083         $togglegroup = implode(' ', $levels);
1085         return $togglegroup;
1086     }