MDL-18772 fixed aut oupdating of grademax for SUM aggregation type
[moodle.git] / lib / grade / grade_category.php
1 <?php // $Id$
3 ///////////////////////////////////////////////////////////////////////////
4 //                                                                       //
5 // NOTICE OF COPYRIGHT                                                   //
6 //                                                                       //
7 // Moodle - Modular Object-Oriented Dynamic Learning Environment         //
8 //          http://moodle.com                                            //
9 //                                                                       //
10 // Copyright (C) 1999 onwards Martin Dougiamas  http://dougiamas.com     //
11 //                                                                       //
12 // This program is free software; you can redistribute it and/or modify  //
13 // it under the terms of the GNU General Public License as published by  //
14 // the Free Software Foundation; either version 2 of the License, or     //
15 // (at your option) any later version.                                   //
16 //                                                                       //
17 // This program is distributed in the hope that it will be useful,       //
18 // but WITHOUT ANY WARRANTY; without even the implied warranty of        //
19 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         //
20 // GNU General Public License for more details:                          //
21 //                                                                       //
22 //          http://www.gnu.org/copyleft/gpl.html                         //
23 //                                                                       //
24 ///////////////////////////////////////////////////////////////////////////
26 require_once('grade_object.php');
28 class grade_category extends grade_object {
29     /**
30      * The DB table.
31      * @var string $table
32      */
33     public $table = 'grade_categories';
35     /**
36      * Array of required table fields, must start with 'id'.
37      * @var array $required_fields
38      */
39     public $required_fields = array('id', 'courseid', 'parent', 'depth', 'path', 'fullname', 'aggregation',
40                                  'keephigh', 'droplow', 'aggregateonlygraded', 'aggregateoutcomes',
41                                  'aggregatesubcats', 'timecreated', 'timemodified');
43     /**
44      * The course this category belongs to.
45      * @var int $courseid
46      */
47     public $courseid;
49     /**
50      * The category this category belongs to (optional).
51      * @var int $parent
52      */
53     public $parent;
55     /**
56      * The grade_category object referenced by $this->parent (PK).
57      * @var object $parent_category
58      */
59     public $parent_category;
61     /**
62      * The number of parents this category has.
63      * @var int $depth
64      */
65     public $depth = 0;
67     /**
68      * Shows the hierarchical path for this category as /1/2/3/ (like course_categories), the last number being
69      * this category's autoincrement ID number.
70      * @var string $path
71      */
72     public $path;
74     /**
75      * The name of this category.
76      * @var string $fullname
77      */
78     public $fullname;
80     /**
81      * A constant pointing to one of the predefined aggregation strategies (none, mean, median, sum etc) .
82      * @var int $aggregation
83      */
84     public $aggregation = GRADE_AGGREGATE_MEAN;
86     /**
87      * Keep only the X highest items.
88      * @var int $keephigh
89      */
90     public $keephigh = 0;
92     /**
93      * Drop the X lowest items.
94      * @var int $droplow
95      */
96     public $droplow = 0;
98     /**
99      * Aggregate only graded items
100      * @var int $aggregateonlygraded
101      */
102     public $aggregateonlygraded = 0;
104     /**
105      * Aggregate outcomes together with normal items
106      * @var int $aggregateoutcomes
107      */
108     public $aggregateoutcomes = 0;
110     /**
111      * Ignore subcategories when aggregating
112      * @var int $aggregatesubcats
113      */
114     public $aggregatesubcats = 0;
116     /**
117      * Array of grade_items or grade_categories nested exactly 1 level below this category
118      * @var array $children
119      */
120     public $children;
122     /**
123      * A hierarchical array of all children below this category. This is stored separately from
124      * $children because it is more memory-intensive and may not be used as often.
125      * @var array $all_children
126      */
127     public $all_children;
129     /**
130      * An associated grade_item object, with itemtype=category, used to calculate and cache a set of grade values
131      * for this category.
132      * @var object $grade_item
133      */
134     public $grade_item;
136     /**
137      * Temporary sortorder for speedup of children resorting
138      */
139     public $sortorder;
141     /**
142      * List of options which can be "forced" from site settings.
143      */
144     public $forceable = array('aggregation', 'keephigh', 'droplow', 'aggregateonlygraded', 'aggregateoutcomes', 'aggregatesubcats');
146     /**
147      * Builds this category's path string based on its parents (if any) and its own id number.
148      * This is typically done just before inserting this object in the DB for the first time,
149      * or when a new parent is added or changed. It is a recursive function: once the calling
150      * object no longer has a parent, the path is complete.
151      *
152      * @static
153      * @param object $grade_category
154      * @return int The depth of this category (2 means there is one parent)
155      */
156     public function build_path($grade_category) {
157         global $DB;
159         if (empty($grade_category->parent)) {
160             return '/'.$grade_category->id.'/';
161         } else {
162             $parent = $DB->get_record('grade_categories', array('id' => $grade_category->parent));
163             return grade_category::build_path($parent).$grade_category->id.'/';
164         }
165     }
167     /**
168      * Finds and returns a grade_category instance based on params.
169      * @static
170      *
171      * @param array $params associative arrays varname=>value
172      * @return object grade_category instance or false if none found.
173      */
174     public static function fetch($params) {
175         return grade_object::fetch_helper('grade_categories', 'grade_category', $params);
176     }
178     /**
179      * Finds and returns all grade_category instances based on params.
180      * @static
181      *
182      * @param array $params associative arrays varname=>value
183      * @return array array of grade_category insatnces or false if none found.
184      */
185     public static function fetch_all($params) {
186         return grade_object::fetch_all_helper('grade_categories', 'grade_category', $params);
187     }
189     /**
190      * In addition to update() as defined in grade_object, call force_regrading of parent categories, if applicable.
191      * @param string $source from where was the object updated (mod/forum, manual, etc.)
192      * @return boolean success
193      */
194     public function update($source=null) {
195         // load the grade item or create a new one
196         $this->load_grade_item();
198         // force recalculation of path;
199         if (empty($this->path)) {
200             $this->path  = grade_category::build_path($this);
201             $this->depth = substr_count($this->path, '/') - 1;
202             $updatechildren = true;
203         } else {
204             $updatechildren = false;
205         }
207         $this->apply_forced_settings();
209                 // these are exclusive
210         if ($this->droplow > 0) {
211             $this->keephigh = 0;
212         } else if ($this->keephigh > 0) {
213             $this->droplow = 0;
214         }
216         // Recalculate grades if needed
217         if ($this->qualifies_for_regrading()) {
218             $this->force_regrading();
219         }
221         $this->timemodified = time();
223         $result = parent::update($source);
225         // now update paths in all child categories
226         if ($result and $updatechildren) {
227             if ($children = grade_category::fetch_all(array('parent'=>$this->id))) {
228                 foreach ($children as $child) {
229                     $child->path  = null;
230                     $child->depth = 0;
231                     $child->update($source);
232                 }
233             }
234         }
236         return $result;
237     }
239     /**
240      * If parent::delete() is successful, send force_regrading message to parent category.
241      * @param string $source from where was the object deleted (mod/forum, manual, etc.)
242      * @return boolean success
243      */
244     public function delete($source=null) {
245         $grade_item = $this->load_grade_item();
247         if ($this->is_course_category()) {
248             if ($categories = grade_category::fetch_all(array('courseid'=>$this->courseid))) {
249                 foreach ($categories as $category) {
250                     if ($category->id == $this->id) {
251                         continue; // do not delete course category yet
252                     }
253                     $category->delete($source);
254                 }
255             }
257             if ($items = grade_item::fetch_all(array('courseid'=>$this->courseid))) {
258                 foreach ($items as $item) {
259                     if ($item->id == $grade_item->id) {
260                         continue; // do not delete course item yet
261                     }
262                     $item->delete($source);
263                 }
264             }
266         } else {
267             $this->force_regrading();
269             $parent = $this->load_parent_category();
271             // Update children's categoryid/parent field first
272             if ($children = grade_item::fetch_all(array('categoryid'=>$this->id))) {
273                 foreach ($children as $child) {
274                     $child->set_parent($parent->id);
275                 }
276             }
277             if ($children = grade_category::fetch_all(array('parent'=>$this->id))) {
278                 foreach ($children as $child) {
279                     $child->set_parent($parent->id);
280                 }
281             }
282         }
284         // first delete the attached grade item and grades
285         $grade_item->delete($source);
287         // delete category itself
288         return parent::delete($source);
289     }
291     /**
292      * In addition to the normal insert() defined in grade_object, this method sets the depth
293      * and path for this object, and update the record accordingly. The reason why this must
294      * be done here instead of in the constructor, is that they both need to know the record's
295      * id number, which only gets created at insertion time.
296      * This method also creates an associated grade_item if this wasn't done during construction.
297      * @param string $source from where was the object inserted (mod/forum, manual, etc.)
298      * @return int PK ID if successful, false otherwise
299      */
300     public function insert($source=null) {
302         if (empty($this->courseid)) {
303             print_error('cannotinsertgrade');
304         }
306         if (empty($this->parent)) {
307             $course_category = grade_category::fetch_course_category($this->courseid);
308             $this->parent = $course_category->id;
309         }
311         $this->path = null;
313         $this->timecreated = $this->timemodified = time();
315         if (!parent::insert($source)) {
316             debugging("Could not insert this category: " . print_r($this, true));
317             return false;
318         }
320         $this->force_regrading();
322         // build path and depth
323         $this->update($source);
325         return $this->id;
326     }
328     /**
329      * Internal function - used only from fetch_course_category()
330      * Normal insert() can not be used for course category
331      * @param int $courseid
332      * @return bool success
333      */
334     public function insert_course_category($courseid) {
335         $this->courseid    = $courseid;
336         $this->fullname    = '?';
337         $this->path        = null;
338         $this->parent      = null;
339         $this->aggregation = GRADE_AGGREGATE_WEIGHTED_MEAN2;
341         $this->apply_default_settings();
342         $this->apply_forced_settings();
344         $this->timecreated = $this->timemodified = time();
346         if (!parent::insert('system')) {
347             debugging("Could not insert this category: " . print_r($this, true));
348             return false;
349         }
351         // build path and depth
352         $this->update('system');
354         return $this->id;
355     }
357     /**
358      * Compares the values held by this object with those of the matching record in DB, and returns
359      * whether or not these differences are sufficient to justify an update of all parent objects.
360      * This assumes that this object has an id number and a matching record in DB. If not, it will return false.
361      * @return boolean
362      */
363     public function qualifies_for_regrading() {
364         if (empty($this->id)) {
365             debugging("Can not regrade non existing category");
366             return false;
367         }
369         $db_item = grade_category::fetch(array('id'=>$this->id));
371         $aggregationdiff = $db_item->aggregation         != $this->aggregation;
372         $keephighdiff    = $db_item->keephigh            != $this->keephigh;
373         $droplowdiff     = $db_item->droplow             != $this->droplow;
374         $aggonlygrddiff  = $db_item->aggregateonlygraded != $this->aggregateonlygraded;
375         $aggoutcomesdiff = $db_item->aggregateoutcomes   != $this->aggregateoutcomes;
376         $aggsubcatsdiff  = $db_item->aggregatesubcats    != $this->aggregatesubcats;
378         return ($aggregationdiff || $keephighdiff || $droplowdiff || $aggonlygrddiff || $aggoutcomesdiff || $aggsubcatsdiff);
379     }
381     /**
382      * Marks the category and course item as needing update - categories are always regraded.
383      * @return void
384      */
385     public function force_regrading() {
386         $grade_item = $this->load_grade_item();
387         $grade_item->force_regrading();
388     }
390     /**
391      * Generates and saves final grades in associated category grade item.
392      * These immediate children must already have their own final grades.
393      * The category's aggregation method is used to generate final grades.
394      *
395      * Please note that category grade is either calculated or aggregated - not both at the same time.
396      *
397      * This method must be used ONLY from grade_item::regrade_final_grades(),
398      * because the calculation must be done in correct order!
399      *
400      * Steps to follow:
401      *  1. Get final grades from immediate children
402      *  3. Aggregate these grades
403      *  4. Save them in final grades of associated category grade item
404      */
405     public function generate_grades($userid=null) {
406         global $CFG, $DB;
408         $this->load_grade_item();
410         if ($this->grade_item->is_locked()) {
411             return true; // no need to recalculate locked items
412         }
414         // find grade items of immediate children (category or grade items) and force site settings
415         $depends_on = $this->grade_item->depends_on();
417         if (empty($depends_on)) {
418             $items = false;
419         } else {
420             list($usql, $params) = $DB->get_in_or_equal($depends_on);
421             $sql = "SELECT *
422                       FROM {grade_items}
423                      WHERE id $usql";
424             $items = $DB->get_records_sql($sql, $params);
425         }
427         // needed mostly for SUM agg type
428         $this->auto_update_max($items);
430         $grade_inst = new grade_grade();
431         $fields = 'g.'.implode(',g.', $grade_inst->required_fields);
433         // where to look for final grades - include grade of this item too, we will store the results there
434         $gis = array_merge($depends_on, array($this->grade_item->id));
435         list($usql, $params) = $DB->get_in_or_equal($gis);
437         if ($userid) {
438             $usersql = "AND g.userid=?";
439             $params[] = $userid;
440         } else {
441             $usersql = "";
442         }
444         $sql = "SELECT $fields
445                   FROM {grade_grades} g, {grade_items} gi
446                  WHERE gi.id = g.itemid AND gi.id $usql $usersql
447               ORDER BY g.userid";
449         // group the results by userid and aggregate the grades for this user
450         if ($rs = $DB->get_recordset_sql($sql, $params)) {
451             $prevuser = 0;
452             $grade_values = array();
453             $excluded     = array();
454             $oldgrade     = null;
455             foreach ($rs as $used) {
456                 if ($used->userid != $prevuser) {
457                     $this->aggregate_grades($prevuser, $items, $grade_values, $oldgrade, $excluded);
458                     $prevuser = $used->userid;
459                     $grade_values = array();
460                     $excluded     = array();
461                     $oldgrade     = null;
462                 }
463                 $grade_values[$used->itemid] = $used->finalgrade;
464                 if ($used->excluded) {
465                     $excluded[] = $used->itemid;
466                 }
467                 if ($this->grade_item->id == $used->itemid) {
468                     $oldgrade = $used;
469                 }
470             }
471             $rs->close();
472             $this->aggregate_grades($prevuser, $items, $grade_values, $oldgrade, $excluded);//the last one
473         }
475         return true;
476     }
478     /**
479      * internal function for category grades aggregation
480      *
481      * @param int $userid
482      * @param array $items
483      * @param array $grade_values
484      * @param object $oldgrade
485      * @param bool $excluded
486      * @return boolean (just plain return;)
487      */
488     private function aggregate_grades($userid, $items, $grade_values, $oldgrade, $excluded) {
489         global $CFG;
490         if (empty($userid)) {
491             //ignore first call
492             return;
493         }
495         if ($oldgrade) {
496             $oldfinalgrade = $oldgrade->finalgrade;
497             $grade = new grade_grade($oldgrade, false);
498             $grade->grade_item =& $this->grade_item;
500         } else {
501             // insert final grade - it will be needed later anyway
502             $grade = new grade_grade(array('itemid'=>$this->grade_item->id, 'userid'=>$userid), false);
503             $grade->grade_item =& $this->grade_item;
504             $grade->insert('system');
505             $oldfinalgrade = null;
506         }
508         // no need to recalculate locked or overridden grades
509         if ($grade->is_locked() or $grade->is_overridden()) {
510             return;
511         }
513         // can not use own final category grade in calculation
514         unset($grade_values[$this->grade_item->id]);
517     /// sum is a special aggregation types - it adjusts the min max, does not use relative values
518         if ($this->aggregation == GRADE_AGGREGATE_SUM) {
519             $this->sum_grades($grade, $oldfinalgrade, $items, $grade_values, $excluded);
520             return;
521         }
523         // if no grades calculation possible or grading not allowed clear final grade
524         if (empty($grade_values) or empty($items) or ($this->grade_item->gradetype != GRADE_TYPE_VALUE and $this->grade_item->gradetype != GRADE_TYPE_SCALE)) {
525             $grade->finalgrade = null;
526             if (!is_null($oldfinalgrade)) {
527                 $grade->update('aggregation');
528             }
529             return;
530         }
532     /// normalize the grades first - all will have value 0...1
533         // ungraded items are not used in aggregation
534         foreach ($grade_values as $itemid=>$v) {
535             if (is_null($v)) {
536                 // null means no grade
537                 unset($grade_values[$itemid]);
538                 continue;
539             } else if (in_array($itemid, $excluded)) {
540                 unset($grade_values[$itemid]);
541                 continue;
542             }
543             $grade_values[$itemid] = grade_grade::standardise_score($v, $items[$itemid]->grademin, $items[$itemid]->grademax, 0, 1);
544         }
546         // use min grade if grade missing for these types
547         if (!$this->aggregateonlygraded) {
548             foreach($items as $itemid=>$value) {
549                 if (!isset($grade_values[$itemid]) and !in_array($itemid, $excluded)) {
550                     $grade_values[$itemid] = 0;
551                 }
552             }
553         }
555         // limit and sort
556         $this->apply_limit_rules($grade_values);
557         asort($grade_values, SORT_NUMERIC);
559         // let's see we have still enough grades to do any statistics
560         if (count($grade_values) == 0) {
561             // not enough attempts yet
562             $grade->finalgrade = null;
563             if (!is_null($oldfinalgrade)) {
564                 $grade->update('aggregation');
565             }
566             return;
567         }
569         // do the maths
570         $agg_grade = $this->aggregate_values($grade_values, $items);
572         // recalculate the grade back to requested range
573         $finalgrade = grade_grade::standardise_score($agg_grade, 0, 1, $this->grade_item->grademin, $this->grade_item->grademax);
575         if (is_null($finalgrade)) {
576             $grade->finalgrade = null;
577         } else {
578             $grade->finalgrade = (float)bounded_number($this->grade_item->grademin, $finalgrade, $this->grade_item->grademax);
579         }
581         // update in db if changed
582         if (grade_floats_different($grade->finalgrade, $oldfinalgrade)) {
583             $grade->update('aggregation');
584         }
586         return;
587     }
589     /**
590      * Internal function - aggregation maths.
591      * Must be public: used by grade_grade::get_hiding_affected()
592      */
593     public function aggregate_values($grade_values, $items) {
594         switch ($this->aggregation) {
595             case GRADE_AGGREGATE_MEDIAN: // Middle point value in the set: ignores frequencies
596                 $num = count($grade_values);
597                 $grades = array_values($grade_values);
598                 if ($num % 2 == 0) {
599                     $agg_grade = ($grades[intval($num/2)-1] + $grades[intval($num/2)]) / 2;
600                 } else {
601                     $agg_grade = $grades[intval(($num/2)-0.5)];
602                 }
603                 break;
605             case GRADE_AGGREGATE_MIN:
606                 $agg_grade = reset($grade_values);
607                 break;
609             case GRADE_AGGREGATE_MAX:
610                 $agg_grade = array_pop($grade_values);
611                 break;
613             case GRADE_AGGREGATE_MODE:       // the most common value, average used if multimode
614                 // array_count_values only counts INT and STRING, so if grades are floats we must convert them to string
615                 $converted_grade_values = array();
617                 foreach ($grade_values as $k => $gv) {
618                     if (!is_int($gv) && !is_string($gv)) {
619                         $converted_grade_values[$k] = (string) $gv;
620                     } else {
621                         $converted_grade_values[$k] = $gv;
622                     }
623                 }
625                 $freq = array_count_values($converted_grade_values);
626                 arsort($freq);                      // sort by frequency keeping keys
627                 $top = reset($freq);               // highest frequency count
628                 $modes = array_keys($freq, $top);  // search for all modes (have the same highest count)
629                 rsort($modes, SORT_NUMERIC);       // get highes mode
630                 $agg_grade = reset($modes);
631                 break;
633             case GRADE_AGGREGATE_WEIGHTED_MEAN: // Weighted average of all existing final grades, weight specified in coef
634                 $weightsum = 0;
635                 $sum       = 0;
636                 foreach($grade_values as $itemid=>$grade_value) {
637                     if ($items[$itemid]->aggregationcoef <= 0) {
638                         continue;
639                     }
640                     $weightsum += $items[$itemid]->aggregationcoef;
641                     $sum       += $items[$itemid]->aggregationcoef * $grade_value;
642                 }
643                 if ($weightsum == 0) {
644                     $agg_grade = null;
645                 } else {
646                     $agg_grade = $sum / $weightsum;
647                 }
648                 break;
650             case GRADE_AGGREGATE_WEIGHTED_MEAN2: // Weighted average of all existing final grades, weight is the range of grade (ususally grademax)
651                 $weightsum = 0;
652                 $sum       = 0;
653                 foreach($grade_values as $itemid=>$grade_value) {
654                     $weight = $items[$itemid]->grademax - $items[$itemid]->grademin;
655                     if ($weight <= 0) {
656                         continue;
657                     }
658                     $weightsum += $weight;
659                     $sum       += $weight * $grade_value;
660                 }
661                 if ($weightsum == 0) {
662                     $agg_grade = null;
663                 } else {
664                     $agg_grade = $sum / $weightsum;
665                 }
666                 break;
668             case GRADE_AGGREGATE_EXTRACREDIT_MEAN: // special average
669                 $num = 0;
670                 $sum = 0;
671                 foreach($grade_values as $itemid=>$grade_value) {
672                     if ($items[$itemid]->aggregationcoef == 0) {
673                         $num += 1;
674                         $sum += $grade_value;
675                     } else if ($items[$itemid]->aggregationcoef > 0) {
676                         $sum += $items[$itemid]->aggregationcoef * $grade_value;
677                     }
678                 }
679                 if ($num == 0) {
680                     $agg_grade = $sum; // only extra credits or wrong coefs
681                 } else {
682                     $agg_grade = $sum / $num;
683                 }
684                 break;
686             case GRADE_AGGREGATE_MEAN:    // Arithmetic average of all grade items (if ungraded aggregated, NULL counted as minimum)
687             default:
688                 $num = count($grade_values);
689                 $sum = array_sum($grade_values);
690                 $agg_grade = $sum / $num;
691                 break;
692         }
694         return $agg_grade;
695     }
697     /**
698      * Some aggregation tpyes may update max grade
699      * @param array $items sub items
700      * @return void
701      */
702     private function auto_update_max($items) {
703         if ($this->aggregation != GRADE_AGGREGATE_SUM) {
704             // not needed at all
705             return;
706         }
708         if (!$items) {
709             if ($this->grade_item->grademax != 0 or $this->grade_item->gradetype != GRADE_TYPE_VALUE) {
710                 $this->grade_item->grademax  = 0;
711                 $this->grade_item->grademin  = 0;
712                 $this->grade_item->gradetype = GRADE_TYPE_VALUE;
713                 $this->grade_item->update('aggregation');
714             }
715             return;
716         }
718         $max = 0;
720         //find max grade
721         foreach ($items as $item) {
722             if ($item->aggregationcoef > 0) {
723                 // extra credit from this activity - does not affect total
724                 continue;
725             }
726             if ($item->gradetype == GRADE_TYPE_VALUE) {
727                 $max += $item->grademax;
728             } else if ($item->gradetype == GRADE_TYPE_SCALE) {
729                 $max += $item->grademax - 1; // scales min is 1
730             }
731         }
733         if ($this->grade_item->grademax != $max or $this->grade_item->grademin != 0 or $this->grade_item->gradetype != GRADE_TYPE_VALUE){
734             $this->grade_item->grademax  = $max;
735             $this->grade_item->grademin  = 0;
736             $this->grade_item->gradetype = GRADE_TYPE_VALUE;
737             $this->grade_item->update('aggregation');
738         }
739     }
741     /**
742      * internal function for category grades summing
743      *
744      * @param object $grade
745      * @param int $userid
746      * @param float $oldfinalgrade
747      * @param array $items
748      * @param array $grade_values
749      * @param bool $excluded
750      * @return boolean (just plain return;)
751      */
752     private function sum_grades(&$grade, $oldfinalgrade, $items, $grade_values, $excluded) {
753         // ungraded and exluded items are not used in aggregation
754         foreach ($grade_values as $itemid=>$v) {
755             if (is_null($v)) {
756                 unset($grade_values[$itemid]);
757             } else if (in_array($itemid, $excluded)) {
758                 unset($grade_values[$itemid]);
759             }
760         }
762         // use 0 if grade missing, droplow used and aggregating all items
763         if (!$this->aggregateonlygraded and !empty($this->droplow)) {
764             foreach($items as $itemid=>$value) {
765                 if (!isset($grade_values[$itemid]) and !in_array($itemid, $excluded)) {
766                     $grade_values[$itemid] = 0;
767                 }
768             }
769         }
771         $this->apply_limit_rules($grade_values);
773         $sum = array_sum($grade_values);
774         $grade->finalgrade = bounded_number($this->grade_item->grademin, $sum, $this->grade_item->grademax);
776         // update in db if changed
777         if (grade_floats_different($grade->finalgrade, $oldfinalgrade)) {
778             $grade->update('aggregation');
779         }
781         return;
782     }
784     /**
785      * Given an array of grade values (numerical indices), applies droplow or keephigh
786      * rules to limit the final array.
787      * @param array $grade_values
788      * @return array Limited grades.
789      */
790     public function apply_limit_rules(&$grade_values) {
791         arsort($grade_values, SORT_NUMERIC);
792         if (!empty($this->droplow)) {
793             for ($i = 0; $i < $this->droplow; $i++) {
794                 array_pop($grade_values);
795             }
796         } elseif (!empty($this->keephigh)) {
797             while (count($grade_values) > $this->keephigh) {
798                 array_pop($grade_values);
799             }
800         }
801     }
804     /**
805      * Returns true if category uses special aggregation coeficient
806      * @return boolean true if coeficient used
807      */
808     public function is_aggregationcoef_used() {
809         return ($this->aggregation == GRADE_AGGREGATE_WEIGHTED_MEAN
810              or $this->aggregation == GRADE_AGGREGATE_EXTRACREDIT_MEAN
811              or $this->aggregation == GRADE_AGGREGATE_SUM);
813     }
815     /**
816      * Returns tree with all grade_items and categories as elements
817      * @static
818      * @param int $courseid
819      * @param boolean $include_category_items as category children
820      * @return array
821      */
822     public static function fetch_course_tree($courseid, $include_category_items=false) {
823         $course_category = grade_category::fetch_course_category($courseid);
824         $category_array = array('object'=>$course_category, 'type'=>'category', 'depth'=>1,
825                                 'children'=>$course_category->get_children($include_category_items));
826         $sortorder = 1;
827         $course_category->set_sortorder($sortorder);
828         $course_category->sortorder = $sortorder;
829         return grade_category::_fetch_course_tree_recursion($category_array, $sortorder);
830     }
832     private function _fetch_course_tree_recursion($category_array, &$sortorder) {
833         // update the sortorder in db if needed
834         if ($category_array['object']->sortorder != $sortorder) {
835             $category_array['object']->set_sortorder($sortorder);
836         }
838         // store the grade_item or grade_category instance with extra info
839         $result = array('object'=>$category_array['object'], 'type'=>$category_array['type'], 'depth'=>$category_array['depth']);
841         // reuse final grades if there
842         if (array_key_exists('finalgrades', $category_array)) {
843             $result['finalgrades'] = $category_array['finalgrades'];
844         }
846         // recursively resort children
847         if (!empty($category_array['children'])) {
848             $result['children'] = array();
849             //process the category item first
850             $cat_item_id = null;
851             foreach($category_array['children'] as $oldorder=>$child_array) {
852                 if ($child_array['type'] == 'courseitem' or $child_array['type'] == 'categoryitem') {
853                     $result['children'][$sortorder] = grade_category::_fetch_course_tree_recursion($child_array, $sortorder);
854                 }
855             }
856             foreach($category_array['children'] as $oldorder=>$child_array) {
857                 if ($child_array['type'] != 'courseitem' and $child_array['type'] != 'categoryitem') {
858                     $result['children'][++$sortorder] = grade_category::_fetch_course_tree_recursion($child_array, $sortorder);
859                 }
860             }
861         }
863         return $result;
864     }
866     /**
867      * Fetches and returns all the children categories and/or grade_items belonging to this category.
868      * By default only returns the immediate children (depth=1), but deeper levels can be requested,
869      * as well as all levels (0). The elements are indexed by sort order.
870      * @return array Array of child objects (grade_category and grade_item).
871      */
872     public function get_children($include_category_items=false) {
873         global $DB;
875         // This function must be as fast as possible ;-)
876         // fetch all course grade items and categories into memory - we do not expect hundreds of these in course
877         // we have to limit the number of queries though, because it will be used often in grade reports
879         $cats  = $DB->get_records('grade_categories', array('courseid' => $this->courseid));
880         $items = $DB->get_records('grade_items', array('courseid' => $this->courseid));
882         // init children array first
883         foreach ($cats as $catid=>$cat) {
884             $cats[$catid]->children = array();
885         }
887         //first attach items to cats and add category sortorder
888         foreach ($items as $item) {
889             if ($item->itemtype == 'course' or $item->itemtype == 'category') {
890                 $cats[$item->iteminstance]->sortorder = $item->sortorder;
892                 if (!$include_category_items) {
893                     continue;
894                 }
895                 $categoryid = $item->iteminstance;
896             } else {
897                 $categoryid = $item->categoryid;
898             }
900             // prevent problems with duplicate sortorders in db
901             $sortorder = $item->sortorder;
902             while(array_key_exists($sortorder, $cats[$categoryid]->children)) {
903                 //debugging("$sortorder exists in item loop");
904                 $sortorder++;
905             }
907             $cats[$categoryid]->children[$sortorder] = $item;
909         }
911         // now find the requested category and connect categories as children
912         $category = false;
913         foreach ($cats as $catid=>$cat) {
914             if (empty($cat->parent)) {
915                 if ($cat->path !== '/'.$cat->id.'/') {
916                     $grade_category = new grade_category($cat, false);
917                     $grade_category->path  = '/'.$cat->id.'/';
918                     $grade_category->depth = 1;
919                     $grade_category->update('system');
920                     return $this->get_children($include_category_items);
921                 }
922             } else {
923                 if (empty($cat->path) or !preg_match('|/'.$cat->parent.'/'.$cat->id.'/$|', $cat->path)) {
924                     //fix paths and depts
925                     static $recursioncounter = 0; // prevents infinite recursion
926                     $recursioncounter++;
927                     if ($recursioncounter < 5) {
928                         // fix paths and depths!
929                         $grade_category = new grade_category($cat, false);
930                         $grade_category->depth = 0;
931                         $grade_category->path  = null;
932                         $grade_category->update('system');
933                         return $this->get_children($include_category_items);
934                     }
935                 }
936                 // prevent problems with duplicate sortorders in db
937                 $sortorder = $cat->sortorder;
938                 while(array_key_exists($sortorder, $cats[$cat->parent]->children)) {
939                     //debugging("$sortorder exists in cat loop");
940                     $sortorder++;
941                 }
943                 $cats[$cat->parent]->children[$sortorder] = &$cats[$catid];
944             }
946             if ($catid == $this->id) {
947                 $category = &$cats[$catid];
948             }
949         }
951         unset($items); // not needed
952         unset($cats); // not needed
954         $children_array = grade_category::_get_children_recursion($category);
956         ksort($children_array);
958         return $children_array;
960     }
962     private function _get_children_recursion($category) {
964         $children_array = array();
965         foreach($category->children as $sortorder=>$child) {
966             if (array_key_exists('itemtype', $child)) {
967                 $grade_item = new grade_item($child, false);
968                 if (in_array($grade_item->itemtype, array('course', 'category'))) {
969                     $type  = $grade_item->itemtype.'item';
970                     $depth = $category->depth;
971                 } else {
972                     $type  = 'item';
973                     $depth = $category->depth; // we use this to set the same colour
974                 }
975                 $children_array[$sortorder] = array('object'=>$grade_item, 'type'=>$type, 'depth'=>$depth);
977             } else {
978                 $children = grade_category::_get_children_recursion($child);
979                 $grade_category = new grade_category($child, false);
980                 if (empty($children)) {
981                     $children = array();
982                 }
983                 $children_array[$sortorder] = array('object'=>$grade_category, 'type'=>'category', 'depth'=>$grade_category->depth, 'children'=>$children);
984             }
985         }
987         // sort the array
988         ksort($children_array);
990         return $children_array;
991     }
993     /**
994      * Uses get_grade_item to load or create a grade_item, then saves it as $this->grade_item.
995      * @return object Grade_item
996      */
997     public function load_grade_item() {
998         if (empty($this->grade_item)) {
999             $this->grade_item = $this->get_grade_item();
1000         }
1001         return $this->grade_item;
1002     }
1004     /**
1005      * Retrieves from DB and instantiates the associated grade_item object.
1006      * If no grade_item exists yet, create one.
1007      * @return object Grade_item
1008      */
1009     public function get_grade_item() {
1010         if (empty($this->id)) {
1011             debugging("Attempt to obtain a grade_category's associated grade_item without the category's ID being set.");
1012             return false;
1013         }
1015         if (empty($this->parent)) {
1016             $params = array('courseid'=>$this->courseid, 'itemtype'=>'course', 'iteminstance'=>$this->id);
1018         } else {
1019             $params = array('courseid'=>$this->courseid, 'itemtype'=>'category', 'iteminstance'=>$this->id);
1020         }
1022         if (!$grade_items = grade_item::fetch_all($params)) {
1023             // create a new one
1024             $grade_item = new grade_item($params, false);
1025             $grade_item->gradetype = GRADE_TYPE_VALUE;
1026             $grade_item->insert('system');
1028         } else if (count($grade_items) == 1){
1029             // found existing one
1030             $grade_item = reset($grade_items);
1032         } else {
1033             debugging("Found more than one grade_item attached to category id:".$this->id);
1034             // return first one
1035             $grade_item = reset($grade_items);
1036         }
1038         return $grade_item;
1039     }
1041     /**
1042      * Uses $this->parent to instantiate $this->parent_category based on the
1043      * referenced record in the DB.
1044      * @return object Parent_category
1045      */
1046     public function load_parent_category() {
1047         if (empty($this->parent_category) && !empty($this->parent)) {
1048             $this->parent_category = $this->get_parent_category();
1049         }
1050         return $this->parent_category;
1051     }
1053     /**
1054      * Uses $this->parent to instantiate and return a grade_category object.
1055      * @return object Parent_category
1056      */
1057     public function get_parent_category() {
1058         if (!empty($this->parent)) {
1059             $parent_category = new grade_category(array('id' => $this->parent));
1060             return $parent_category;
1061         } else {
1062             return null;
1063         }
1064     }
1066     /**
1067      * Returns the most descriptive field for this object. This is a standard method used
1068      * when we do not know the exact type of an object.
1069      * @return string name
1070      */
1071     public function get_name() {
1072         global $DB;
1073         // For a course category, we return the course name if the fullname is set to '?' in the DB (empty in the category edit form)
1074         if (empty($this->parent) && $this->fullname == '?') {
1075             $course = $DB->get_record('course', array('id'=> $this->courseid));
1076             return format_string($course->fullname);
1077         } else {
1078             return $this->fullname;
1079         }
1080     }
1082     /**
1083      * Sets this category's parent id. A generic method shared by objects that have a parent id of some kind.
1084      * @param int parentid
1085      * @return boolean success
1086      */
1087     public function set_parent($parentid, $source=null) {
1088         if ($this->parent == $parentid) {
1089             return true;
1090         }
1092         if ($parentid == $this->id) {
1093             print_error('cannotassignselfasparent');
1094         }
1096         if (empty($this->parent) and $this->is_course_category()) {
1097             print_error('cannothaveparentcate');
1098         }
1100         // find parent and check course id
1101         if (!$parent_category = grade_category::fetch(array('id'=>$parentid, 'courseid'=>$this->courseid))) {
1102             return false;
1103         }
1105         $this->force_regrading();
1107         // set new parent category
1108         $this->parent          = $parent_category->id;
1109         $this->parent_category =& $parent_category;
1110         $this->path            = null;       // remove old path and depth - will be recalculated in update()
1111         $this->depth           = 0;          // remove old path and depth - will be recalculated in update()
1112         $this->update($source);
1114         return $this->update($source);
1115     }
1117     /**
1118      * Returns the final values for this grade category.
1119      * @param int $userid Optional: to retrieve a single final grade
1120      * @return mixed An array of all final_grades (stdClass objects) for this grade_item, or a single final_grade.
1121      */
1122     public function get_final($userid=NULL) {
1123         $this->load_grade_item();
1124         return $this->grade_item->get_final($userid);
1125     }
1127     /**
1128      * Returns the sortorder of the associated grade_item. This method is also available in
1129      * grade_item, for cases where the object type is not known.
1130      * @return int Sort order
1131      */
1132     public function get_sortorder() {
1133         $this->load_grade_item();
1134         return $this->grade_item->get_sortorder();
1135     }
1137     /**
1138      * Returns the idnumber of the associated grade_item. This method is also available in
1139      * grade_item, for cases where the object type is not known.
1140      * @return string idnumber
1141      */
1142     public function get_idnumber() {
1143         $this->load_grade_item();
1144         return $this->grade_item->get_idnumber();
1145     }
1147     /**
1148      * Sets sortorder variable for this category.
1149      * This method is also available in grade_item, for cases where the object type is not know.
1150      * @param int $sortorder
1151      * @return void
1152      */
1153     public function set_sortorder($sortorder) {
1154         $this->load_grade_item();
1155         $this->grade_item->set_sortorder($sortorder);
1156     }
1158     /**
1159      * Move this category after the given sortorder - does not change the parent
1160      * @param int $sortorder to place after
1161      */
1162     public function move_after_sortorder($sortorder) {
1163         $this->load_grade_item();
1164         $this->grade_item->move_after_sortorder($sortorder);
1165     }
1167     /**
1168      * Return true if this is the top most category that represents the total course grade.
1169      * @return boolean
1170      */
1171     public function is_course_category() {
1172         $this->load_grade_item();
1173         return $this->grade_item->is_course_item();
1174     }
1176     /**
1177      * Return the top most course category.
1178      * @static
1179      * @return object grade_category instance for course grade
1180      */
1181     public function fetch_course_category($courseid) {
1182         if (empty($courseid)) {
1183             debugging('Missing course id!');
1184             return false;
1185         }
1187         // course category has no parent
1188         if ($course_category = grade_category::fetch(array('courseid'=>$courseid, 'parent'=>null))) {
1189             return $course_category;
1190         }
1192         // create a new one
1193         $course_category = new grade_category();
1194         $course_category->insert_course_category($courseid);
1196         return $course_category;
1197     }
1199     /**
1200      * Is grading object editable?
1201      * @return boolean
1202      */
1203     public function is_editable() {
1204         return true;
1205     }
1207     /**
1208      * Returns the locked state/date of the associated grade_item. This method is also available in
1209      * grade_item, for cases where the object type is not known.
1210      * @return boolean
1211      */
1212     public function is_locked() {
1213         $this->load_grade_item();
1214         return $this->grade_item->is_locked();
1215     }
1217     /**
1218      * Sets the grade_item's locked variable and updates the grade_item.
1219      * Method named after grade_item::set_locked().
1220      * @param int $locked 0, 1 or a timestamp int(10) after which date the item will be locked.
1221      * @param boolean $cascade lock/unlock child objects too
1222      * @param boolean $refresh refresh grades when unlocking
1223      * @return boolean success if category locked (not all children mayb be locked though)
1224      */
1225     public function set_locked($lockedstate, $cascade=false, $refresh=true) {
1226         $this->load_grade_item();
1228         $result = $this->grade_item->set_locked($lockedstate, $cascade, true);
1230         if ($cascade) {
1231             //process all children - items and categories
1232             if ($children = grade_item::fetch_all(array('categoryid'=>$this->id))) {
1233                 foreach($children as $child) {
1234                     $child->set_locked($lockedstate, true, false);
1235                     if (empty($lockedstate) and $refresh) {
1236                         //refresh when unlocking
1237                         $child->refresh_grades();
1238                     }
1239                 }
1240             }
1241             if ($children = grade_category::fetch_all(array('parent'=>$this->id))) {
1242                 foreach($children as $child) {
1243                     $child->set_locked($lockedstate, true, true);
1244                 }
1245             }
1246         }
1248         return $result;
1249     }
1251     /**
1252      * Returns the hidden state/date of the associated grade_item. This method is also available in
1253      * grade_item.
1254      * @return boolean
1255      */
1256     public function is_hidden() {
1257         $this->load_grade_item();
1258         return $this->grade_item->is_hidden();
1259     }
1261     /**
1262      * Check grade hidden status. Uses data from both grade item and grade.
1263      * @return boolean true if hiddenuntil, false if not
1264      */
1265     public function is_hiddenuntil() {
1266         $this->load_grade_item();
1267         return $this->grade_item->is_hiddenuntil();
1268     }
1270     /**
1271      * Sets the grade_item's hidden variable and updates the grade_item.
1272      * Method named after grade_item::set_hidden().
1273      * @param int $hidden 0, 1 or a timestamp int(10) after which date the item will be hidden.
1274      * @param boolean $cascade apply to child objects too
1275      * @return void
1276      */
1277     public function set_hidden($hidden, $cascade=false) {
1278         $this->load_grade_item();
1279         $this->grade_item->set_hidden($hidden);
1280         if ($cascade) {
1281             if ($children = grade_item::fetch_all(array('categoryid'=>$this->id))) {
1282                 foreach($children as $child) {
1283                     $child->set_hidden($hidden, $cascade);
1284                 }
1285             }
1286             if ($children = grade_category::fetch_all(array('parent'=>$this->id))) {
1287                 foreach($children as $child) {
1288                     $child->set_hidden($hidden, $cascade);
1289                 }
1290             }
1291         }
1292     }
1294     /**
1295      * Applies default settings on this category
1296      * @return bool true if anything changed
1297      */
1298     public function apply_default_settings() {
1299         global $CFG;
1301         foreach ($this->forceable as $property) {
1302             if (isset($CFG->{"grade_$property"})) {
1303                 if ($CFG->{"grade_$property"} == -1) {
1304                     continue; //temporary bc before version bump
1305                 }
1306                 $this->$property = $CFG->{"grade_$property"};
1307             }
1308         }
1309     }
1311     /**
1312      * Applies forced settings on this category
1313      * @return bool true if anything changed
1314      */
1315     public function apply_forced_settings() {
1316         global $CFG;
1318         $updated = false;
1319         foreach ($this->forceable as $property) {
1320             if (isset($CFG->{"grade_$property"}) and isset($CFG->{"grade_{$property}_flag"}) and ((int)$CFG->{"grade_{$property}_flag"} & 1)) {
1321                 if ($CFG->{"grade_$property"} == -1) {
1322                     continue; //temporary bc before version bump
1323                 }
1324                 $this->$property = $CFG->{"grade_$property"};
1325                 $updated = true;
1326             }
1327         }
1329         return $updated;
1330     }
1332     /**
1333      * Notification of change in forced category settings.
1334      * @static
1335      */
1336     public static function updated_forced_settings() {
1337         global $CFG, $DB;
1338         $params = array(1, 'course', 'category');
1339         $sql = "UPDATE {grade_items} SET needsupdate=? WHERE itemtype=? or itemtype=?";
1340         $DB->execute($sql, $params);
1341     }
1343 ?>