98720a8bdc631e2f0ba4708f0cd6f35aa3f79608
[moodle.git] / lib / grade / grade_category.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  * Definition of a class to represent a grade category
19  *
20  * @package   core_grades
21  * @copyright 2006 Nicolas Connault
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 defined('MOODLE_INTERNAL') || die();
27 require_once('grade_object.php');
29 /**
30  * grade_category is an object mapped to DB table {prefix}grade_categories
31  *
32  * @package   core_grades
33  * @category  grade
34  * @copyright 2007 Nicolas Connault
35  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
36  */
37 class grade_category extends grade_object {
38     /**
39      * The DB table.
40      * @var string $table
41      */
42     public $table = 'grade_categories';
44     /**
45      * Array of required table fields, must start with 'id'.
46      * @var array $required_fields
47      */
48     public $required_fields = array('id', 'courseid', 'parent', 'depth', 'path', 'fullname', 'aggregation',
49                                  'keephigh', 'droplow', 'aggregateonlygraded', 'aggregateoutcomes',
50                                  'aggregatesubcats', 'timecreated', 'timemodified', 'hidden');
52     /**
53      * The course this category belongs to.
54      * @var int $courseid
55      */
56     public $courseid;
58     /**
59      * The category this category belongs to (optional).
60      * @var int $parent
61      */
62     public $parent;
64     /**
65      * The grade_category object referenced by $this->parent (PK).
66      * @var grade_category $parent_category
67      */
68     public $parent_category;
70     /**
71      * The number of parents this category has.
72      * @var int $depth
73      */
74     public $depth = 0;
76     /**
77      * Shows the hierarchical path for this category as /1/2/3/ (like course_categories), the last number being
78      * this category's autoincrement ID number.
79      * @var string $path
80      */
81     public $path;
83     /**
84      * The name of this category.
85      * @var string $fullname
86      */
87     public $fullname;
89     /**
90      * A constant pointing to one of the predefined aggregation strategies (none, mean, median, sum etc) .
91      * @var int $aggregation
92      */
93     public $aggregation = GRADE_AGGREGATE_MEAN;
95     /**
96      * Keep only the X highest items.
97      * @var int $keephigh
98      */
99     public $keephigh = 0;
101     /**
102      * Drop the X lowest items.
103      * @var int $droplow
104      */
105     public $droplow = 0;
107     /**
108      * Aggregate only graded items
109      * @var int $aggregateonlygraded
110      */
111     public $aggregateonlygraded = 0;
113     /**
114      * Aggregate outcomes together with normal items
115      * @var int $aggregateoutcomes
116      */
117     public $aggregateoutcomes = 0;
119     /**
120      * Ignore subcategories when aggregating
121      * @var int $aggregatesubcats
122      */
123     public $aggregatesubcats = 0;
125     /**
126      * Array of grade_items or grade_categories nested exactly 1 level below this category
127      * @var array $children
128      */
129     public $children;
131     /**
132      * A hierarchical array of all children below this category. This is stored separately from
133      * $children because it is more memory-intensive and may not be used as often.
134      * @var array $all_children
135      */
136     public $all_children;
138     /**
139      * An associated grade_item object, with itemtype=category, used to calculate and cache a set of grade values
140      * for this category.
141      * @var grade_item $grade_item
142      */
143     public $grade_item;
145     /**
146      * Temporary sortorder for speedup of children resorting
147      * @var int $sortorder
148      */
149     public $sortorder;
151     /**
152      * List of options which can be "forced" from site settings.
153      * @var array $forceable
154      */
155     public $forceable = array('aggregation', 'keephigh', 'droplow', 'aggregateonlygraded', 'aggregateoutcomes', 'aggregatesubcats');
157     /**
158      * String representing the aggregation coefficient. Variable is used as cache.
159      * @var string $coefstring
160      */
161     public $coefstring = null;
163     /**
164      * Builds this category's path string based on its parents (if any) and its own id number.
165      * This is typically done just before inserting this object in the DB for the first time,
166      * or when a new parent is added or changed. It is a recursive function: once the calling
167      * object no longer has a parent, the path is complete.
168      *
169      * @param grade_category $grade_category A Grade_Category object
170      * @return string The category's path string
171      */
172     public static function build_path($grade_category) {
173         global $DB;
175         if (empty($grade_category->parent)) {
176             return '/'.$grade_category->id.'/';
178         } else {
179             $parent = $DB->get_record('grade_categories', array('id' => $grade_category->parent));
180             return grade_category::build_path($parent).$grade_category->id.'/';
181         }
182     }
184     /**
185      * Finds and returns a grade_category instance based on params.
186      *
187      * @param array $params associative arrays varname=>value
188      * @return grade_category The retrieved grade_category instance or false if none found.
189      */
190     public static function fetch($params) {
191         return grade_object::fetch_helper('grade_categories', 'grade_category', $params);
192     }
194     /**
195      * Finds and returns all grade_category instances based on params.
196      *
197      * @param array $params associative arrays varname=>value
198      * @return array array of grade_category insatnces or false if none found.
199      */
200     public static function fetch_all($params) {
201         return grade_object::fetch_all_helper('grade_categories', 'grade_category', $params);
202     }
204     /**
205      * In addition to update() as defined in grade_object, call force_regrading of parent categories, if applicable.
206      *
207      * @param string $source from where was the object updated (mod/forum, manual, etc.)
208      * @return bool success
209      */
210     public function update($source=null) {
211         // load the grade item or create a new one
212         $this->load_grade_item();
214         // force recalculation of path;
215         if (empty($this->path)) {
216             $this->path  = grade_category::build_path($this);
217             $this->depth = substr_count($this->path, '/') - 1;
218             $updatechildren = true;
220         } else {
221             $updatechildren = false;
222         }
224         $this->apply_forced_settings();
226         // these are exclusive
227         if ($this->droplow > 0) {
228             $this->keephigh = 0;
230         } else if ($this->keephigh > 0) {
231             $this->droplow = 0;
232         }
234         // Recalculate grades if needed
235         if ($this->qualifies_for_regrading()) {
236             $this->force_regrading();
237         }
239         $this->timemodified = time();
241         $result = parent::update($source);
243         // now update paths in all child categories
244         if ($result and $updatechildren) {
246             if ($children = grade_category::fetch_all(array('parent'=>$this->id))) {
248                 foreach ($children as $child) {
249                     $child->path  = null;
250                     $child->depth = 0;
251                     $child->update($source);
252                 }
253             }
254         }
256         return $result;
257     }
259     /**
260      * If parent::delete() is successful, send force_regrading message to parent category.
261      *
262      * @param string $source from where was the object deleted (mod/forum, manual, etc.)
263      * @return bool success
264      */
265     public function delete($source=null) {
266         $grade_item = $this->load_grade_item();
268         if ($this->is_course_category()) {
270             if ($categories = grade_category::fetch_all(array('courseid'=>$this->courseid))) {
272                 foreach ($categories as $category) {
274                     if ($category->id == $this->id) {
275                         continue; // do not delete course category yet
276                     }
277                     $category->delete($source);
278                 }
279             }
281             if ($items = grade_item::fetch_all(array('courseid'=>$this->courseid))) {
283                 foreach ($items as $item) {
285                     if ($item->id == $grade_item->id) {
286                         continue; // do not delete course item yet
287                     }
288                     $item->delete($source);
289                 }
290             }
292         } else {
293             $this->force_regrading();
295             $parent = $this->load_parent_category();
297             // Update children's categoryid/parent field first
298             if ($children = grade_item::fetch_all(array('categoryid'=>$this->id))) {
299                 foreach ($children as $child) {
300                     $child->set_parent($parent->id);
301                 }
302             }
304             if ($children = grade_category::fetch_all(array('parent'=>$this->id))) {
305                 foreach ($children as $child) {
306                     $child->set_parent($parent->id);
307                 }
308             }
309         }
311         // first delete the attached grade item and grades
312         $grade_item->delete($source);
314         // delete category itself
315         return parent::delete($source);
316     }
318     /**
319      * In addition to the normal insert() defined in grade_object, this method sets the depth
320      * and path for this object, and update the record accordingly.
321      *
322      * We do this here instead of in the constructor as they both need to know the record's
323      * ID number, which only gets created at insertion time.
324      * This method also creates an associated grade_item if this wasn't done during construction.
325      *
326      * @param string $source from where was the object inserted (mod/forum, manual, etc.)
327      * @return int PK ID if successful, false otherwise
328      */
329     public function insert($source=null) {
331         if (empty($this->courseid)) {
332             print_error('cannotinsertgrade');
333         }
335         if (empty($this->parent)) {
336             $course_category = grade_category::fetch_course_category($this->courseid);
337             $this->parent = $course_category->id;
338         }
340         $this->path = null;
342         $this->timecreated = $this->timemodified = time();
344         if (!parent::insert($source)) {
345             debugging("Could not insert this category: " . print_r($this, true));
346             return false;
347         }
349         $this->force_regrading();
351         // build path and depth
352         $this->update($source);
354         return $this->id;
355     }
357     /**
358      * Internal function - used only from fetch_course_category()
359      * Normal insert() can not be used for course category
360      *
361      * @param int $courseid The course ID
362      * @return int The ID of the new course category
363      */
364     public function insert_course_category($courseid) {
365         $this->courseid    = $courseid;
366         $this->fullname    = '?';
367         $this->path        = null;
368         $this->parent      = null;
369         $this->aggregation = GRADE_AGGREGATE_WEIGHTED_MEAN2;
371         $this->apply_default_settings();
372         $this->apply_forced_settings();
374         $this->timecreated = $this->timemodified = time();
376         if (!parent::insert('system')) {
377             debugging("Could not insert this category: " . print_r($this, true));
378             return false;
379         }
381         // build path and depth
382         $this->update('system');
384         return $this->id;
385     }
387     /**
388      * Compares the values held by this object with those of the matching record in DB, and returns
389      * whether or not these differences are sufficient to justify an update of all parent objects.
390      * This assumes that this object has an ID number and a matching record in DB. If not, it will return false.
391      *
392      * @return bool
393      */
394     public function qualifies_for_regrading() {
395         if (empty($this->id)) {
396             debugging("Can not regrade non existing category");
397             return false;
398         }
400         $db_item = grade_category::fetch(array('id'=>$this->id));
402         $aggregationdiff = $db_item->aggregation         != $this->aggregation;
403         $keephighdiff    = $db_item->keephigh            != $this->keephigh;
404         $droplowdiff     = $db_item->droplow             != $this->droplow;
405         $aggonlygrddiff  = $db_item->aggregateonlygraded != $this->aggregateonlygraded;
406         $aggoutcomesdiff = $db_item->aggregateoutcomes   != $this->aggregateoutcomes;
407         $aggsubcatsdiff  = $db_item->aggregatesubcats    != $this->aggregatesubcats;
409         return ($aggregationdiff || $keephighdiff || $droplowdiff || $aggonlygrddiff || $aggoutcomesdiff || $aggsubcatsdiff);
410     }
412     /**
413      * Marks this grade categories' associated grade item as needing regrading
414      */
415     public function force_regrading() {
416         $grade_item = $this->load_grade_item();
417         $grade_item->force_regrading();
418     }
420     /**
421      * Something that should be called before we start regrading the whole course.
422      *
423      * @return void
424      */
425     public function pre_regrade_final_grades() {
426         $this->auto_update_max();
427         $this->auto_update_weights();
428     }
430     /**
431      * Generates and saves final grades in associated category grade item.
432      * These immediate children must already have their own final grades.
433      * The category's aggregation method is used to generate final grades.
434      *
435      * Please note that category grade is either calculated or aggregated, not both at the same time.
436      *
437      * This method must be used ONLY from grade_item::regrade_final_grades(),
438      * because the calculation must be done in correct order!
439      *
440      * Steps to follow:
441      *  1. Get final grades from immediate children
442      *  3. Aggregate these grades
443      *  4. Save them in final grades of associated category grade item
444      *
445      * @param int $userid The user ID if final grade generation should be limited to a single user
446      * @return bool
447      */
448     public function generate_grades($userid=null) {
449         global $CFG, $DB;
451         $this->load_grade_item();
453         if ($this->grade_item->is_locked()) {
454             return true; // no need to recalculate locked items
455         }
457         // find grade items of immediate children (category or grade items) and force site settings
458         $depends_on = $this->grade_item->depends_on();
460         if (empty($depends_on)) {
461             $items = false;
463         } else {
464             list($usql, $params) = $DB->get_in_or_equal($depends_on);
465             $sql = "SELECT *
466                       FROM {grade_items}
467                      WHERE id $usql";
468             $items = $DB->get_records_sql($sql, $params);
469         }
471         $grade_inst = new grade_grade();
472         $fields = 'g.'.implode(',g.', $grade_inst->required_fields);
474         // where to look for final grades - include grade of this item too, we will store the results there
475         $gis = array_merge($depends_on, array($this->grade_item->id));
476         list($usql, $params) = $DB->get_in_or_equal($gis);
478         if ($userid) {
479             $usersql = "AND g.userid=?";
480             $params[] = $userid;
482         } else {
483             $usersql = "";
484         }
486         $sql = "SELECT $fields
487                   FROM {grade_grades} g, {grade_items} gi
488                  WHERE gi.id = g.itemid AND gi.id $usql $usersql
489               ORDER BY g.userid";
491         // group the results by userid and aggregate the grades for this user
492         $rs = $DB->get_recordset_sql($sql, $params);
493         if ($rs->valid()) {
494             $prevuser = 0;
495             $grade_values = array();
496             $excluded     = array();
497             $oldgrade     = null;
498             $grademaxoverrides = array();
499             $grademinoverrides = array();
501             foreach ($rs as $used) {
503                 if ($used->userid != $prevuser) {
504                     $this->aggregate_grades($prevuser,
505                                             $items,
506                                             $grade_values,
507                                             $oldgrade,
508                                             $excluded,
509                                             $grademinoverrides,
510                                             $grademaxoverrides);
511                     $prevuser = $used->userid;
512                     $grade_values = array();
513                     $excluded     = array();
514                     $oldgrade     = null;
515                     $grademaxoverrides = array();
516                     $grademinoverrides = array();
517                 }
518                 $grade_values[$used->itemid] = $used->finalgrade;
519                 $grademaxoverrides[$used->itemid] = $used->rawgrademax;
520                 $grademinoverrides[$used->itemid] = $used->rawgrademin;
522                 if ($used->excluded) {
523                     $excluded[] = $used->itemid;
524                 }
526                 if ($this->grade_item->id == $used->itemid) {
527                     $oldgrade = $used;
528                 }
529             }
530             $this->aggregate_grades($prevuser,
531                                     $items,
532                                     $grade_values,
533                                     $oldgrade,
534                                     $excluded,
535                                     $grademinoverrides,
536                                     $grademaxoverrides);//the last one
537         }
538         $rs->close();
540         return true;
541     }
543     /**
544      * Internal function for grade category grade aggregation
545      *
546      * @param int    $userid The User ID
547      * @param array  $items Grade items
548      * @param array  $grade_values Array of grade values
549      * @param object $oldgrade Old grade
550      * @param array  $excluded Excluded
551      * @param array  $grademinoverrides User specific grademin values if different to the grade_item grademin (key is itemid)
552      * @param array  $grademaxoverrides User specific grademax values if different to the grade_item grademax (key is itemid)
553      */
554     private function aggregate_grades($userid,
555                                       $items,
556                                       $grade_values,
557                                       $oldgrade,
558                                       $excluded,
559                                       $grademinoverrides,
560                                       $grademaxoverrides) {
561         global $CFG;
563         // Remember these so we can set flags on them to describe how they were used in the aggregation.
564         $novalue = array();
565         $dropped = array();
566         $usedweights = array();
568         if (empty($userid)) {
569             //ignore first call
570             return;
571         }
573         if ($oldgrade) {
574             $oldfinalgrade = $oldgrade->finalgrade;
575             $grade = new grade_grade($oldgrade, false);
576             $grade->grade_item =& $this->grade_item;
578         } else {
579             // insert final grade - it will be needed later anyway
580             $grade = new grade_grade(array('itemid'=>$this->grade_item->id, 'userid'=>$userid), false);
581             $grade->grade_item =& $this->grade_item;
582             $grade->insert('system');
583             $oldfinalgrade = null;
584         }
586         // no need to recalculate locked or overridden grades
587         if ($grade->is_locked() or $grade->is_overridden()) {
588             return;
589         }
591         // can not use own final category grade in calculation
592         unset($grade_values[$this->grade_item->id]);
594         // if no grades calculation possible or grading not allowed clear final grade
595         if (empty($grade_values) or empty($items) or ($this->grade_item->gradetype != GRADE_TYPE_VALUE and $this->grade_item->gradetype != GRADE_TYPE_SCALE)) {
596             $grade->finalgrade = null;
598             if (!is_null($oldfinalgrade)) {
599                 $grade->update('aggregation');
600             }
601             $dropped = $grade_values;
602             $this->set_usedinaggregation($userid, $usedweights, $novalue, $dropped);
603             return;
604         }
606         $minvisible = (bool) get_config('moodle', 'grade_report_showmin');
608         // normalize the grades first - all will have value 0...1
609         // ungraded items are not used in aggregation
610         foreach ($grade_values as $itemid=>$v) {
611             // Natural weighting currently cannot exclude empty grades, or grades from excluded items.
612             if ($this->aggregation != GRADE_AGGREGATE_SUM) {
613                 if (is_null($v)) {
614                     // null means no grade
615                     unset($grade_values[$itemid]);
616                     $novalue[$itemid] = 0;
617                     continue;
618                 } else if (in_array($itemid, $excluded)) {
619                     unset($grade_values[$itemid]);
620                     $dropped[$itemid] = 0;
621                     continue;
622                 }
623             }
624             // Check for user specific grade min/max overrides.
625             $usergrademin = $items[$itemid]->grademin;
626             $usergrademax = $items[$itemid]->grademax;
627             if (isset($grademinoverrides[$itemid])) {
628                 $usergrademin = $grademinoverrides[$itemid];
629             }
630             if (isset($grademaxoverrides[$itemid])) {
631                 $usergrademax = $grademaxoverrides[$itemid];
632             }
633             $grade_values[$itemid] = grade_grade::standardise_score($v, $usergrademin, $usergrademax, 0, 1);
634         }
635         // use min grade if grade missing for these types
636         if (!$this->aggregateonlygraded) {
638             foreach ($items as $itemid=>$value) {
640                 if (!isset($grade_values[$itemid]) and !in_array($itemid, $excluded)) {
641                     $grade_values[$itemid] = 0;
642                 }
643             }
644         }
646         // limit and sort
647         $allvalues = $grade_values;
648         $this->apply_limit_rules($grade_values, $items);
650         $moredropped = array_diff($allvalues, $grade_values);
651         foreach ($moredropped as $drop => $unused) {
652             $dropped[$drop] = 0;
653         }
654         asort($grade_values, SORT_NUMERIC);
656         // let's see we have still enough grades to do any statistics
657         if (count($grade_values) == 0) {
658             // not enough attempts yet
659             $grade->finalgrade = null;
661             if (!is_null($oldfinalgrade)) {
662                 $grade->update('aggregation');
663             }
664             $this->set_usedinaggregation($userid, $usedweights, $novalue, $dropped);
665             return;
666         }
668         // do the maths
669         $result = $this->aggregate_values_and_adjust_bounds($grade_values,
670                                                             $items,
671                                                             $usedweights,
672                                                             $grademinoverrides,
673                                                             $grademaxoverrides);
674         $agg_grade = $result['grade'];
676         // Recalculate the grade back to requested range.
677         $finalgrade = grade_grade::standardise_score($agg_grade, 0, 1, $result['grademin'], $result['grademax']);
679         $grade->finalgrade = $this->grade_item->bounded_grade($finalgrade);
680         $grade->rawgrademax = $result['grademax'];
682         // update in db if changed
683         if (grade_floats_different($grade->finalgrade, $oldfinalgrade)) {
684             $grade->update('aggregation');
685         }
687         $this->set_usedinaggregation($userid, $usedweights, $novalue, $dropped);
689         return;
690     }
692     /**
693      * Set the flags on the grade_grade items to indicate how individual grades are used
694      * in the aggregation.
695      *
696      * @param int $userid The user we have aggregated the grades for.
697      * @param array $usedweights An array with keys for each of the grade_item columns included in the aggregation. The value are the relative weight.
698      * @param array $novalue An array with keys for each of the grade_item columns skipped because
699      *                       they had no value in the aggregation
700      * @param array $dropped An array with keys for each of the grade_item columns dropped
701      *                       because of any drop lowest/highest settings in the aggregation
702      */
703     private function set_usedinaggregation($userid, $usedweights, $novalue, $dropped) {
704         global $DB;
706         // Included.
707         if (!empty($usedweights)) {
708             // The usedweights items are updated individually to record the weights.
709             foreach ($usedweights as $gradeitemid => $contribution) {
710                 $DB->set_field_select('grade_grades',
711                                       'aggregationweight',
712                                       $contribution,
713                                       "itemid = :itemid AND userid = :userid",
714                                       array('itemid'=>$gradeitemid, 'userid'=>$userid));
715             }
717             // Now set the status flag for all these weights.
718             list($itemsql, $itemlist) = $DB->get_in_or_equal(array_keys($usedweights), SQL_PARAMS_NAMED, 'g');
719             $itemlist['userid'] = $userid;
721             $DB->set_field_select('grade_grades',
722                                   'aggregationstatus',
723                                   'used',
724                                   "itemid $itemsql AND userid = :userid",
725                                   $itemlist);
726         }
728         // No value.
729         if (!empty($novalue)) {
730             list($itemsql, $itemlist) = $DB->get_in_or_equal(array_keys($novalue), SQL_PARAMS_NAMED, 'g');
732             $itemlist['userid'] = $userid;
734             $DB->set_field_select('grade_grades',
735                                   'aggregationstatus',
736                                   'novalue',
737                                   "itemid $itemsql AND userid = :userid",
738                                   $itemlist);
739         }
741         // Dropped.
742         if (!empty($dropped)) {
743             list($itemsql, $itemlist) = $DB->get_in_or_equal(array_keys($dropped), SQL_PARAMS_NAMED, 'g');
745             $itemlist['userid'] = $userid;
747             $DB->set_field_select('grade_grades',
748                                   'aggregationstatus',
749                                   'dropped',
750                                   "itemid $itemsql AND userid = :userid",
751                                   $itemlist);
752         }
753     }
755     /**
756      * Internal function that calculates the aggregated grade and new min/max for this grade category
757      *
758      * Must be public as it is used by grade_grade::get_hiding_affected()
759      *
760      * @param array $grade_values An array of values to be aggregated
761      * @param array $items The array of grade_items
762      * @since Moodle 2.6.5, 2.7.2
763      * @param array & $weights If provided, will be filled with the normalized weights
764      *                         for each grade_item as used in the aggregation.
765      * @param array  $grademinoverrides User specific grademin values if different to the grade_item grademin (key is itemid)
766      * @param array  $grademaxoverrides User specific grademax values if different to the grade_item grademax (key is itemid)
767      * @return array containing values for:
768      *                'grade' => the new calculated grade
769      *                'grademin' => the new calculated min grade for the category
770      *                'grademax' => the new calculated max grade for the category
771      */
772     public function aggregate_values_and_adjust_bounds($grade_values,
773                                                        $items,
774                                                        & $weights = null,
775                                                        $grademinoverrides = array(),
776                                                        $grademaxoverrides = array()) {
777         $category_item = $this->get_grade_item();
778         $grademin = $category_item->grademin;
779         $grademax = $category_item->grademax;
781         switch ($this->aggregation) {
783             case GRADE_AGGREGATE_MEDIAN: // Middle point value in the set: ignores frequencies
784                 $num = count($grade_values);
785                 $grades = array_values($grade_values);
787                 if ($num % 2 == 0) {
788                     $agg_grade = ($grades[intval($num/2)-1] + $grades[intval($num/2)]) / 2;
790                 } else {
791                     $agg_grade = $grades[intval(($num/2)-0.5)];
792                 }
794                 // Record the weights evenly.
795                 if ($weights !== null && $num > 0) {
796                     foreach ($grade_values as $itemid=>$grade_value) {
797                         $weights[$itemid] = 1.0 / $num;
798                     }
799                 }
800                 break;
802             case GRADE_AGGREGATE_MIN:
803                 $agg_grade = reset($grade_values);
804                 // Record the weights as used.
805                 if ($weights !== null) {
806                     foreach ($grade_values as $itemid=>$grade_value) {
807                         $weights[$itemid] = 0;
808                     }
809                 }
810                 // Set the first item to 1.
811                 $itemids = array_keys($grade_values);
812                 $weights[reset($itemids)] = 1;
813                 break;
815             case GRADE_AGGREGATE_MAX:
816                 // Record the weights as used.
817                 if ($weights !== null) {
818                     foreach ($grade_values as $itemid=>$grade_value) {
819                         $weights[$itemid] = 0;
820                     }
821                 }
822                 // Set the last item to 1.
823                 $itemids = array_keys($grade_values);
824                 $weights[end($itemids)] = 1;
825                 $agg_grade = end($grade_values);
826                 break;
828             case GRADE_AGGREGATE_MODE:       // the most common value
829                 // array_count_values only counts INT and STRING, so if grades are floats we must convert them to string
830                 $converted_grade_values = array();
832                 foreach ($grade_values as $k => $gv) {
834                     if (!is_int($gv) && !is_string($gv)) {
835                         $converted_grade_values[$k] = (string) $gv;
837                     } else {
838                         $converted_grade_values[$k] = $gv;
839                     }
840                     if ($weights !== null) {
841                         $weights[$k] = 0;
842                     }
843                 }
845                 $freq = array_count_values($converted_grade_values);
846                 arsort($freq);                      // sort by frequency keeping keys
847                 $top = reset($freq);               // highest frequency count
848                 $modes = array_keys($freq, $top);  // search for all modes (have the same highest count)
849                 rsort($modes, SORT_NUMERIC);       // get highest mode
850                 $agg_grade = reset($modes);
851                 // Record the weights as used.
852                 if ($weights !== null && $top > 0) {
853                     foreach ($grade_values as $k => $gv) {
854                         if ($gv == $agg_grade) {
855                             $weights[$k] = 1.0 / $top;
856                         }
857                     }
858                 }
859                 break;
861             case GRADE_AGGREGATE_WEIGHTED_MEAN: // Weighted average of all existing final grades, weight specified in coef
862                 $weightsum = 0;
863                 $sum       = 0;
865                 foreach ($grade_values as $itemid=>$grade_value) {
867                     if ($items[$itemid]->aggregationcoef <= 0) {
868                         continue;
869                     }
870                     $weightsum += $items[$itemid]->aggregationcoef;
871                     $sum       += $items[$itemid]->aggregationcoef * $grade_value;
872                     if ($weights !== null) {
873                         $weights[$itemid] = $items[$itemid]->aggregationcoef;
874                     }
875                 }
876                 if ($weightsum == 0) {
877                     $agg_grade = null;
879                 } else {
880                     $agg_grade = $sum / $weightsum;
881                     if ($weights !== null) {
882                         // Normalise the weights.
883                         foreach ($weights as $itemid => $weight) {
884                             $weights[$itemid] = $weight / $weightsum;
885                         }
886                     }
888                 }
889                 break;
891             case GRADE_AGGREGATE_WEIGHTED_MEAN2:
892                 // Weighted average of all existing final grades with optional extra credit flag,
893                 // weight is the range of grade (usually grademax)
894                 $weightsum = 0;
895                 $sum       = null;
897                 foreach ($grade_values as $itemid=>$grade_value) {
898                     $weight = $items[$itemid]->grademax - $items[$itemid]->grademin;
900                     if ($weight <= 0) {
901                         continue;
902                     }
904                     if ($items[$itemid]->aggregationcoef == 0) {
905                         $weightsum += $weight;
906                     }
907                     $sum += $weight * $grade_value;
908                 }
909                 if ($weightsum == 0) {
910                     $agg_grade = $sum; // only extra credits
912                 } else {
913                     $agg_grade = $sum / $weightsum;
914                 }
915                 // Record the weights as used.
916                 if ($weights !== null) {
917                     foreach ($grade_values as $itemid=>$grade_value) {
918                         if ($items[$itemid]->aggregationcoef == 0 && $weightsum > 0) {
919                             $weight = $items[$itemid]->grademax - $items[$itemid]->grademin;
920                             $weights[$itemid] = ($items[$itemid]->grademax - $items[$itemid]->grademin) / $weightsum;
921                         } else {
922                             $weights[$itemid] = 0;
923                         }
924                     }
925                 }
926                 break;
928             case GRADE_AGGREGATE_EXTRACREDIT_MEAN: // special average
929                 $num = 0;
930                 $sum = null;
932                 foreach ($grade_values as $itemid=>$grade_value) {
934                     if ($items[$itemid]->aggregationcoef == 0) {
935                         $num += 1;
936                         $sum += $grade_value;
937                         if ($weights !== null) {
938                             $weights[$itemid] = 1;
939                         }
941                     } else if ($items[$itemid]->aggregationcoef > 0) {
942                         $sum += $items[$itemid]->aggregationcoef * $grade_value;
943                         if ($weights !== null) {
944                             $weights[$itemid] = 0;
945                         }
946                     }
947                 }
948                 if ($weights !== null && $num > 0) {
949                     foreach ($grade_values as $itemid=>$grade_value) {
950                         if ($weights[$itemid]) {
951                             $weights[$itemid] = 1.0 / $num;
952                         }
953                     }
954                 }
956                 if ($num == 0) {
957                     $agg_grade = $sum; // only extra credits or wrong coefs
959                 } else {
960                     $agg_grade = $sum / $num;
961                 }
962                 break;
964             case GRADE_AGGREGATE_SUM:    // Add up all the items.
965                 $num = count($grade_values);
966                 $sum = 0;
967                 $sumweights = 0;
968                 $grademin = 0;
969                 $grademax = 0;
970                 foreach ($grade_values as $itemid => $gradevalue) {
971                     // We need to check if the grademax/min was adjusted per user because of excluded items.
972                     $usergrademin = $items[$itemid]->grademin;
973                     $usergrademax = $items[$itemid]->grademax;
974                     if (isset($grademinoverrides[$itemid])) {
975                         $usergrademin = $grademinoverrides[$itemid];
976                     }
977                     if (isset($grademaxoverrides[$itemid])) {
978                         $usergrademax = $grademaxoverrides[$itemid];
979                     }
980                     $gradeitemrange = $usergrademax - $usergrademin;
982                     // Extra credit.
983                     if (!($items[$itemid]->aggregationcoef > 0)) {
984                         $grademax += $gradeitemrange;
985                         $sumweights += $items[$itemid]->aggregationcoef2;
986                     }
987                 }
988                 $userweights = array();
989                 $totaloverriddenweight = 0;
990                 $totaloverriddengrademax = 0;
991                 // We first need to rescale all manually assigned weights down by the
992                 // percentage of weights missing from the category.
993                 foreach ($grade_values as $itemid => $gradevalue) {
994                     if ($items[$itemid]->weightoverride) {
995                         $userweights[$itemid] = $items[$itemid]->aggregationcoef2 / $sumweights;
996                         $totaloverriddenweight += $userweights[$itemid];
997                         $usergrademax = $items[$itemid]->grademax;
998                         if (isset($grademaxoverrides[$itemid])) {
999                             $usergrademax = $grademaxoverrides[$itemid];
1000                         }
1001                         $totaloverriddengrademax += $usergrademax;
1002                     }
1003                 }
1004                 $nonoverriddenpoints = $grademax - $totaloverriddengrademax;
1006                 // Then we need to recalculate the automatic weights.
1007                 foreach ($grade_values as $itemid => $gradevalue) {
1008                     if (!$items[$itemid]->weightoverride) {
1009                         if ($nonoverriddenpoints > 0) {
1010                             $usergrademax = $items[$itemid]->grademax;
1011                             if (isset($grademaxoverrides[$itemid])) {
1012                                 $usergrademax = $grademaxoverrides[$itemid];
1013                             }
1014                             $userweights[$itemid] = ($usergrademax/$nonoverriddenpoints) * (1 - $totaloverriddenweight);
1015                         } else {
1016                             $userweights[$itemid] = 0;
1017                         }
1018                     }
1019                 }
1021                 // We can use our freshly corrected weights below.
1022                 foreach ($grade_values as $itemid => $gradevalue) {
1023                     $sum += $gradevalue * $userweights[$itemid] * $grademax;
1024                     if ($weights !== null) {
1025                         $weights[$itemid] = $userweights[$itemid];
1026                     }
1027                 }
1028                 if ($grademax > 0) {
1029                     $agg_grade = $sum / $grademax; // Re-normalize score.
1030                 } else {
1031                     // Every item in the category is extra credit.
1032                     $agg_grade = $sum;
1033                     $grademax = $sum;
1034                 }
1036                 break;
1038             case GRADE_AGGREGATE_MEAN:    // Arithmetic average of all grade items (if ungraded aggregated, NULL counted as minimum)
1039             default:
1040                 $num = count($grade_values);
1041                 $sum = array_sum($grade_values);
1042                 $agg_grade = $sum / $num;
1043                 // Record the weights evenly.
1044                 if ($weights !== null && $num > 0) {
1045                     foreach ($grade_values as $itemid=>$grade_value) {
1046                         $weights[$itemid] = 1.0 / $num;
1047                     }
1048                 }
1049                 break;
1050         }
1052         return array('grade' => $agg_grade, 'grademin' => $grademin, 'grademax' => $grademax);
1053     }
1055     /**
1056      * Internal function that calculates the aggregated grade for this grade category
1057      *
1058      * Must be public as it is used by grade_grade::get_hiding_affected()
1059      *
1060      * @deprecated since Moodle 2.8
1061      * @param array $grade_values An array of values to be aggregated
1062      * @param array $items The array of grade_items
1063      * @return float The aggregate grade for this grade category
1064      */
1065     public function aggregate_values($grade_values, $items) {
1066         debugging('grade_category::aggregate_values() is deprecated.
1067                    Call grade_category::aggregate_values_and_adjust_bounds() instead.', DEBUG_DEVELOPER);
1068         $result = $this->aggregate_values_and_adjust_bounds($grade_values, $items);
1069         return $result['grade'];
1070     }
1072     /**
1073      * Some aggregation types may need to update their max grade.
1074      *
1075      * @return void
1076      */
1077     private function auto_update_max() {
1078         global $DB;
1079         if ($this->aggregation != GRADE_AGGREGATE_SUM) {
1080             // not needed at all
1081             return;
1082         }
1084         // Find grade items of immediate children (category or grade items) and force site settings.
1085         $this->load_grade_item();
1086         $depends_on = $this->grade_item->depends_on();
1088         $items = false;
1089         if (!empty($depends_on)) {
1090             list($usql, $params) = $DB->get_in_or_equal($depends_on);
1091             $sql = "SELECT *
1092                       FROM {grade_items}
1093                      WHERE id $usql";
1094             $items = $DB->get_records_sql($sql, $params);
1095         }
1097         if (!$items) {
1099             if ($this->grade_item->grademax != 0 or $this->grade_item->gradetype != GRADE_TYPE_VALUE) {
1100                 $this->grade_item->grademax  = 0;
1101                 $this->grade_item->grademin  = 0;
1102                 $this->grade_item->gradetype = GRADE_TYPE_VALUE;
1103                 $this->grade_item->update('aggregation');
1104             }
1105             return;
1106         }
1108         //find max grade possible
1109         $maxes = array();
1111         foreach ($items as $item) {
1113             if ($item->aggregationcoef > 0) {
1114                 // extra credit from this activity - does not affect total
1115                 continue;
1116             }
1118             if ($item->gradetype == GRADE_TYPE_VALUE) {
1119                 $maxes[$item->id] = $item->grademax;
1121             } else if ($item->gradetype == GRADE_TYPE_SCALE) {
1122                 $maxes[$item->id] = $item->grademax; // 0 = nograde, 1 = first scale item, 2 = second scale item
1123             }
1124         }
1125         // apply droplow and keephigh
1126         $this->apply_limit_rules($maxes, $items);
1127         $max = array_sum($maxes);
1129         // update db if anything changed
1130         if ($this->grade_item->grademax != $max or $this->grade_item->grademin != 0 or $this->grade_item->gradetype != GRADE_TYPE_VALUE) {
1131             $this->grade_item->grademax  = $max;
1132             $this->grade_item->grademin  = 0;
1133             $this->grade_item->gradetype = GRADE_TYPE_VALUE;
1134             $this->grade_item->update('aggregation');
1135         }
1136     }
1138     /**
1139      * Recalculate the weights of the grade items in this category.
1140      *
1141      * @return void
1142      */
1143     private function auto_update_weights() {
1144         if ($this->aggregation != GRADE_AGGREGATE_SUM) {
1145             // This is only required if we are using natural weights.
1146             return;
1147         }
1148         $children = $this->get_children();
1150         $grade_item = null;
1152         // Calculate the sum of the grademax's of all the items within this category.
1153         $totalgrademax = 0;
1155         // Out of 1, how much weight has been manually overriden by a user?
1156         $totaloverriddenweight  = 0;
1157         $totaloverriddengrademax  = 0;
1158         foreach ($children as $sortorder => $child) {
1159             $grade_item = null;
1161             if ($child['type'] == 'item') {
1162                 $grade_item = $child['object'];
1163             } else if ($child['type'] == 'category') {
1164                 $grade_item = $child['object']->load_grade_item();
1165             }
1167             // An extra credit grade item doesn't contribute to $totaloverriddengrademax.
1168             if ($grade_item->aggregationcoef > 0) {
1169                 continue;
1170             }
1172             $totalgrademax += $grade_item->grademax;
1173             if ($grade_item->weightoverride) {
1174                 $totaloverriddenweight += $grade_item->aggregationcoef2;
1175                 $totaloverriddengrademax += $grade_item->grademax;
1176             }
1177         }
1179         $totalgrademax -= $totaloverriddengrademax;
1181         reset($children);
1182         foreach ($children as $sortorder => $child) {
1183             $grade_item = null;
1185             if ($child['type'] == 'item') {
1186                 $grade_item = $child['object'];
1187             } else if ($child['type'] == 'category') {
1188                 $grade_item = $child['object']->load_grade_item();
1189             }
1190             if (!$grade_item->weightoverride) {
1191                 // Calculate this item's weight as a percentage of the non-overridden total grade maxes
1192                 // then convert it to a proportion of the available non-overriden weight.
1193                 $grade_item->aggregationcoef2 = ($grade_item->grademax/$totalgrademax) * (1 - $totaloverriddenweight);
1194                 $grade_item->update();
1195             }
1196         }
1197     }
1199     /**
1200      * Given an array of grade values (numerical indices) applies droplow or keephigh rules to limit the final array.
1201      *
1202      * @param array $grade_values itemid=>$grade_value float
1203      * @param array $items grade item objects
1204      * @return array Limited grades.
1205      */
1206     public function apply_limit_rules(&$grade_values, $items) {
1207         $extraused = $this->is_extracredit_used();
1209         if (!empty($this->droplow)) {
1210             asort($grade_values, SORT_NUMERIC);
1211             $dropped = 0;
1213             // If we have fewer grade items available to drop than $this->droplow, use this flag to escape the loop
1214             // May occur because of "extra credit" or if droplow is higher than the number of grade items
1215             $droppedsomething = true;
1217             while ($dropped < $this->droplow && $droppedsomething) {
1218                 $droppedsomething = false;
1220                 $grade_keys = array_keys($grade_values);
1221                 $gradekeycount = count($grade_keys);
1223                 if ($gradekeycount === 0) {
1224                     //We've dropped all grade items
1225                     break;
1226                 }
1228                 $originalindex = $founditemid = $foundmax = null;
1230                 // Find the first remaining grade item that is available to be dropped
1231                 foreach ($grade_keys as $gradekeyindex=>$gradekey) {
1232                     if (!$extraused || $items[$gradekey]->aggregationcoef <= 0) {
1233                         // Found a non-extra credit grade item that is eligible to be dropped
1234                         $originalindex = $gradekeyindex;
1235                         $founditemid = $grade_keys[$originalindex];
1236                         $foundmax = $items[$founditemid]->grademax;
1237                         break;
1238                     }
1239                 }
1241                 if (empty($founditemid)) {
1242                     // No grade items available to drop
1243                     break;
1244                 }
1246                 // Now iterate over the remaining grade items
1247                 // We're looking for other grade items with the same grade value but a higher grademax
1248                 $i = 1;
1249                 while ($originalindex + $i < $gradekeycount) {
1251                     $possibleitemid = $grade_keys[$originalindex+$i];
1252                     $i++;
1254                     if ($grade_values[$founditemid] != $grade_values[$possibleitemid]) {
1255                         // The next grade item has a different grade value. Stop looking.
1256                         break;
1257                     }
1259                     if ($extraused && $items[$possibleitemid]->aggregationcoef > 0) {
1260                         // Don't drop extra credit grade items. Continue the search.
1261                         continue;
1262                     }
1264                     if ($foundmax < $items[$possibleitemid]->grademax) {
1265                         // Found a grade item with the same grade value and a higher grademax
1266                         $foundmax = $items[$possibleitemid]->grademax;
1267                         $founditemid = $possibleitemid;
1268                         // Continue searching to see if there is an even higher grademax
1269                     }
1270                 }
1272                 // Now drop whatever grade item we have found
1273                 unset($grade_values[$founditemid]);
1274                 $dropped++;
1275                 $droppedsomething = true;
1276             }
1278         } else if (!empty($this->keephigh)) {
1279             arsort($grade_values, SORT_NUMERIC);
1280             $kept = 0;
1282             foreach ($grade_values as $itemid=>$value) {
1284                 if ($extraused and $items[$itemid]->aggregationcoef > 0) {
1285                     // we keep all extra credits
1287                 } else if ($kept < $this->keephigh) {
1288                     $kept++;
1290                 } else {
1291                     unset($grade_values[$itemid]);
1292                 }
1293             }
1294         }
1295     }
1297     /**
1298      * Returns true if category uses extra credit of any kind
1299      *
1300      * @return bool True if extra credit used
1301      */
1302     public function is_extracredit_used() {
1303         return self::aggregation_uses_extracredit($this->aggregation);
1304     }
1306     /**
1307      * Returns true if aggregation passed is using extracredit.
1308      *
1309      * @param int $aggregation Aggregation const.
1310      * @return bool True if extra credit used
1311      */
1312     public static function aggregation_uses_extracredit($aggregation) {
1313         return ($aggregation == GRADE_AGGREGATE_WEIGHTED_MEAN2
1314              or $aggregation == GRADE_AGGREGATE_EXTRACREDIT_MEAN
1315              or $aggregation == GRADE_AGGREGATE_SUM);
1316     }
1318     /**
1319      * Returns true if category uses special aggregation coefficient
1320      *
1321      * @return bool True if an aggregation coefficient is being used
1322      */
1323     public function is_aggregationcoef_used() {
1324         return self::aggregation_uses_aggregationcoef($this->aggregation);
1326     }
1328     /**
1329      * Returns true if aggregation uses aggregationcoef
1330      *
1331      * @param int $aggregation Aggregation const.
1332      * @return bool True if an aggregation coefficient is being used
1333      */
1334     public static function aggregation_uses_aggregationcoef($aggregation) {
1335         return ($aggregation == GRADE_AGGREGATE_WEIGHTED_MEAN
1336              or $aggregation == GRADE_AGGREGATE_WEIGHTED_MEAN2
1337              or $aggregation == GRADE_AGGREGATE_EXTRACREDIT_MEAN
1338              or $aggregation == GRADE_AGGREGATE_SUM);
1340     }
1342     /**
1343      * Recursive function to find which weight/extra credit field to use in the grade item form.
1344      *
1345      * Inherits from a parent category if that category has aggregatesubcats set to true.
1346      *
1347      * @param string $first Whether or not this is the first item in the recursion
1348      * @return string
1349      */
1350     public function get_coefstring($first=true) {
1351         if (!is_null($this->coefstring)) {
1352             return $this->coefstring;
1353         }
1355         $overriding_coefstring = null;
1357         // Stop recursing upwards if this category aggregates subcats or has no parent
1358         if (!$first && !$this->aggregatesubcats) {
1360             if ($parent_category = $this->load_parent_category()) {
1361                 return $parent_category->get_coefstring(false);
1363             } else {
1364                 return null;
1365             }
1367         } else if ($first) {
1369             if (!$this->aggregatesubcats) {
1371                 if ($parent_category = $this->load_parent_category()) {
1372                     $overriding_coefstring = $parent_category->get_coefstring(false);
1373                 }
1374             }
1375         }
1377         // If an overriding coefstring has trickled down from one of the parent categories, return it. Otherwise, return self.
1378         if (!is_null($overriding_coefstring)) {
1379             return $overriding_coefstring;
1380         }
1382         // No parent category is overriding this category's aggregation, return its string
1383         if ($this->aggregation == GRADE_AGGREGATE_WEIGHTED_MEAN) {
1384             $this->coefstring = 'aggregationcoefweight';
1386         } else if ($this->aggregation == GRADE_AGGREGATE_WEIGHTED_MEAN2) {
1387             $this->coefstring = 'aggregationcoefextrasum';
1389         } else if ($this->aggregation == GRADE_AGGREGATE_EXTRACREDIT_MEAN) {
1390             $this->coefstring = 'aggregationcoefextraweight';
1392         } else if ($this->aggregation == GRADE_AGGREGATE_SUM) {
1393             $this->coefstring = 'aggregationcoefextrasum';
1395         } else {
1396             $this->coefstring = 'aggregationcoef';
1397         }
1398         return $this->coefstring;
1399     }
1401     /**
1402      * Returns tree with all grade_items and categories as elements
1403      *
1404      * @param int $courseid The course ID
1405      * @param bool $include_category_items as category children
1406      * @return array
1407      */
1408     public static function fetch_course_tree($courseid, $include_category_items=false) {
1409         $course_category = grade_category::fetch_course_category($courseid);
1410         $category_array = array('object'=>$course_category, 'type'=>'category', 'depth'=>1,
1411                                 'children'=>$course_category->get_children($include_category_items));
1413         $course_category->sortorder = $course_category->get_sortorder();
1414         $sortorder = $course_category->get_sortorder();
1415         return grade_category::_fetch_course_tree_recursion($category_array, $sortorder);
1416     }
1418     /**
1419      * An internal function that recursively sorts grade categories within a course
1420      *
1421      * @param array $category_array The seed of the recursion
1422      * @param int   $sortorder The current sortorder
1423      * @return array An array containing 'object', 'type', 'depth' and optionally 'children'
1424      */
1425     static private function _fetch_course_tree_recursion($category_array, &$sortorder) {
1426         // update the sortorder in db if needed
1427         //NOTE: This leads to us resetting sort orders every time the categories and items page is viewed :(
1428         //if ($category_array['object']->sortorder != $sortorder) {
1429             //$category_array['object']->set_sortorder($sortorder);
1430         //}
1432         if (isset($category_array['object']->gradetype) && $category_array['object']->gradetype==GRADE_TYPE_NONE) {
1433             return null;
1434         }
1436         // store the grade_item or grade_category instance with extra info
1437         $result = array('object'=>$category_array['object'], 'type'=>$category_array['type'], 'depth'=>$category_array['depth']);
1439         // reuse final grades if there
1440         if (array_key_exists('finalgrades', $category_array)) {
1441             $result['finalgrades'] = $category_array['finalgrades'];
1442         }
1444         // recursively resort children
1445         if (!empty($category_array['children'])) {
1446             $result['children'] = array();
1447             //process the category item first
1448             $child = null;
1450             foreach ($category_array['children'] as $oldorder=>$child_array) {
1452                 if ($child_array['type'] == 'courseitem' or $child_array['type'] == 'categoryitem') {
1453                     $child = grade_category::_fetch_course_tree_recursion($child_array, $sortorder);
1454                     if (!empty($child)) {
1455                         $result['children'][$sortorder] = $child;
1456                     }
1457                 }
1458             }
1460             foreach ($category_array['children'] as $oldorder=>$child_array) {
1462                 if ($child_array['type'] != 'courseitem' and $child_array['type'] != 'categoryitem') {
1463                     $child = grade_category::_fetch_course_tree_recursion($child_array, $sortorder);
1464                     if (!empty($child)) {
1465                         $result['children'][++$sortorder] = $child;
1466                     }
1467                 }
1468             }
1469         }
1471         return $result;
1472     }
1474     /**
1475      * Fetches and returns all the children categories and/or grade_items belonging to this category.
1476      * By default only returns the immediate children (depth=1), but deeper levels can be requested,
1477      * as well as all levels (0). The elements are indexed by sort order.
1478      *
1479      * @param bool $include_category_items Whether or not to include category grade_items in the children array
1480      * @return array Array of child objects (grade_category and grade_item).
1481      */
1482     public function get_children($include_category_items=false) {
1483         global $DB;
1485         // This function must be as fast as possible ;-)
1486         // fetch all course grade items and categories into memory - we do not expect hundreds of these in course
1487         // we have to limit the number of queries though, because it will be used often in grade reports
1489         $cats  = $DB->get_records('grade_categories', array('courseid' => $this->courseid));
1490         $items = $DB->get_records('grade_items', array('courseid' => $this->courseid));
1492         // init children array first
1493         foreach ($cats as $catid=>$cat) {
1494             $cats[$catid]->children = array();
1495         }
1497         //first attach items to cats and add category sortorder
1498         foreach ($items as $item) {
1500             if ($item->itemtype == 'course' or $item->itemtype == 'category') {
1501                 $cats[$item->iteminstance]->sortorder = $item->sortorder;
1503                 if (!$include_category_items) {
1504                     continue;
1505                 }
1506                 $categoryid = $item->iteminstance;
1508             } else {
1509                 $categoryid = $item->categoryid;
1510                 if (empty($categoryid)) {
1511                     debugging('Found a grade item that isnt in a category');
1512                 }
1513             }
1515             // prevent problems with duplicate sortorders in db
1516             $sortorder = $item->sortorder;
1518             while (array_key_exists($categoryid, $cats)
1519                 && array_key_exists($sortorder, $cats[$categoryid]->children)) {
1521                 $sortorder++;
1522             }
1524             $cats[$categoryid]->children[$sortorder] = $item;
1526         }
1528         // now find the requested category and connect categories as children
1529         $category = false;
1531         foreach ($cats as $catid=>$cat) {
1533             if (empty($cat->parent)) {
1535                 if ($cat->path !== '/'.$cat->id.'/') {
1536                     $grade_category = new grade_category($cat, false);
1537                     $grade_category->path  = '/'.$cat->id.'/';
1538                     $grade_category->depth = 1;
1539                     $grade_category->update('system');
1540                     return $this->get_children($include_category_items);
1541                 }
1543             } else {
1545                 if (empty($cat->path) or !preg_match('|/'.$cat->parent.'/'.$cat->id.'/$|', $cat->path)) {
1546                     //fix paths and depts
1547                     static $recursioncounter = 0; // prevents infinite recursion
1548                     $recursioncounter++;
1550                     if ($recursioncounter < 5) {
1551                         // fix paths and depths!
1552                         $grade_category = new grade_category($cat, false);
1553                         $grade_category->depth = 0;
1554                         $grade_category->path  = null;
1555                         $grade_category->update('system');
1556                         return $this->get_children($include_category_items);
1557                     }
1558                 }
1559                 // prevent problems with duplicate sortorders in db
1560                 $sortorder = $cat->sortorder;
1562                 while (array_key_exists($sortorder, $cats[$cat->parent]->children)) {
1563                     //debugging("$sortorder exists in cat loop");
1564                     $sortorder++;
1565                 }
1567                 $cats[$cat->parent]->children[$sortorder] = &$cats[$catid];
1568             }
1570             if ($catid == $this->id) {
1571                 $category = &$cats[$catid];
1572             }
1573         }
1575         unset($items); // not needed
1576         unset($cats); // not needed
1578         $children_array = grade_category::_get_children_recursion($category);
1580         ksort($children_array);
1582         return $children_array;
1584     }
1586     /**
1587      * Private method used to retrieve all children of this category recursively
1588      *
1589      * @param grade_category $category Source of current recursion
1590      * @return array An array of child grade categories
1591      */
1592     private static function _get_children_recursion($category) {
1594         $children_array = array();
1595         foreach ($category->children as $sortorder=>$child) {
1597             if (array_key_exists('itemtype', $child)) {
1598                 $grade_item = new grade_item($child, false);
1600                 if (in_array($grade_item->itemtype, array('course', 'category'))) {
1601                     $type  = $grade_item->itemtype.'item';
1602                     $depth = $category->depth;
1604                 } else {
1605                     $type  = 'item';
1606                     $depth = $category->depth; // we use this to set the same colour
1607                 }
1608                 $children_array[$sortorder] = array('object'=>$grade_item, 'type'=>$type, 'depth'=>$depth);
1610             } else {
1611                 $children = grade_category::_get_children_recursion($child);
1612                 $grade_category = new grade_category($child, false);
1614                 if (empty($children)) {
1615                     $children = array();
1616                 }
1617                 $children_array[$sortorder] = array('object'=>$grade_category, 'type'=>'category', 'depth'=>$grade_category->depth, 'children'=>$children);
1618             }
1619         }
1621         // sort the array
1622         ksort($children_array);
1624         return $children_array;
1625     }
1627     /**
1628      * Uses {@link get_grade_item()} to load or create a grade_item, then saves it as $this->grade_item.
1629      *
1630      * @return grade_item
1631      */
1632     public function load_grade_item() {
1633         if (empty($this->grade_item)) {
1634             $this->grade_item = $this->get_grade_item();
1635         }
1636         return $this->grade_item;
1637     }
1639     /**
1640      * Retrieves this grade categories' associated grade_item from the database
1641      *
1642      * If no grade_item exists yet, creates one.
1643      *
1644      * @return grade_item
1645      */
1646     public function get_grade_item() {
1647         if (empty($this->id)) {
1648             debugging("Attempt to obtain a grade_category's associated grade_item without the category's ID being set.");
1649             return false;
1650         }
1652         if (empty($this->parent)) {
1653             $params = array('courseid'=>$this->courseid, 'itemtype'=>'course', 'iteminstance'=>$this->id);
1655         } else {
1656             $params = array('courseid'=>$this->courseid, 'itemtype'=>'category', 'iteminstance'=>$this->id);
1657         }
1659         if (!$grade_items = grade_item::fetch_all($params)) {
1660             // create a new one
1661             $grade_item = new grade_item($params, false);
1662             $grade_item->gradetype = GRADE_TYPE_VALUE;
1663             $grade_item->insert('system');
1665         } else if (count($grade_items) == 1) {
1666             // found existing one
1667             $grade_item = reset($grade_items);
1669         } else {
1670             debugging("Found more than one grade_item attached to category id:".$this->id);
1671             // return first one
1672             $grade_item = reset($grade_items);
1673         }
1675         return $grade_item;
1676     }
1678     /**
1679      * Uses $this->parent to instantiate $this->parent_category based on the referenced record in the DB
1680      *
1681      * @return grade_category The parent category
1682      */
1683     public function load_parent_category() {
1684         if (empty($this->parent_category) && !empty($this->parent)) {
1685             $this->parent_category = $this->get_parent_category();
1686         }
1687         return $this->parent_category;
1688     }
1690     /**
1691      * Uses $this->parent to instantiate and return a grade_category object
1692      *
1693      * @return grade_category Returns the parent category or null if this category has no parent
1694      */
1695     public function get_parent_category() {
1696         if (!empty($this->parent)) {
1697             $parent_category = new grade_category(array('id' => $this->parent));
1698             return $parent_category;
1699         } else {
1700             return null;
1701         }
1702     }
1704     /**
1705      * Returns the most descriptive field for this grade category
1706      *
1707      * @return string name
1708      */
1709     public function get_name() {
1710         global $DB;
1711         // For a course category, we return the course name if the fullname is set to '?' in the DB (empty in the category edit form)
1712         if (empty($this->parent) && $this->fullname == '?') {
1713             $course = $DB->get_record('course', array('id'=> $this->courseid));
1714             return format_string($course->fullname);
1716         } else {
1717             return $this->fullname;
1718         }
1719     }
1721     /**
1722      * Describe the aggregation settings for this category so the reports make more sense.
1723      *
1724      * @return string description
1725      */
1726     public function get_description() {
1727         $allhelp = array();
1728         $aggrstrings = grade_helper::get_aggregation_strings();
1729         $allhelp[] = $aggrstrings[$this->aggregation];
1731         if ($this->droplow) {
1732             $allhelp[] = get_string('droplowestvalues', 'grades', $this->droplow);
1733         }
1734         if ($this->keephigh) {
1735             $allhelp[] = get_string('keephighestvalues', 'grades', $this->keephigh);
1736         }
1737         if (!$this->aggregateonlygraded) {
1738             $allhelp[] = get_string('aggregatenotonlygraded', 'grades');
1739         }
1740         if ($this->aggregatesubcats) {
1741             $allhelp[] = get_string('aggregatesubcatsshort', 'grades');
1742         }
1743         return implode('. ', $allhelp) . '.';
1744     }
1746     /**
1747      * Sets this category's parent id
1748      *
1749      * @param int $parentid The ID of the category that is the new parent to $this
1750      * @param string $source From where was the object updated (mod/forum, manual, etc.)
1751      * @return bool success
1752      */
1753     public function set_parent($parentid, $source=null) {
1754         if ($this->parent == $parentid) {
1755             return true;
1756         }
1758         if ($parentid == $this->id) {
1759             print_error('cannotassignselfasparent');
1760         }
1762         if (empty($this->parent) and $this->is_course_category()) {
1763             print_error('cannothaveparentcate');
1764         }
1766         // find parent and check course id
1767         if (!$parent_category = grade_category::fetch(array('id'=>$parentid, 'courseid'=>$this->courseid))) {
1768             return false;
1769         }
1771         $this->force_regrading();
1773         // set new parent category
1774         $this->parent          = $parent_category->id;
1775         $this->parent_category =& $parent_category;
1776         $this->path            = null;       // remove old path and depth - will be recalculated in update()
1777         $this->depth           = 0;          // remove old path and depth - will be recalculated in update()
1778         $this->update($source);
1780         return $this->update($source);
1781     }
1783     /**
1784      * Returns the final grade values for this grade category.
1785      *
1786      * @param int $userid Optional user ID to retrieve a single user's final grade
1787      * @return mixed An array of all final_grades (stdClass objects) for this grade_item, or a single final_grade.
1788      */
1789     public function get_final($userid=null) {
1790         $this->load_grade_item();
1791         return $this->grade_item->get_final($userid);
1792     }
1794     /**
1795      * Returns the sortorder of the grade categories' associated grade_item
1796      *
1797      * This method is also available in grade_item for cases where the object type is not known.
1798      *
1799      * @return int Sort order
1800      */
1801     public function get_sortorder() {
1802         $this->load_grade_item();
1803         return $this->grade_item->get_sortorder();
1804     }
1806     /**
1807      * Returns the idnumber of the grade categories' associated grade_item.
1808      *
1809      * This method is also available in grade_item for cases where the object type is not known.
1810      *
1811      * @return string idnumber
1812      */
1813     public function get_idnumber() {
1814         $this->load_grade_item();
1815         return $this->grade_item->get_idnumber();
1816     }
1818     /**
1819      * Sets the sortorder variable for this category.
1820      *
1821      * This method is also available in grade_item, for cases where the object type is not know.
1822      *
1823      * @param int $sortorder The sortorder to assign to this category
1824      */
1825     public function set_sortorder($sortorder) {
1826         $this->load_grade_item();
1827         $this->grade_item->set_sortorder($sortorder);
1828     }
1830     /**
1831      * Move this category after the given sortorder
1832      *
1833      * Does not change the parent
1834      *
1835      * @param int $sortorder to place after.
1836      * @return void
1837      */
1838     public function move_after_sortorder($sortorder) {
1839         $this->load_grade_item();
1840         $this->grade_item->move_after_sortorder($sortorder);
1841     }
1843     /**
1844      * Return true if this is the top most category that represents the total course grade.
1845      *
1846      * @return bool
1847      */
1848     public function is_course_category() {
1849         $this->load_grade_item();
1850         return $this->grade_item->is_course_item();
1851     }
1853     /**
1854      * Return the course level grade_category object
1855      *
1856      * @param int $courseid The Course ID
1857      * @return grade_category Returns the course level grade_category instance
1858      */
1859     public static function fetch_course_category($courseid) {
1860         if (empty($courseid)) {
1861             debugging('Missing course id!');
1862             return false;
1863         }
1865         // course category has no parent
1866         if ($course_category = grade_category::fetch(array('courseid'=>$courseid, 'parent'=>null))) {
1867             return $course_category;
1868         }
1870         // create a new one
1871         $course_category = new grade_category();
1872         $course_category->insert_course_category($courseid);
1874         return $course_category;
1875     }
1877     /**
1878      * Is grading object editable?
1879      *
1880      * @return bool
1881      */
1882     public function is_editable() {
1883         return true;
1884     }
1886     /**
1887      * Returns the locked state/date of the grade categories' associated grade_item.
1888      *
1889      * This method is also available in grade_item, for cases where the object type is not known.
1890      *
1891      * @return bool
1892      */
1893     public function is_locked() {
1894         $this->load_grade_item();
1895         return $this->grade_item->is_locked();
1896     }
1898     /**
1899      * Sets the grade_item's locked variable and updates the grade_item.
1900      *
1901      * Calls set_locked() on the categories' grade_item
1902      *
1903      * @param int  $lockedstate 0, 1 or a timestamp int(10) after which date the item will be locked.
1904      * @param bool $cascade lock/unlock child objects too
1905      * @param bool $refresh refresh grades when unlocking
1906      * @return bool success if category locked (not all children mayb be locked though)
1907      */
1908     public function set_locked($lockedstate, $cascade=false, $refresh=true) {
1909         $this->load_grade_item();
1911         $result = $this->grade_item->set_locked($lockedstate, $cascade, true);
1913         if ($cascade) {
1914             //process all children - items and categories
1915             if ($children = grade_item::fetch_all(array('categoryid'=>$this->id))) {
1917                 foreach ($children as $child) {
1918                     $child->set_locked($lockedstate, true, false);
1920                     if (empty($lockedstate) and $refresh) {
1921                         //refresh when unlocking
1922                         $child->refresh_grades();
1923                     }
1924                 }
1925             }
1927             if ($children = grade_category::fetch_all(array('parent'=>$this->id))) {
1929                 foreach ($children as $child) {
1930                     $child->set_locked($lockedstate, true, true);
1931                 }
1932             }
1933         }
1935         return $result;
1936     }
1938     /**
1939      * Overrides grade_object::set_properties() to add special handling for changes to category aggregation types
1940      *
1941      * @param stdClass $instance the object to set the properties on
1942      * @param array|stdClass $params Either an associative array or an object containing property name, property value pairs
1943      */
1944     public static function set_properties(&$instance, $params) {
1945         global $DB;
1947         parent::set_properties($instance, $params);
1949         //if they've changed aggregation type we made need to do some fiddling to provide appropriate defaults
1950         if (!empty($params->aggregation)) {
1952             //weight and extra credit share a column :( Would like a default of 1 for weight and 0 for extra credit
1953             //Flip from the default of 0 to 1 (or vice versa) if ALL items in the category are still set to the old default.
1954             if (self::aggregation_uses_aggregationcoef($params->aggregation)) {
1955                 $sql = $defaultaggregationcoef = null;
1957                 if (!self::aggregation_uses_extracredit($params->aggregation)) {
1958                     //if all items in this category have aggregation coefficient of 0 we can change it to 1 ie evenly weighted
1959                     $sql = "select count(id) from {grade_items} where categoryid=:categoryid and aggregationcoef!=0";
1960                     $defaultaggregationcoef = 1;
1961                 } else {
1962                     //if all items in this category have aggregation coefficient of 1 we can change it to 0 ie no extra credit
1963                     $sql = "select count(id) from {grade_items} where categoryid=:categoryid and aggregationcoef!=1";
1964                     $defaultaggregationcoef = 0;
1965                 }
1967                 $params = array('categoryid'=>$instance->id);
1968                 $count = $DB->count_records_sql($sql, $params);
1969                 if ($count===0) { //category is either empty or all items are set to a default value so we can switch defaults
1970                     $params['aggregationcoef'] = $defaultaggregationcoef;
1971                     $DB->execute("update {grade_items} set aggregationcoef=:aggregationcoef where categoryid=:categoryid",$params);
1972                 }
1973             }
1974         }
1975     }
1977     /**
1978      * Sets the grade_item's hidden variable and updates the grade_item.
1979      *
1980      * Overrides grade_item::set_hidden() to add cascading of the hidden value to grade items in this grade category
1981      *
1982      * @param int $hidden 0 mean always visible, 1 means always hidden and a number > 1 is a timestamp to hide until
1983      * @param bool $cascade apply to child objects too
1984      */
1985     public function set_hidden($hidden, $cascade=false) {
1986         $this->load_grade_item();
1987         //this hides the associated grade item (the course total)
1988         $this->grade_item->set_hidden($hidden, $cascade);
1989         //this hides the category itself and everything it contains
1990         parent::set_hidden($hidden, $cascade);
1992         if ($cascade) {
1994             if ($children = grade_item::fetch_all(array('categoryid'=>$this->id))) {
1996                 foreach ($children as $child) {
1997                     if ($child->can_control_visibility()) {
1998                         $child->set_hidden($hidden, $cascade);
1999                     }
2000                 }
2001             }
2003             if ($children = grade_category::fetch_all(array('parent'=>$this->id))) {
2005                 foreach ($children as $child) {
2006                     $child->set_hidden($hidden, $cascade);
2007                 }
2008             }
2009         }
2011         //if marking category visible make sure parent category is visible MDL-21367
2012         if( !$hidden ) {
2013             $category_array = grade_category::fetch_all(array('id'=>$this->parent));
2014             if ($category_array && array_key_exists($this->parent, $category_array)) {
2015                 $category = $category_array[$this->parent];
2016                 //call set_hidden on the category regardless of whether it is hidden as its parent might be hidden
2017                 //if($category->is_hidden()) {
2018                     $category->set_hidden($hidden, false);
2019                 //}
2020             }
2021         }
2022     }
2024     /**
2025      * Applies default settings on this category
2026      *
2027      * @return bool True if anything changed
2028      */
2029     public function apply_default_settings() {
2030         global $CFG;
2032         foreach ($this->forceable as $property) {
2034             if (isset($CFG->{"grade_$property"})) {
2036                 if ($CFG->{"grade_$property"} == -1) {
2037                     continue; //temporary bc before version bump
2038                 }
2039                 $this->$property = $CFG->{"grade_$property"};
2040             }
2041         }
2042     }
2044     /**
2045      * Applies forced settings on this category
2046      *
2047      * @return bool True if anything changed
2048      */
2049     public function apply_forced_settings() {
2050         global $CFG;
2052         $updated = false;
2054         foreach ($this->forceable as $property) {
2056             if (isset($CFG->{"grade_$property"}) and isset($CFG->{"grade_{$property}_flag"}) and
2057                                                     ((int) $CFG->{"grade_{$property}_flag"} & 1)) {
2059                 if ($CFG->{"grade_$property"} == -1) {
2060                     continue; //temporary bc before version bump
2061                 }
2062                 $this->$property = $CFG->{"grade_$property"};
2063                 $updated = true;
2064             }
2065         }
2067         return $updated;
2068     }
2070     /**
2071      * Notification of change in forced category settings.
2072      *
2073      * Causes all course and category grade items to be marked as needing to be updated
2074      */
2075     public static function updated_forced_settings() {
2076         global $CFG, $DB;
2077         $params = array(1, 'course', 'category');
2078         $sql = "UPDATE {grade_items} SET needsupdate=? WHERE itemtype=? or itemtype=?";
2079         $DB->execute($sql, $params);
2080     }