f26f8212d01bac7bc30034951a617f158d4e2120
[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      * Static variable storing the result from {@link self::can_apply_limit_rules}.
165      * @var bool
166      */
167     protected $canapplylimitrules;
169     /**
170      * Builds this category's path string based on its parents (if any) and its own id number.
171      * This is typically done just before inserting this object in the DB for the first time,
172      * or when a new parent is added or changed. It is a recursive function: once the calling
173      * object no longer has a parent, the path is complete.
174      *
175      * @param grade_category $grade_category A Grade_Category object
176      * @return string The category's path string
177      */
178     public static function build_path($grade_category) {
179         global $DB;
181         if (empty($grade_category->parent)) {
182             return '/'.$grade_category->id.'/';
184         } else {
185             $parent = $DB->get_record('grade_categories', array('id' => $grade_category->parent));
186             return grade_category::build_path($parent).$grade_category->id.'/';
187         }
188     }
190     /**
191      * Finds and returns a grade_category instance based on params.
192      *
193      * @param array $params associative arrays varname=>value
194      * @return grade_category The retrieved grade_category instance or false if none found.
195      */
196     public static function fetch($params) {
197         return grade_object::fetch_helper('grade_categories', 'grade_category', $params);
198     }
200     /**
201      * Finds and returns all grade_category instances based on params.
202      *
203      * @param array $params associative arrays varname=>value
204      * @return array array of grade_category insatnces or false if none found.
205      */
206     public static function fetch_all($params) {
207         return grade_object::fetch_all_helper('grade_categories', 'grade_category', $params);
208     }
210     /**
211      * In addition to update() as defined in grade_object, call force_regrading of parent categories, if applicable.
212      *
213      * @param string $source from where was the object updated (mod/forum, manual, etc.)
214      * @return bool success
215      */
216     public function update($source=null) {
217         // load the grade item or create a new one
218         $this->load_grade_item();
220         // force recalculation of path;
221         if (empty($this->path)) {
222             $this->path  = grade_category::build_path($this);
223             $this->depth = substr_count($this->path, '/') - 1;
224             $updatechildren = true;
226         } else {
227             $updatechildren = false;
228         }
230         $this->apply_forced_settings();
232         // these are exclusive
233         if ($this->droplow > 0) {
234             $this->keephigh = 0;
236         } else if ($this->keephigh > 0) {
237             $this->droplow = 0;
238         }
240         // Recalculate grades if needed
241         if ($this->qualifies_for_regrading()) {
242             $this->force_regrading();
243         }
245         $this->timemodified = time();
247         $result = parent::update($source);
249         // now update paths in all child categories
250         if ($result and $updatechildren) {
252             if ($children = grade_category::fetch_all(array('parent'=>$this->id))) {
254                 foreach ($children as $child) {
255                     $child->path  = null;
256                     $child->depth = 0;
257                     $child->update($source);
258                 }
259             }
260         }
262         return $result;
263     }
265     /**
266      * If parent::delete() is successful, send force_regrading message to parent category.
267      *
268      * @param string $source from where was the object deleted (mod/forum, manual, etc.)
269      * @return bool success
270      */
271     public function delete($source=null) {
272         $grade_item = $this->load_grade_item();
274         if ($this->is_course_category()) {
276             if ($categories = grade_category::fetch_all(array('courseid'=>$this->courseid))) {
278                 foreach ($categories as $category) {
280                     if ($category->id == $this->id) {
281                         continue; // do not delete course category yet
282                     }
283                     $category->delete($source);
284                 }
285             }
287             if ($items = grade_item::fetch_all(array('courseid'=>$this->courseid))) {
289                 foreach ($items as $item) {
291                     if ($item->id == $grade_item->id) {
292                         continue; // do not delete course item yet
293                     }
294                     $item->delete($source);
295                 }
296             }
298         } else {
299             $this->force_regrading();
301             $parent = $this->load_parent_category();
303             // Update children's categoryid/parent field first
304             if ($children = grade_item::fetch_all(array('categoryid'=>$this->id))) {
305                 foreach ($children as $child) {
306                     $child->set_parent($parent->id);
307                 }
308             }
310             if ($children = grade_category::fetch_all(array('parent'=>$this->id))) {
311                 foreach ($children as $child) {
312                     $child->set_parent($parent->id);
313                 }
314             }
315         }
317         // first delete the attached grade item and grades
318         $grade_item->delete($source);
320         // delete category itself
321         return parent::delete($source);
322     }
324     /**
325      * In addition to the normal insert() defined in grade_object, this method sets the depth
326      * and path for this object, and update the record accordingly.
327      *
328      * We do this here instead of in the constructor as they both need to know the record's
329      * ID number, which only gets created at insertion time.
330      * This method also creates an associated grade_item if this wasn't done during construction.
331      *
332      * @param string $source from where was the object inserted (mod/forum, manual, etc.)
333      * @return int PK ID if successful, false otherwise
334      */
335     public function insert($source=null) {
337         if (empty($this->courseid)) {
338             print_error('cannotinsertgrade');
339         }
341         if (empty($this->parent)) {
342             $course_category = grade_category::fetch_course_category($this->courseid);
343             $this->parent = $course_category->id;
344         }
346         $this->path = null;
348         $this->timecreated = $this->timemodified = time();
350         if (!parent::insert($source)) {
351             debugging("Could not insert this category: " . print_r($this, true));
352             return false;
353         }
355         $this->force_regrading();
357         // build path and depth
358         $this->update($source);
360         return $this->id;
361     }
363     /**
364      * Internal function - used only from fetch_course_category()
365      * Normal insert() can not be used for course category
366      *
367      * @param int $courseid The course ID
368      * @return int The ID of the new course category
369      */
370     public function insert_course_category($courseid) {
371         $this->courseid    = $courseid;
372         $this->fullname    = '?';
373         $this->path        = null;
374         $this->parent      = null;
375         $this->aggregation = GRADE_AGGREGATE_WEIGHTED_MEAN2;
377         $this->apply_default_settings();
378         $this->apply_forced_settings();
380         $this->timecreated = $this->timemodified = time();
382         if (!parent::insert('system')) {
383             debugging("Could not insert this category: " . print_r($this, true));
384             return false;
385         }
387         // build path and depth
388         $this->update('system');
390         return $this->id;
391     }
393     /**
394      * Compares the values held by this object with those of the matching record in DB, and returns
395      * whether or not these differences are sufficient to justify an update of all parent objects.
396      * This assumes that this object has an ID number and a matching record in DB. If not, it will return false.
397      *
398      * @return bool
399      */
400     public function qualifies_for_regrading() {
401         if (empty($this->id)) {
402             debugging("Can not regrade non existing category");
403             return false;
404         }
406         $db_item = grade_category::fetch(array('id'=>$this->id));
408         $aggregationdiff = $db_item->aggregation         != $this->aggregation;
409         $keephighdiff    = $db_item->keephigh            != $this->keephigh;
410         $droplowdiff     = $db_item->droplow             != $this->droplow;
411         $aggonlygrddiff  = $db_item->aggregateonlygraded != $this->aggregateonlygraded;
412         $aggoutcomesdiff = $db_item->aggregateoutcomes   != $this->aggregateoutcomes;
413         $aggsubcatsdiff  = $db_item->aggregatesubcats    != $this->aggregatesubcats;
415         return ($aggregationdiff || $keephighdiff || $droplowdiff || $aggonlygrddiff || $aggoutcomesdiff || $aggsubcatsdiff);
416     }
418     /**
419      * Marks this grade categories' associated grade item as needing regrading
420      */
421     public function force_regrading() {
422         $grade_item = $this->load_grade_item();
423         $grade_item->force_regrading();
424     }
426     /**
427      * Something that should be called before we start regrading the whole course.
428      *
429      * @return void
430      */
431     public function pre_regrade_final_grades() {
432         $this->auto_update_weights();
433         $this->auto_update_max();
434     }
436     /**
437      * Generates and saves final grades in associated category grade item.
438      * These immediate children must already have their own final grades.
439      * The category's aggregation method is used to generate final grades.
440      *
441      * Please note that category grade is either calculated or aggregated, not both at the same time.
442      *
443      * This method must be used ONLY from grade_item::regrade_final_grades(),
444      * because the calculation must be done in correct order!
445      *
446      * Steps to follow:
447      *  1. Get final grades from immediate children
448      *  3. Aggregate these grades
449      *  4. Save them in final grades of associated category grade item
450      *
451      * @param int $userid The user ID if final grade generation should be limited to a single user
452      * @return bool
453      */
454     public function generate_grades($userid=null) {
455         global $CFG, $DB;
457         $this->load_grade_item();
459         if ($this->grade_item->is_locked()) {
460             return true; // no need to recalculate locked items
461         }
463         // find grade items of immediate children (category or grade items) and force site settings
464         $depends_on = $this->grade_item->depends_on();
466         if (empty($depends_on)) {
467             $items = false;
469         } else {
470             list($usql, $params) = $DB->get_in_or_equal($depends_on);
471             $sql = "SELECT *
472                       FROM {grade_items}
473                      WHERE id $usql";
474             $items = $DB->get_records_sql($sql, $params);
475         }
477         $grade_inst = new grade_grade();
478         $fields = 'g.'.implode(',g.', $grade_inst->required_fields);
480         // where to look for final grades - include grade of this item too, we will store the results there
481         $gis = array_merge($depends_on, array($this->grade_item->id));
482         list($usql, $params) = $DB->get_in_or_equal($gis);
484         if ($userid) {
485             $usersql = "AND g.userid=?";
486             $params[] = $userid;
488         } else {
489             $usersql = "";
490         }
492         $sql = "SELECT $fields
493                   FROM {grade_grades} g, {grade_items} gi
494                  WHERE gi.id = g.itemid AND gi.id $usql $usersql
495               ORDER BY g.userid";
497         // group the results by userid and aggregate the grades for this user
498         $rs = $DB->get_recordset_sql($sql, $params);
499         if ($rs->valid()) {
500             $prevuser = 0;
501             $grade_values = array();
502             $excluded     = array();
503             $oldgrade     = null;
504             $grademaxoverrides = array();
505             $grademinoverrides = array();
507             foreach ($rs as $used) {
509                 if ($used->userid != $prevuser) {
510                     $this->aggregate_grades($prevuser,
511                                             $items,
512                                             $grade_values,
513                                             $oldgrade,
514                                             $excluded,
515                                             $grademinoverrides,
516                                             $grademaxoverrides);
517                     $prevuser = $used->userid;
518                     $grade_values = array();
519                     $excluded     = array();
520                     $oldgrade     = null;
521                     $grademaxoverrides = array();
522                     $grademinoverrides = array();
523                 }
524                 $grade_values[$used->itemid] = $used->finalgrade;
525                 $grademaxoverrides[$used->itemid] = $used->rawgrademax;
526                 $grademinoverrides[$used->itemid] = $used->rawgrademin;
528                 if ($used->excluded) {
529                     $excluded[] = $used->itemid;
530                 }
532                 if ($this->grade_item->id == $used->itemid) {
533                     $oldgrade = $used;
534                 }
535             }
536             $this->aggregate_grades($prevuser,
537                                     $items,
538                                     $grade_values,
539                                     $oldgrade,
540                                     $excluded,
541                                     $grademinoverrides,
542                                     $grademaxoverrides);//the last one
543         }
544         $rs->close();
546         return true;
547     }
549     /**
550      * Internal function for grade category grade aggregation
551      *
552      * @param int    $userid The User ID
553      * @param array  $items Grade items
554      * @param array  $grade_values Array of grade values
555      * @param object $oldgrade Old grade
556      * @param array  $excluded Excluded
557      * @param array  $grademinoverrides User specific grademin values if different to the grade_item grademin (key is itemid)
558      * @param array  $grademaxoverrides User specific grademax values if different to the grade_item grademax (key is itemid)
559      */
560     private function aggregate_grades($userid,
561                                       $items,
562                                       $grade_values,
563                                       $oldgrade,
564                                       $excluded,
565                                       $grademinoverrides,
566                                       $grademaxoverrides) {
567         global $CFG, $DB;
569         // Remember these so we can set flags on them to describe how they were used in the aggregation.
570         $novalue = array();
571         $dropped = array();
572         $extracredit = array();
573         $usedweights = array();
575         if (empty($userid)) {
576             //ignore first call
577             return;
578         }
580         if ($oldgrade) {
581             $oldfinalgrade = $oldgrade->finalgrade;
582             $grade = new grade_grade($oldgrade, false);
583             $grade->grade_item =& $this->grade_item;
585         } else {
586             // insert final grade - it will be needed later anyway
587             $grade = new grade_grade(array('itemid'=>$this->grade_item->id, 'userid'=>$userid), false);
588             $grade->grade_item =& $this->grade_item;
589             $grade->insert('system');
590             $oldfinalgrade = null;
591         }
593         // no need to recalculate locked or overridden grades
594         if ($grade->is_locked() or $grade->is_overridden()) {
595             return;
596         }
598         // can not use own final category grade in calculation
599         unset($grade_values[$this->grade_item->id]);
601         // Make sure a grade_grade exists for every grade_item.
602         // We need to do this so we can set the aggregationstatus
603         // with a set_field call instead of checking if each one exists and creating/updating.
604         if (!empty($items)) {
605             list($ggsql, $params) = $DB->get_in_or_equal(array_keys($items), SQL_PARAMS_NAMED, 'g');
608             $params['userid'] = $userid;
609             $sql = "SELECT itemid
610                       FROM {grade_grades}
611                      WHERE itemid $ggsql AND userid = :userid";
612             $existingitems = $DB->get_records_sql($sql, $params);
614             $notexisting = array_diff(array_keys($items), array_keys($existingitems));
615             foreach ($notexisting as $itemid) {
616                 $gradeitem = $items[$itemid];
617                 $gradegrade = new grade_grade(array('itemid' => $itemid,
618                                                     'userid' => $userid,
619                                                     'rawgrademin' => $gradeitem->grademin,
620                                                     'rawgrademax' => $gradeitem->grademax), false);
621                 $gradegrade->grade_item = $gradeitem;
622                 $gradegrade->insert('system');
623             }
624         }
626         // if no grades calculation possible or grading not allowed clear final grade
627         if (empty($grade_values) or empty($items) or ($this->grade_item->gradetype != GRADE_TYPE_VALUE and $this->grade_item->gradetype != GRADE_TYPE_SCALE)) {
628             $grade->finalgrade = null;
630             if (!is_null($oldfinalgrade)) {
631                 $grade->update('aggregation');
632             }
633             $dropped = $grade_values;
634             $this->set_usedinaggregation($userid, $usedweights, $novalue, $dropped, $extracredit);
635             return;
636         }
638         // Normalize the grades first - all will have value 0...1
639         // ungraded items are not used in aggregation.
640         foreach ($grade_values as $itemid=>$v) {
641             if (is_null($v)) {
642                 // If null, it means no grade.
643                 if ($this->aggregateonlygraded) {
644                     unset($grade_values[$itemid]);
645                     // Mark this item as "excluded empty" because it has no grade.
646                     $novalue[$itemid] = 0;
647                     continue;
648                 }
649             }
650             if (in_array($itemid, $excluded)) {
651                 unset($grade_values[$itemid]);
652                 $dropped[$itemid] = 0;
653                 continue;
654             }
655             // Check for user specific grade min/max overrides.
656             $usergrademin = $items[$itemid]->grademin;
657             $usergrademax = $items[$itemid]->grademax;
658             if (isset($grademinoverrides[$itemid])) {
659                 $usergrademin = $grademinoverrides[$itemid];
660             }
661             if (isset($grademaxoverrides[$itemid])) {
662                 $usergrademax = $grademaxoverrides[$itemid];
663             }
664             if ($this->aggregation == GRADE_AGGREGATE_SUM) {
665                 // Assume that the grademin is 0 when standardising the score, to preserve negative grades.
666                 $grade_values[$itemid] = grade_grade::standardise_score($v, 0, $usergrademax, 0, 1);
667             } else {
668                 $grade_values[$itemid] = grade_grade::standardise_score($v, $usergrademin, $usergrademax, 0, 1);
669             }
671         }
673         // For items with no value, and not excluded - either set their grade to 0 or exclude them.
674         foreach ($items as $itemid=>$value) {
675             if (!isset($grade_values[$itemid]) and !in_array($itemid, $excluded)) {
676                 if (!$this->aggregateonlygraded) {
677                     $grade_values[$itemid] = 0;
678                 } else {
679                     // We are specifically marking these items as "excluded empty".
680                     $novalue[$itemid] = 0;
681                 }
682             }
683         }
685         // limit and sort
686         $allvalues = $grade_values;
687         if ($this->can_apply_limit_rules()) {
688             $this->apply_limit_rules($grade_values, $items);
689         }
691         $moredropped = array_diff($allvalues, $grade_values);
692         foreach ($moredropped as $drop => $unused) {
693             $dropped[$drop] = 0;
694         }
696         foreach ($grade_values as $itemid => $val) {
697             if (self::is_extracredit_used() && ($items[$itemid]->aggregationcoef > 0)) {
698                 $extracredit[$itemid] = 0;
699             }
700         }
702         asort($grade_values, SORT_NUMERIC);
704         // let's see we have still enough grades to do any statistics
705         if (count($grade_values) == 0) {
706             // not enough attempts yet
707             $grade->finalgrade = null;
709             if (!is_null($oldfinalgrade)) {
710                 $grade->update('aggregation');
711             }
712             $this->set_usedinaggregation($userid, $usedweights, $novalue, $dropped, $extracredit);
713             return;
714         }
716         // do the maths
717         $result = $this->aggregate_values_and_adjust_bounds($grade_values,
718                                                             $items,
719                                                             $usedweights,
720                                                             $grademinoverrides,
721                                                             $grademaxoverrides);
722         $agg_grade = $result['grade'];
724         // Set the actual grademin and max to bind the grade properly.
725         $this->grade_item->grademin = $result['grademin'];
726         $this->grade_item->grademax = $result['grademax'];
728         if ($this->aggregation == GRADE_AGGREGATE_SUM) {
729             // The natural aggregation always displays the range as coming from 0 for categories.
730             // However, when we bind the grade we allow for negative values.
731             $result['grademin'] = 0;
732         }
734         // Recalculate the grade back to requested range.
735         $finalgrade = grade_grade::standardise_score($agg_grade, 0, 1, $result['grademin'], $result['grademax']);
736         $grade->finalgrade = $this->grade_item->bounded_grade($finalgrade);
738         $oldrawgrademin = $grade->rawgrademin;
739         $oldrawgrademax = $grade->rawgrademax;
740         $grade->rawgrademin = $result['grademin'];
741         $grade->rawgrademax = $result['grademax'];
743         // Update in db if changed.
744         if (grade_floats_different($grade->finalgrade, $oldfinalgrade) ||
745                 grade_floats_different($grade->rawgrademax, $oldrawgrademax) ||
746                 grade_floats_different($grade->rawgrademin, $oldrawgrademin)) {
747             $grade->update('aggregation');
748         }
750         $this->set_usedinaggregation($userid, $usedweights, $novalue, $dropped, $extracredit);
752         return;
753     }
755     /**
756      * Set the flags on the grade_grade items to indicate how individual grades are used
757      * in the aggregation.
758      *
759      * @param int $userid The user we have aggregated the grades for.
760      * @param array $usedweights An array with keys for each of the grade_item columns included in the aggregation. The value are the relative weight.
761      * @param array $novalue An array with keys for each of the grade_item columns skipped because
762      *                       they had no value in the aggregation.
763      * @param array $dropped An array with keys for each of the grade_item columns dropped
764      *                       because of any drop lowest/highest settings in the aggregation.
765      * @param array $extracredit An array with keys for each of the grade_item columns
766      *                       considered extra credit by the aggregation.
767      */
768     private function set_usedinaggregation($userid, $usedweights, $novalue, $dropped, $extracredit) {
769         global $DB;
771         // Included.
772         if (!empty($usedweights)) {
773             // The usedweights items are updated individually to record the weights.
774             foreach ($usedweights as $gradeitemid => $contribution) {
775                 $DB->set_field_select('grade_grades',
776                                       'aggregationweight',
777                                       $contribution,
778                                       "itemid = :itemid AND userid = :userid",
779                                       array('itemid'=>$gradeitemid, 'userid'=>$userid));
780             }
782             // Now set the status flag for all these weights.
783             list($itemsql, $itemlist) = $DB->get_in_or_equal(array_keys($usedweights), SQL_PARAMS_NAMED, 'g');
784             $itemlist['userid'] = $userid;
786             $DB->set_field_select('grade_grades',
787                                   'aggregationstatus',
788                                   'used',
789                                   "itemid $itemsql AND userid = :userid",
790                                   $itemlist);
791         }
793         // No value.
794         if (!empty($novalue)) {
795             list($itemsql, $itemlist) = $DB->get_in_or_equal(array_keys($novalue), SQL_PARAMS_NAMED, 'g');
797             $itemlist['userid'] = $userid;
799             $DB->set_field_select('grade_grades',
800                                   'aggregationstatus',
801                                   'novalue',
802                                   "itemid $itemsql AND userid = :userid",
803                                   $itemlist);
804         }
806         // Dropped.
807         if (!empty($dropped)) {
808             list($itemsql, $itemlist) = $DB->get_in_or_equal(array_keys($dropped), SQL_PARAMS_NAMED, 'g');
810             $itemlist['userid'] = $userid;
812             $DB->set_field_select('grade_grades',
813                                   'aggregationstatus',
814                                   'dropped',
815                                   "itemid $itemsql AND userid = :userid",
816                                   $itemlist);
817         }
818         // Extra credit.
819         if (!empty($extracredit)) {
820             list($itemsql, $itemlist) = $DB->get_in_or_equal(array_keys($extracredit), SQL_PARAMS_NAMED, 'g');
822             $itemlist['userid'] = $userid;
824             $DB->set_field_select('grade_grades',
825                                   'aggregationstatus',
826                                   'extra',
827                                   "itemid $itemsql AND userid = :userid",
828                                   $itemlist);
829         }
830     }
832     /**
833      * Internal function that calculates the aggregated grade and new min/max for this grade category
834      *
835      * Must be public as it is used by grade_grade::get_hiding_affected()
836      *
837      * @param array $grade_values An array of values to be aggregated
838      * @param array $items The array of grade_items
839      * @since Moodle 2.6.5, 2.7.2
840      * @param array & $weights If provided, will be filled with the normalized weights
841      *                         for each grade_item as used in the aggregation.
842      *                         Some rules for the weights are:
843      *                         1. The weights must add up to 1 (unless there are extra credit)
844      *                         2. The contributed points column must add up to the course
845      *                         final grade and this column is calculated from these weights.
846      * @param array  $grademinoverrides User specific grademin values if different to the grade_item grademin (key is itemid)
847      * @param array  $grademaxoverrides User specific grademax values if different to the grade_item grademax (key is itemid)
848      * @return array containing values for:
849      *                'grade' => the new calculated grade
850      *                'grademin' => the new calculated min grade for the category
851      *                'grademax' => the new calculated max grade for the category
852      */
853     public function aggregate_values_and_adjust_bounds($grade_values,
854                                                        $items,
855                                                        & $weights = null,
856                                                        $grademinoverrides = array(),
857                                                        $grademaxoverrides = array()) {
858         $category_item = $this->get_grade_item();
859         $grademin = $category_item->grademin;
860         $grademax = $category_item->grademax;
862         switch ($this->aggregation) {
864             case GRADE_AGGREGATE_MEDIAN: // Middle point value in the set: ignores frequencies
865                 $num = count($grade_values);
866                 $grades = array_values($grade_values);
868                 // The median gets 100% - others get 0.
869                 if ($weights !== null && $num > 0) {
870                     $count = 0;
871                     foreach ($grade_values as $itemid=>$grade_value) {
872                         if (($num % 2 == 0) && ($count == intval($num/2)-1 || $count == intval($num/2))) {
873                             $weights[$itemid] = 0.5;
874                         } else if (($num % 2 != 0) && ($count == intval(($num/2)-0.5))) {
875                             $weights[$itemid] = 1.0;
876                         } else {
877                             $weights[$itemid] = 0;
878                         }
879                         $count++;
880                     }
881                 }
882                 if ($num % 2 == 0) {
883                     $agg_grade = ($grades[intval($num/2)-1] + $grades[intval($num/2)]) / 2;
884                 } else {
885                     $agg_grade = $grades[intval(($num/2)-0.5)];
886                 }
888                 break;
890             case GRADE_AGGREGATE_MIN:
891                 $agg_grade = reset($grade_values);
892                 // Record the weights as used.
893                 if ($weights !== null) {
894                     foreach ($grade_values as $itemid=>$grade_value) {
895                         $weights[$itemid] = 0;
896                     }
897                 }
898                 // Set the first item to 1.
899                 $itemids = array_keys($grade_values);
900                 $weights[reset($itemids)] = 1;
901                 break;
903             case GRADE_AGGREGATE_MAX:
904                 // Record the weights as used.
905                 if ($weights !== null) {
906                     foreach ($grade_values as $itemid=>$grade_value) {
907                         $weights[$itemid] = 0;
908                     }
909                 }
910                 // Set the last item to 1.
911                 $itemids = array_keys($grade_values);
912                 $weights[end($itemids)] = 1;
913                 $agg_grade = end($grade_values);
914                 break;
916             case GRADE_AGGREGATE_MODE:       // the most common value
917                 // array_count_values only counts INT and STRING, so if grades are floats we must convert them to string
918                 $converted_grade_values = array();
920                 foreach ($grade_values as $k => $gv) {
922                     if (!is_int($gv) && !is_string($gv)) {
923                         $converted_grade_values[$k] = (string) $gv;
925                     } else {
926                         $converted_grade_values[$k] = $gv;
927                     }
928                     if ($weights !== null) {
929                         $weights[$k] = 0;
930                     }
931                 }
933                 $freq = array_count_values($converted_grade_values);
934                 arsort($freq);                      // sort by frequency keeping keys
935                 $top = reset($freq);               // highest frequency count
936                 $modes = array_keys($freq, $top);  // search for all modes (have the same highest count)
937                 rsort($modes, SORT_NUMERIC);       // get highest mode
938                 $agg_grade = reset($modes);
939                 // Record the weights as used.
940                 if ($weights !== null && $top > 0) {
941                     foreach ($grade_values as $k => $gv) {
942                         if ($gv == $agg_grade) {
943                             $weights[$k] = 1.0 / $top;
944                         }
945                     }
946                 }
947                 break;
949             case GRADE_AGGREGATE_WEIGHTED_MEAN: // Weighted average of all existing final grades, weight specified in coef
950                 $weightsum = 0;
951                 $sum       = 0;
953                 foreach ($grade_values as $itemid=>$grade_value) {
955                     if ($items[$itemid]->aggregationcoef <= 0) {
956                         continue;
957                     }
958                     $weightsum += $items[$itemid]->aggregationcoef;
959                     $sum       += $items[$itemid]->aggregationcoef * $grade_value;
960                     if ($weights !== null) {
961                         $weights[$itemid] = $items[$itemid]->aggregationcoef;
962                     }
963                 }
964                 if ($weightsum == 0) {
965                     $agg_grade = null;
967                 } else {
968                     $agg_grade = $sum / $weightsum;
969                     if ($weights !== null) {
970                         // Normalise the weights.
971                         foreach ($weights as $itemid => $weight) {
972                             $weights[$itemid] = $weight / $weightsum;
973                         }
974                     }
976                 }
977                 break;
979             case GRADE_AGGREGATE_WEIGHTED_MEAN2:
980                 // Weighted average of all existing final grades with optional extra credit flag,
981                 // weight is the range of grade (usually grademax)
982                 $weightsum = 0;
983                 $sum       = null;
985                 foreach ($grade_values as $itemid=>$grade_value) {
986                     $weight = $items[$itemid]->grademax - $items[$itemid]->grademin;
988                     if ($weight <= 0) {
989                         continue;
990                     }
992                     if ($items[$itemid]->aggregationcoef == 0) {
993                         $weightsum += $weight;
994                     }
995                     $sum += $weight * $grade_value;
996                 }
997                 if ($weightsum == 0) {
998                     $agg_grade = $sum; // only extra credits
1000                 } else {
1001                     $agg_grade = $sum / $weightsum;
1002                 }
1003                 // Record the weights as used.
1004                 if ($weights !== null) {
1005                     foreach ($grade_values as $itemid=>$grade_value) {
1006                         if ($weightsum > 0) {
1007                             $weight = $items[$itemid]->grademax - $items[$itemid]->grademin;
1008                             $weights[$itemid] = $weight / $weightsum;
1009                         } else {
1010                             $weights[$itemid] = 0;
1011                         }
1012                     }
1013                 }
1014                 break;
1016             case GRADE_AGGREGATE_EXTRACREDIT_MEAN: // special average
1017                 $num = 0;
1018                 $sum = null;
1020                 foreach ($grade_values as $itemid=>$grade_value) {
1022                     if ($items[$itemid]->aggregationcoef == 0) {
1023                         $num += 1;
1024                         $sum += $grade_value;
1025                         if ($weights !== null) {
1026                             $weights[$itemid] = 1;
1027                         }
1029                     } else if ($items[$itemid]->aggregationcoef > 0) {
1030                         $sum += $items[$itemid]->aggregationcoef * $grade_value;
1031                         if ($weights !== null) {
1032                             $weights[$itemid] = 1;
1033                         }
1034                     }
1035                 }
1036                 if ($weights !== null && $num > 0) {
1037                     foreach ($grade_values as $itemid=>$grade_value) {
1038                         if ($weights[$itemid]) {
1039                             $weights[$itemid] = 1.0 / $num;
1040                         }
1041                     }
1042                 }
1044                 if ($num == 0) {
1045                     $agg_grade = $sum; // only extra credits or wrong coefs
1047                 } else {
1048                     $agg_grade = $sum / $num;
1049                 }
1050                 break;
1052             case GRADE_AGGREGATE_SUM:    // Add up all the items.
1053                 $num = count($grade_values);
1054                 $sum = 0;
1055                 $sumweights = 0;
1056                 $grademin = 0;
1057                 $grademax = 0;
1058                 foreach ($grade_values as $itemid => $gradevalue) {
1059                     // We need to check if the grademax/min was adjusted per user because of excluded items.
1060                     $usergrademin = $items[$itemid]->grademin;
1061                     $usergrademax = $items[$itemid]->grademax;
1062                     if (isset($grademinoverrides[$itemid])) {
1063                         $usergrademin = $grademinoverrides[$itemid];
1064                     }
1065                     if (isset($grademaxoverrides[$itemid])) {
1066                         $usergrademax = $grademaxoverrides[$itemid];
1067                     }
1069                     // Ignore extra credit and items with a weight of 0.
1070                     if ($items[$itemid]->aggregationcoef <= 0 && $items[$itemid]->aggregationcoef2 > 0) {
1071                         $grademin += $usergrademin;
1072                         $grademax += $usergrademax;
1073                         $sumweights += $items[$itemid]->aggregationcoef2;
1074                     }
1075                 }
1076                 $userweights = array();
1077                 $totaloverriddenweight = 0;
1078                 $totaloverriddengrademax = 0;
1079                 // We first need to rescale all manually assigned weights down by the
1080                 // percentage of weights missing from the category.
1081                 foreach ($grade_values as $itemid => $gradevalue) {
1082                     if ($items[$itemid]->weightoverride) {
1083                         if ($items[$itemid]->aggregationcoef2 <= 0) {
1084                             // Records the weight of 0 and continue.
1085                             $userweights[$itemid] = 0;
1086                             continue;
1087                         }
1088                         $userweights[$itemid] = $items[$itemid]->aggregationcoef2 / $sumweights;
1089                         $totaloverriddenweight += $userweights[$itemid];
1090                         $usergrademax = $items[$itemid]->grademax;
1091                         if (isset($grademaxoverrides[$itemid])) {
1092                             $usergrademax = $grademaxoverrides[$itemid];
1093                         }
1094                         $totaloverriddengrademax += $usergrademax;
1095                     }
1096                 }
1097                 $nonoverriddenpoints = $grademax - $totaloverriddengrademax;
1099                 // Then we need to recalculate the automatic weights.
1100                 foreach ($grade_values as $itemid => $gradevalue) {
1101                     if (!$items[$itemid]->weightoverride) {
1102                         $usergrademax = $items[$itemid]->grademax;
1103                         if (isset($grademaxoverrides[$itemid])) {
1104                             $usergrademax = $grademaxoverrides[$itemid];
1105                         }
1106                         if ($nonoverriddenpoints > 0) {
1107                             $userweights[$itemid] = ($usergrademax/$nonoverriddenpoints) * (1 - $totaloverriddenweight);
1108                         } else {
1109                             $userweights[$itemid] = 0;
1110                             if ($items[$itemid]->aggregationcoef2 > 0) {
1111                                 // Items with a weight of 0 should not count for the grade max,
1112                                 // though this only applies if the weight was changed to 0.
1113                                 $grademax -= $usergrademax;
1114                             }
1115                         }
1116                     }
1117                 }
1119                 // We can use our freshly corrected weights below.
1120                 foreach ($grade_values as $itemid => $gradevalue) {
1121                     $sum += $gradevalue * $userweights[$itemid] * $grademax;
1122                     if ($weights !== null) {
1123                         $weights[$itemid] = $userweights[$itemid];
1124                     }
1125                 }
1126                 if ($grademax > 0) {
1127                     $agg_grade = $sum / $grademax; // Re-normalize score.
1128                 } else {
1129                     // Every item in the category is extra credit.
1130                     $agg_grade = $sum;
1131                     $grademax = $sum;
1132                 }
1134                 break;
1136             case GRADE_AGGREGATE_MEAN:    // Arithmetic average of all grade items (if ungraded aggregated, NULL counted as minimum)
1137             default:
1138                 $num = count($grade_values);
1139                 $sum = array_sum($grade_values);
1140                 $agg_grade = $sum / $num;
1141                 // Record the weights evenly.
1142                 if ($weights !== null && $num > 0) {
1143                     foreach ($grade_values as $itemid=>$grade_value) {
1144                         $weights[$itemid] = 1.0 / $num;
1145                     }
1146                 }
1147                 break;
1148         }
1150         return array('grade' => $agg_grade, 'grademin' => $grademin, 'grademax' => $grademax);
1151     }
1153     /**
1154      * Internal function that calculates the aggregated grade for this grade category
1155      *
1156      * Must be public as it is used by grade_grade::get_hiding_affected()
1157      *
1158      * @deprecated since Moodle 2.8
1159      * @param array $grade_values An array of values to be aggregated
1160      * @param array $items The array of grade_items
1161      * @return float The aggregate grade for this grade category
1162      */
1163     public function aggregate_values($grade_values, $items) {
1164         debugging('grade_category::aggregate_values() is deprecated.
1165                    Call grade_category::aggregate_values_and_adjust_bounds() instead.', DEBUG_DEVELOPER);
1166         $result = $this->aggregate_values_and_adjust_bounds($grade_values, $items);
1167         return $result['grade'];
1168     }
1170     /**
1171      * Some aggregation types may need to update their max grade.
1172      *
1173      * This must be executed after updating the weights as it relies on them.
1174      *
1175      * @return void
1176      */
1177     private function auto_update_max() {
1178         global $DB;
1179         if ($this->aggregation != GRADE_AGGREGATE_SUM) {
1180             // not needed at all
1181             return;
1182         }
1184         // Find grade items of immediate children (category or grade items) and force site settings.
1185         $this->load_grade_item();
1186         $depends_on = $this->grade_item->depends_on();
1188         $items = false;
1189         if (!empty($depends_on)) {
1190             list($usql, $params) = $DB->get_in_or_equal($depends_on);
1191             $sql = "SELECT *
1192                       FROM {grade_items}
1193                      WHERE id $usql";
1194             $items = $DB->get_records_sql($sql, $params);
1195         }
1197         if (!$items) {
1199             if ($this->grade_item->grademax != 0 or $this->grade_item->gradetype != GRADE_TYPE_VALUE) {
1200                 $this->grade_item->grademax  = 0;
1201                 $this->grade_item->grademin  = 0;
1202                 $this->grade_item->gradetype = GRADE_TYPE_VALUE;
1203                 $this->grade_item->update('aggregation');
1204             }
1205             return;
1206         }
1208         //find max grade possible
1209         $maxes = array();
1211         foreach ($items as $item) {
1213             if ($item->aggregationcoef > 0) {
1214                 // extra credit from this activity - does not affect total
1215                 continue;
1216             } else if ($item->aggregationcoef2 <= 0) {
1217                 // Items with a weight of 0 do not affect the total.
1218                 continue;
1219             }
1221             if ($item->gradetype == GRADE_TYPE_VALUE) {
1222                 $maxes[$item->id] = $item->grademax;
1224             } else if ($item->gradetype == GRADE_TYPE_SCALE) {
1225                 $maxes[$item->id] = $item->grademax; // 0 = nograde, 1 = first scale item, 2 = second scale item
1226             }
1227         }
1229         if ($this->can_apply_limit_rules()) {
1230             // Apply droplow and keephigh.
1231             $this->apply_limit_rules($maxes, $items);
1232         }
1233         $max = array_sum($maxes);
1235         // update db if anything changed
1236         if ($this->grade_item->grademax != $max or $this->grade_item->grademin != 0 or $this->grade_item->gradetype != GRADE_TYPE_VALUE) {
1237             $this->grade_item->grademax  = $max;
1238             $this->grade_item->grademin  = 0;
1239             $this->grade_item->gradetype = GRADE_TYPE_VALUE;
1240             $this->grade_item->update('aggregation');
1241         }
1242     }
1244     /**
1245      * Recalculate the weights of the grade items in this category.
1246      *
1247      * The category total is not updated here, a further call to
1248      * {@link self::auto_update_max()} is required.
1249      *
1250      * @return void
1251      */
1252     private function auto_update_weights() {
1253         if ($this->aggregation != GRADE_AGGREGATE_SUM) {
1254             // This is only required if we are using natural weights.
1255             return;
1256         }
1257         $children = $this->get_children();
1259         $gradeitem = null;
1261         // Calculate the sum of the grademax's of all the items within this category.
1262         $totalnonoverriddengrademax = 0;
1263         $totalgrademax = 0;
1265         // Out of 1, how much weight has been manually overriden by a user?
1266         $totaloverriddenweight  = 0;
1267         $totaloverriddengrademax  = 0;
1269         // Has every assessment in this category been overridden?
1270         $automaticgradeitemspresent = false;
1271         // Does the grade item require normalising?
1272         $requiresnormalising = false;
1274         // This array keeps track of the id and weight of every grade item that has been overridden.
1275         $overridearray = array();
1276         foreach ($children as $sortorder => $child) {
1277             $gradeitem = null;
1279             if ($child['type'] == 'item') {
1280                 $gradeitem = $child['object'];
1281             } else if ($child['type'] == 'category') {
1282                 $gradeitem = $child['object']->load_grade_item();
1283             }
1285             // Record the ID and the weight for this grade item.
1286             $overridearray[$gradeitem->id] = array();
1287             $overridearray[$gradeitem->id]['extracredit'] = intval($gradeitem->aggregationcoef);
1288             $overridearray[$gradeitem->id]['weight'] = $gradeitem->aggregationcoef2;
1289             $overridearray[$gradeitem->id]['weightoverride'] = intval($gradeitem->weightoverride);
1290             // If this item has had its weight overridden then set the flag to true, but
1291             // only if all previous items were also overridden. Note that extra credit items
1292             // are counted as overridden grade items.
1293             if (!$gradeitem->weightoverride && $gradeitem->aggregationcoef == 0) {
1294                 $automaticgradeitemspresent = true;
1295             }
1297             if ($gradeitem->aggregationcoef > 0) {
1298                 // An extra credit grade item doesn't contribute to $totaloverriddengrademax.
1299                 continue;
1300             } else if ($gradeitem->weightoverride > 0 && $gradeitem->aggregationcoef2 <= 0) {
1301                 // An overriden item that defines a weight of 0 does not contribute to $totaloverriddengrademax.
1302                 continue;
1303             }
1305             $totalgrademax += $gradeitem->grademax;
1306             if ($gradeitem->weightoverride > 0) {
1307                 $totaloverriddenweight += $gradeitem->aggregationcoef2;
1308                 $totaloverriddengrademax += $gradeitem->grademax;
1309             }
1310         }
1312         // Initialise this variable (used to keep track of the weight override total).
1313         $normalisetotal = 0;
1314         // Keep a record of how much the override total is to see if it is above 100. It it is then we need to set the
1315         // other weights to zero and normalise the others.
1316         $overriddentotal = 0;
1317         // If the overridden weight total is higher than 1 then set the other untouched weights to zero.
1318         $setotherweightstozero = false;
1319         // Total up all of the weights.
1320         foreach ($overridearray as $gradeitemdetail) {
1321             // If the grade item has extra credit, then don't add it to the normalisetotal.
1322             if (!$gradeitemdetail['extracredit']) {
1323                 $normalisetotal += $gradeitemdetail['weight'];
1324             }
1325             if ($gradeitemdetail['weightoverride'] && !$gradeitemdetail['extracredit']) {
1326                 // Add overriden weights up to see if they are greater than 1.
1327                 $overriddentotal += $gradeitemdetail['weight'];
1328             }
1329         }
1330         if ($overriddentotal > 1) {
1331             // Make sure that this catergory of weights gets normalised.
1332             $requiresnormalising = true;
1333             // The normalised weights are only the overridden weights, so we just use the total of those.
1334             $normalisetotal = $overriddentotal;
1335         }
1337         $totalnonoverriddengrademax = $totalgrademax - $totaloverriddengrademax;
1339         reset($children);
1340         foreach ($children as $sortorder => $child) {
1341             $gradeitem = null;
1343             if ($child['type'] == 'item') {
1344                 $gradeitem = $child['object'];
1345             } else if ($child['type'] == 'category') {
1346                 $gradeitem = $child['object']->load_grade_item();
1347             }
1349             if (!$gradeitem->weightoverride) {
1350                 // Calculations with a grade maximum of zero will cause problems. Just set the weight to zero.
1351                 if ($totaloverriddenweight >= 1 || $totalnonoverriddengrademax == 0 || $gradeitem->grademax == 0) {
1352                     // There is no more weight to distribute.
1353                     $gradeitem->aggregationcoef2 = 0;
1354                 } else {
1355                     // Calculate this item's weight as a percentage of the non-overridden total grade maxes
1356                     // then convert it to a proportion of the available non-overriden weight.
1357                     $gradeitem->aggregationcoef2 = ($gradeitem->grademax/$totalnonoverriddengrademax) *
1358                             (1 - $totaloverriddenweight);
1359                 }
1360                 $gradeitem->update();
1361             } else if ((!$automaticgradeitemspresent && $normalisetotal != 1) || ($requiresnormalising)) {
1362                 // Just divide the overriden weight for this item against the total weight override of all
1363                 // items in this category.
1364                 if ($normalisetotal == 0) {
1365                     $gradeitem->aggregationcoef2 = 0;
1366                 } else {
1367                     $gradeitem->aggregationcoef2 = $overridearray[$gradeitem->id]['weight'] / $normalisetotal;
1368                 }
1369                 // Update the grade item to reflect these changes.
1370                 $gradeitem->update();
1371             }
1372         }
1373     }
1375     /**
1376      * Given an array of grade values (numerical indices) applies droplow or keephigh rules to limit the final array.
1377      *
1378      * @param array $grade_values itemid=>$grade_value float
1379      * @param array $items grade item objects
1380      * @return array Limited grades.
1381      */
1382     public function apply_limit_rules(&$grade_values, $items) {
1383         $extraused = $this->is_extracredit_used();
1385         if (!empty($this->droplow)) {
1386             asort($grade_values, SORT_NUMERIC);
1387             $dropped = 0;
1389             // If we have fewer grade items available to drop than $this->droplow, use this flag to escape the loop
1390             // May occur because of "extra credit" or if droplow is higher than the number of grade items
1391             $droppedsomething = true;
1393             while ($dropped < $this->droplow && $droppedsomething) {
1394                 $droppedsomething = false;
1396                 $grade_keys = array_keys($grade_values);
1397                 $gradekeycount = count($grade_keys);
1399                 if ($gradekeycount === 0) {
1400                     //We've dropped all grade items
1401                     break;
1402                 }
1404                 $originalindex = $founditemid = $foundmax = null;
1406                 // Find the first remaining grade item that is available to be dropped
1407                 foreach ($grade_keys as $gradekeyindex=>$gradekey) {
1408                     if (!$extraused || $items[$gradekey]->aggregationcoef <= 0) {
1409                         // Found a non-extra credit grade item that is eligible to be dropped
1410                         $originalindex = $gradekeyindex;
1411                         $founditemid = $grade_keys[$originalindex];
1412                         $foundmax = $items[$founditemid]->grademax;
1413                         break;
1414                     }
1415                 }
1417                 if (empty($founditemid)) {
1418                     // No grade items available to drop
1419                     break;
1420                 }
1422                 // Now iterate over the remaining grade items
1423                 // We're looking for other grade items with the same grade value but a higher grademax
1424                 $i = 1;
1425                 while ($originalindex + $i < $gradekeycount) {
1427                     $possibleitemid = $grade_keys[$originalindex+$i];
1428                     $i++;
1430                     if ($grade_values[$founditemid] != $grade_values[$possibleitemid]) {
1431                         // The next grade item has a different grade value. Stop looking.
1432                         break;
1433                     }
1435                     if ($extraused && $items[$possibleitemid]->aggregationcoef > 0) {
1436                         // Don't drop extra credit grade items. Continue the search.
1437                         continue;
1438                     }
1440                     if ($foundmax < $items[$possibleitemid]->grademax) {
1441                         // Found a grade item with the same grade value and a higher grademax
1442                         $foundmax = $items[$possibleitemid]->grademax;
1443                         $founditemid = $possibleitemid;
1444                         // Continue searching to see if there is an even higher grademax
1445                     }
1446                 }
1448                 // Now drop whatever grade item we have found
1449                 unset($grade_values[$founditemid]);
1450                 $dropped++;
1451                 $droppedsomething = true;
1452             }
1454         } else if (!empty($this->keephigh)) {
1455             arsort($grade_values, SORT_NUMERIC);
1456             $kept = 0;
1458             foreach ($grade_values as $itemid=>$value) {
1460                 if ($extraused and $items[$itemid]->aggregationcoef > 0) {
1461                     // we keep all extra credits
1463                 } else if ($kept < $this->keephigh) {
1464                     $kept++;
1466                 } else {
1467                     unset($grade_values[$itemid]);
1468                 }
1469             }
1470         }
1471     }
1473     /**
1474      * Returns whether or not we can apply the limit rules.
1475      *
1476      * There are cases where drop lowest or keep highest should not be used
1477      * at all. This method will determine whether or not this logic can be
1478      * applied considering the current setup of the category.
1479      *
1480      * @return bool
1481      */
1482     public function can_apply_limit_rules() {
1483         if ($this->canapplylimitrules !== null) {
1484             return $this->canapplylimitrules;
1485         }
1487         // Set it to be supported by default.
1488         $this->canapplylimitrules = true;
1490         // Natural aggregation.
1491         if ($this->aggregation == GRADE_AGGREGATE_SUM) {
1492             $canapply = true;
1494             // Check until one child breaks the rules.
1495             $gradeitems = $this->get_children();
1496             $validitems = 0;
1497             $lastweight = null;
1498             $lastmaxgrade = null;
1499             foreach ($gradeitems as $gradeitem) {
1500                 $gi = $gradeitem['object'];
1502                 if ($gradeitem['type'] == 'category') {
1503                     // Sub categories are not allowed because they can have dynamic weights/maxgrades.
1504                     $canapply = false;
1505                     break;
1506                 }
1508                 if ($gi->aggregationcoef > 0) {
1509                     // Extra credit items are not allowed.
1510                     $canapply = false;
1511                     break;
1512                 }
1514                 if ($lastweight !== null && $lastweight != $gi->aggregationcoef2) {
1515                     // One of the weight differs from another item.
1516                     $canapply = false;
1517                     break;
1518                 }
1520                 if ($lastmaxgrade !== null && $lastmaxgrade != $gi->grademax) {
1521                     // One of the max grade differ from another item. This is not allowed for now
1522                     // because we could be end up with different max grade between users for this category.
1523                     $canapply = false;
1524                     break;
1525                 }
1527                 $lastweight = $gi->aggregationcoef2;
1528                 $lastmaxgrade = $gi->grademax;
1529             }
1531             $this->canapplylimitrules = $canapply;
1532         }
1534         return $this->canapplylimitrules;
1535     }
1537     /**
1538      * Returns true if category uses extra credit of any kind
1539      *
1540      * @return bool True if extra credit used
1541      */
1542     public function is_extracredit_used() {
1543         return self::aggregation_uses_extracredit($this->aggregation);
1544     }
1546     /**
1547      * Returns true if aggregation passed is using extracredit.
1548      *
1549      * @param int $aggregation Aggregation const.
1550      * @return bool True if extra credit used
1551      */
1552     public static function aggregation_uses_extracredit($aggregation) {
1553         return ($aggregation == GRADE_AGGREGATE_WEIGHTED_MEAN2
1554              or $aggregation == GRADE_AGGREGATE_EXTRACREDIT_MEAN
1555              or $aggregation == GRADE_AGGREGATE_SUM);
1556     }
1558     /**
1559      * Returns true if category uses special aggregation coefficient
1560      *
1561      * @return bool True if an aggregation coefficient is being used
1562      */
1563     public function is_aggregationcoef_used() {
1564         return self::aggregation_uses_aggregationcoef($this->aggregation);
1566     }
1568     /**
1569      * Returns true if aggregation uses aggregationcoef
1570      *
1571      * @param int $aggregation Aggregation const.
1572      * @return bool True if an aggregation coefficient is being used
1573      */
1574     public static function aggregation_uses_aggregationcoef($aggregation) {
1575         return ($aggregation == GRADE_AGGREGATE_WEIGHTED_MEAN
1576              or $aggregation == GRADE_AGGREGATE_WEIGHTED_MEAN2
1577              or $aggregation == GRADE_AGGREGATE_EXTRACREDIT_MEAN
1578              or $aggregation == GRADE_AGGREGATE_SUM);
1580     }
1582     /**
1583      * Recursive function to find which weight/extra credit field to use in the grade item form.
1584      *
1585      * Inherits from a parent category if that category has aggregatesubcats set to true.
1586      *
1587      * @param string $first Whether or not this is the first item in the recursion
1588      * @return string
1589      */
1590     public function get_coefstring($first=true) {
1591         if (!is_null($this->coefstring)) {
1592             return $this->coefstring;
1593         }
1595         $overriding_coefstring = null;
1597         // Stop recursing upwards if this category aggregates subcats or has no parent
1598         if (!$first && !$this->aggregatesubcats) {
1600             if ($parent_category = $this->load_parent_category()) {
1601                 return $parent_category->get_coefstring(false);
1603             } else {
1604                 return null;
1605             }
1607         } else if ($first) {
1609             if (!$this->aggregatesubcats) {
1611                 if ($parent_category = $this->load_parent_category()) {
1612                     $overriding_coefstring = $parent_category->get_coefstring(false);
1613                 }
1614             }
1615         }
1617         // If an overriding coefstring has trickled down from one of the parent categories, return it. Otherwise, return self.
1618         if (!is_null($overriding_coefstring)) {
1619             return $overriding_coefstring;
1620         }
1622         // No parent category is overriding this category's aggregation, return its string
1623         if ($this->aggregation == GRADE_AGGREGATE_WEIGHTED_MEAN) {
1624             $this->coefstring = 'aggregationcoefweight';
1626         } else if ($this->aggregation == GRADE_AGGREGATE_WEIGHTED_MEAN2) {
1627             $this->coefstring = 'aggregationcoefextrasum';
1629         } else if ($this->aggregation == GRADE_AGGREGATE_EXTRACREDIT_MEAN) {
1630             $this->coefstring = 'aggregationcoefextraweight';
1632         } else if ($this->aggregation == GRADE_AGGREGATE_SUM) {
1633             $this->coefstring = 'aggregationcoefextraweightsum';
1635         } else {
1636             $this->coefstring = 'aggregationcoef';
1637         }
1638         return $this->coefstring;
1639     }
1641     /**
1642      * Returns tree with all grade_items and categories as elements
1643      *
1644      * @param int $courseid The course ID
1645      * @param bool $include_category_items as category children
1646      * @return array
1647      */
1648     public static function fetch_course_tree($courseid, $include_category_items=false) {
1649         $course_category = grade_category::fetch_course_category($courseid);
1650         $category_array = array('object'=>$course_category, 'type'=>'category', 'depth'=>1,
1651                                 'children'=>$course_category->get_children($include_category_items));
1653         $course_category->sortorder = $course_category->get_sortorder();
1654         $sortorder = $course_category->get_sortorder();
1655         return grade_category::_fetch_course_tree_recursion($category_array, $sortorder);
1656     }
1658     /**
1659      * An internal function that recursively sorts grade categories within a course
1660      *
1661      * @param array $category_array The seed of the recursion
1662      * @param int   $sortorder The current sortorder
1663      * @return array An array containing 'object', 'type', 'depth' and optionally 'children'
1664      */
1665     static private function _fetch_course_tree_recursion($category_array, &$sortorder) {
1666         // update the sortorder in db if needed
1667         //NOTE: This leads to us resetting sort orders every time the categories and items page is viewed :(
1668         //if ($category_array['object']->sortorder != $sortorder) {
1669             //$category_array['object']->set_sortorder($sortorder);
1670         //}
1672         if (isset($category_array['object']->gradetype) && $category_array['object']->gradetype==GRADE_TYPE_NONE) {
1673             return null;
1674         }
1676         // store the grade_item or grade_category instance with extra info
1677         $result = array('object'=>$category_array['object'], 'type'=>$category_array['type'], 'depth'=>$category_array['depth']);
1679         // reuse final grades if there
1680         if (array_key_exists('finalgrades', $category_array)) {
1681             $result['finalgrades'] = $category_array['finalgrades'];
1682         }
1684         // recursively resort children
1685         if (!empty($category_array['children'])) {
1686             $result['children'] = array();
1687             //process the category item first
1688             $child = null;
1690             foreach ($category_array['children'] as $oldorder=>$child_array) {
1692                 if ($child_array['type'] == 'courseitem' or $child_array['type'] == 'categoryitem') {
1693                     $child = grade_category::_fetch_course_tree_recursion($child_array, $sortorder);
1694                     if (!empty($child)) {
1695                         $result['children'][$sortorder] = $child;
1696                     }
1697                 }
1698             }
1700             foreach ($category_array['children'] as $oldorder=>$child_array) {
1702                 if ($child_array['type'] != 'courseitem' and $child_array['type'] != 'categoryitem') {
1703                     $child = grade_category::_fetch_course_tree_recursion($child_array, $sortorder);
1704                     if (!empty($child)) {
1705                         $result['children'][++$sortorder] = $child;
1706                     }
1707                 }
1708             }
1709         }
1711         return $result;
1712     }
1714     /**
1715      * Fetches and returns all the children categories and/or grade_items belonging to this category.
1716      * By default only returns the immediate children (depth=1), but deeper levels can be requested,
1717      * as well as all levels (0). The elements are indexed by sort order.
1718      *
1719      * @param bool $include_category_items Whether or not to include category grade_items in the children array
1720      * @return array Array of child objects (grade_category and grade_item).
1721      */
1722     public function get_children($include_category_items=false) {
1723         global $DB;
1725         // This function must be as fast as possible ;-)
1726         // fetch all course grade items and categories into memory - we do not expect hundreds of these in course
1727         // we have to limit the number of queries though, because it will be used often in grade reports
1729         $cats  = $DB->get_records('grade_categories', array('courseid' => $this->courseid));
1730         $items = $DB->get_records('grade_items', array('courseid' => $this->courseid));
1732         // init children array first
1733         foreach ($cats as $catid=>$cat) {
1734             $cats[$catid]->children = array();
1735         }
1737         //first attach items to cats and add category sortorder
1738         foreach ($items as $item) {
1740             if ($item->itemtype == 'course' or $item->itemtype == 'category') {
1741                 $cats[$item->iteminstance]->sortorder = $item->sortorder;
1743                 if (!$include_category_items) {
1744                     continue;
1745                 }
1746                 $categoryid = $item->iteminstance;
1748             } else {
1749                 $categoryid = $item->categoryid;
1750                 if (empty($categoryid)) {
1751                     debugging('Found a grade item that isnt in a category');
1752                 }
1753             }
1755             // prevent problems with duplicate sortorders in db
1756             $sortorder = $item->sortorder;
1758             while (array_key_exists($categoryid, $cats)
1759                 && array_key_exists($sortorder, $cats[$categoryid]->children)) {
1761                 $sortorder++;
1762             }
1764             $cats[$categoryid]->children[$sortorder] = $item;
1766         }
1768         // now find the requested category and connect categories as children
1769         $category = false;
1771         foreach ($cats as $catid=>$cat) {
1773             if (empty($cat->parent)) {
1775                 if ($cat->path !== '/'.$cat->id.'/') {
1776                     $grade_category = new grade_category($cat, false);
1777                     $grade_category->path  = '/'.$cat->id.'/';
1778                     $grade_category->depth = 1;
1779                     $grade_category->update('system');
1780                     return $this->get_children($include_category_items);
1781                 }
1783             } else {
1785                 if (empty($cat->path) or !preg_match('|/'.$cat->parent.'/'.$cat->id.'/$|', $cat->path)) {
1786                     //fix paths and depts
1787                     static $recursioncounter = 0; // prevents infinite recursion
1788                     $recursioncounter++;
1790                     if ($recursioncounter < 5) {
1791                         // fix paths and depths!
1792                         $grade_category = new grade_category($cat, false);
1793                         $grade_category->depth = 0;
1794                         $grade_category->path  = null;
1795                         $grade_category->update('system');
1796                         return $this->get_children($include_category_items);
1797                     }
1798                 }
1799                 // prevent problems with duplicate sortorders in db
1800                 $sortorder = $cat->sortorder;
1802                 while (array_key_exists($sortorder, $cats[$cat->parent]->children)) {
1803                     //debugging("$sortorder exists in cat loop");
1804                     $sortorder++;
1805                 }
1807                 $cats[$cat->parent]->children[$sortorder] = &$cats[$catid];
1808             }
1810             if ($catid == $this->id) {
1811                 $category = &$cats[$catid];
1812             }
1813         }
1815         unset($items); // not needed
1816         unset($cats); // not needed
1818         $children_array = grade_category::_get_children_recursion($category);
1820         ksort($children_array);
1822         return $children_array;
1824     }
1826     /**
1827      * Private method used to retrieve all children of this category recursively
1828      *
1829      * @param grade_category $category Source of current recursion
1830      * @return array An array of child grade categories
1831      */
1832     private static function _get_children_recursion($category) {
1834         $children_array = array();
1835         foreach ($category->children as $sortorder=>$child) {
1837             if (array_key_exists('itemtype', $child)) {
1838                 $grade_item = new grade_item($child, false);
1840                 if (in_array($grade_item->itemtype, array('course', 'category'))) {
1841                     $type  = $grade_item->itemtype.'item';
1842                     $depth = $category->depth;
1844                 } else {
1845                     $type  = 'item';
1846                     $depth = $category->depth; // we use this to set the same colour
1847                 }
1848                 $children_array[$sortorder] = array('object'=>$grade_item, 'type'=>$type, 'depth'=>$depth);
1850             } else {
1851                 $children = grade_category::_get_children_recursion($child);
1852                 $grade_category = new grade_category($child, false);
1854                 if (empty($children)) {
1855                     $children = array();
1856                 }
1857                 $children_array[$sortorder] = array('object'=>$grade_category, 'type'=>'category', 'depth'=>$grade_category->depth, 'children'=>$children);
1858             }
1859         }
1861         // sort the array
1862         ksort($children_array);
1864         return $children_array;
1865     }
1867     /**
1868      * Uses {@link get_grade_item()} to load or create a grade_item, then saves it as $this->grade_item.
1869      *
1870      * @return grade_item
1871      */
1872     public function load_grade_item() {
1873         if (empty($this->grade_item)) {
1874             $this->grade_item = $this->get_grade_item();
1875         }
1876         return $this->grade_item;
1877     }
1879     /**
1880      * Retrieves this grade categories' associated grade_item from the database
1881      *
1882      * If no grade_item exists yet, creates one.
1883      *
1884      * @return grade_item
1885      */
1886     public function get_grade_item() {
1887         if (empty($this->id)) {
1888             debugging("Attempt to obtain a grade_category's associated grade_item without the category's ID being set.");
1889             return false;
1890         }
1892         if (empty($this->parent)) {
1893             $params = array('courseid'=>$this->courseid, 'itemtype'=>'course', 'iteminstance'=>$this->id);
1895         } else {
1896             $params = array('courseid'=>$this->courseid, 'itemtype'=>'category', 'iteminstance'=>$this->id);
1897         }
1899         if (!$grade_items = grade_item::fetch_all($params)) {
1900             // create a new one
1901             $grade_item = new grade_item($params, false);
1902             $grade_item->gradetype = GRADE_TYPE_VALUE;
1903             $grade_item->insert('system');
1905         } else if (count($grade_items) == 1) {
1906             // found existing one
1907             $grade_item = reset($grade_items);
1909         } else {
1910             debugging("Found more than one grade_item attached to category id:".$this->id);
1911             // return first one
1912             $grade_item = reset($grade_items);
1913         }
1915         return $grade_item;
1916     }
1918     /**
1919      * Uses $this->parent to instantiate $this->parent_category based on the referenced record in the DB
1920      *
1921      * @return grade_category The parent category
1922      */
1923     public function load_parent_category() {
1924         if (empty($this->parent_category) && !empty($this->parent)) {
1925             $this->parent_category = $this->get_parent_category();
1926         }
1927         return $this->parent_category;
1928     }
1930     /**
1931      * Uses $this->parent to instantiate and return a grade_category object
1932      *
1933      * @return grade_category Returns the parent category or null if this category has no parent
1934      */
1935     public function get_parent_category() {
1936         if (!empty($this->parent)) {
1937             $parent_category = new grade_category(array('id' => $this->parent));
1938             return $parent_category;
1939         } else {
1940             return null;
1941         }
1942     }
1944     /**
1945      * Returns the most descriptive field for this grade category
1946      *
1947      * @return string name
1948      */
1949     public function get_name() {
1950         global $DB;
1951         // For a course category, we return the course name if the fullname is set to '?' in the DB (empty in the category edit form)
1952         if (empty($this->parent) && $this->fullname == '?') {
1953             $course = $DB->get_record('course', array('id'=> $this->courseid));
1954             return format_string($course->fullname);
1956         } else {
1957             return $this->fullname;
1958         }
1959     }
1961     /**
1962      * Describe the aggregation settings for this category so the reports make more sense.
1963      *
1964      * @return string description
1965      */
1966     public function get_description() {
1967         $allhelp = array();
1968         $aggrstrings = grade_helper::get_aggregation_strings();
1969         $allhelp[] = $aggrstrings[$this->aggregation];
1971         if ($this->droplow && $this->can_apply_limit_rules()) {
1972             $allhelp[] = get_string('droplowestvalues', 'grades', $this->droplow);
1973         }
1974         if ($this->keephigh && $this->can_apply_limit_rules()) {
1975             $allhelp[] = get_string('keephighestvalues', 'grades', $this->keephigh);
1976         }
1977         if (!$this->aggregateonlygraded) {
1978             $allhelp[] = get_string('aggregatenotonlygraded', 'grades');
1979         }
1980         if ($this->aggregatesubcats) {
1981             $allhelp[] = get_string('aggregatesubcatsshort', 'grades');
1982         }
1983         return implode('. ', $allhelp) . '.';
1984     }
1986     /**
1987      * Sets this category's parent id
1988      *
1989      * @param int $parentid The ID of the category that is the new parent to $this
1990      * @param string $source From where was the object updated (mod/forum, manual, etc.)
1991      * @return bool success
1992      */
1993     public function set_parent($parentid, $source=null) {
1994         if ($this->parent == $parentid) {
1995             return true;
1996         }
1998         if ($parentid == $this->id) {
1999             print_error('cannotassignselfasparent');
2000         }
2002         if (empty($this->parent) and $this->is_course_category()) {
2003             print_error('cannothaveparentcate');
2004         }
2006         // find parent and check course id
2007         if (!$parent_category = grade_category::fetch(array('id'=>$parentid, 'courseid'=>$this->courseid))) {
2008             return false;
2009         }
2011         $this->force_regrading();
2013         // set new parent category
2014         $this->parent          = $parent_category->id;
2015         $this->parent_category =& $parent_category;
2016         $this->path            = null;       // remove old path and depth - will be recalculated in update()
2017         $this->depth           = 0;          // remove old path and depth - will be recalculated in update()
2018         $this->update($source);
2020         return $this->update($source);
2021     }
2023     /**
2024      * Returns the final grade values for this grade category.
2025      *
2026      * @param int $userid Optional user ID to retrieve a single user's final grade
2027      * @return mixed An array of all final_grades (stdClass objects) for this grade_item, or a single final_grade.
2028      */
2029     public function get_final($userid=null) {
2030         $this->load_grade_item();
2031         return $this->grade_item->get_final($userid);
2032     }
2034     /**
2035      * Returns the sortorder of the grade categories' associated grade_item
2036      *
2037      * This method is also available in grade_item for cases where the object type is not known.
2038      *
2039      * @return int Sort order
2040      */
2041     public function get_sortorder() {
2042         $this->load_grade_item();
2043         return $this->grade_item->get_sortorder();
2044     }
2046     /**
2047      * Returns the idnumber of the grade categories' associated grade_item.
2048      *
2049      * This method is also available in grade_item for cases where the object type is not known.
2050      *
2051      * @return string idnumber
2052      */
2053     public function get_idnumber() {
2054         $this->load_grade_item();
2055         return $this->grade_item->get_idnumber();
2056     }
2058     /**
2059      * Sets the sortorder variable for this category.
2060      *
2061      * This method is also available in grade_item, for cases where the object type is not know.
2062      *
2063      * @param int $sortorder The sortorder to assign to this category
2064      */
2065     public function set_sortorder($sortorder) {
2066         $this->load_grade_item();
2067         $this->grade_item->set_sortorder($sortorder);
2068     }
2070     /**
2071      * Move this category after the given sortorder
2072      *
2073      * Does not change the parent
2074      *
2075      * @param int $sortorder to place after.
2076      * @return void
2077      */
2078     public function move_after_sortorder($sortorder) {
2079         $this->load_grade_item();
2080         $this->grade_item->move_after_sortorder($sortorder);
2081     }
2083     /**
2084      * Return true if this is the top most category that represents the total course grade.
2085      *
2086      * @return bool
2087      */
2088     public function is_course_category() {
2089         $this->load_grade_item();
2090         return $this->grade_item->is_course_item();
2091     }
2093     /**
2094      * Return the course level grade_category object
2095      *
2096      * @param int $courseid The Course ID
2097      * @return grade_category Returns the course level grade_category instance
2098      */
2099     public static function fetch_course_category($courseid) {
2100         if (empty($courseid)) {
2101             debugging('Missing course id!');
2102             return false;
2103         }
2105         // course category has no parent
2106         if ($course_category = grade_category::fetch(array('courseid'=>$courseid, 'parent'=>null))) {
2107             return $course_category;
2108         }
2110         // create a new one
2111         $course_category = new grade_category();
2112         $course_category->insert_course_category($courseid);
2114         return $course_category;
2115     }
2117     /**
2118      * Is grading object editable?
2119      *
2120      * @return bool
2121      */
2122     public function is_editable() {
2123         return true;
2124     }
2126     /**
2127      * Returns the locked state/date of the grade categories' associated grade_item.
2128      *
2129      * This method is also available in grade_item, for cases where the object type is not known.
2130      *
2131      * @return bool
2132      */
2133     public function is_locked() {
2134         $this->load_grade_item();
2135         return $this->grade_item->is_locked();
2136     }
2138     /**
2139      * Sets the grade_item's locked variable and updates the grade_item.
2140      *
2141      * Calls set_locked() on the categories' grade_item
2142      *
2143      * @param int  $lockedstate 0, 1 or a timestamp int(10) after which date the item will be locked.
2144      * @param bool $cascade lock/unlock child objects too
2145      * @param bool $refresh refresh grades when unlocking
2146      * @return bool success if category locked (not all children mayb be locked though)
2147      */
2148     public function set_locked($lockedstate, $cascade=false, $refresh=true) {
2149         $this->load_grade_item();
2151         $result = $this->grade_item->set_locked($lockedstate, $cascade, true);
2153         if ($cascade) {
2154             //process all children - items and categories
2155             if ($children = grade_item::fetch_all(array('categoryid'=>$this->id))) {
2157                 foreach ($children as $child) {
2158                     $child->set_locked($lockedstate, true, false);
2160                     if (empty($lockedstate) and $refresh) {
2161                         //refresh when unlocking
2162                         $child->refresh_grades();
2163                     }
2164                 }
2165             }
2167             if ($children = grade_category::fetch_all(array('parent'=>$this->id))) {
2169                 foreach ($children as $child) {
2170                     $child->set_locked($lockedstate, true, true);
2171                 }
2172             }
2173         }
2175         return $result;
2176     }
2178     /**
2179      * Overrides grade_object::set_properties() to add special handling for changes to category aggregation types
2180      *
2181      * @param stdClass $instance the object to set the properties on
2182      * @param array|stdClass $params Either an associative array or an object containing property name, property value pairs
2183      */
2184     public static function set_properties(&$instance, $params) {
2185         global $DB;
2187         parent::set_properties($instance, $params);
2189         //if they've changed aggregation type we made need to do some fiddling to provide appropriate defaults
2190         if (!empty($params->aggregation)) {
2192             //weight and extra credit share a column :( Would like a default of 1 for weight and 0 for extra credit
2193             //Flip from the default of 0 to 1 (or vice versa) if ALL items in the category are still set to the old default.
2194             if (self::aggregation_uses_aggregationcoef($params->aggregation)) {
2195                 $sql = $defaultaggregationcoef = null;
2197                 if (!self::aggregation_uses_extracredit($params->aggregation)) {
2198                     //if all items in this category have aggregation coefficient of 0 we can change it to 1 ie evenly weighted
2199                     $sql = "select count(id) from {grade_items} where categoryid=:categoryid and aggregationcoef!=0";
2200                     $defaultaggregationcoef = 1;
2201                 } else {
2202                     //if all items in this category have aggregation coefficient of 1 we can change it to 0 ie no extra credit
2203                     $sql = "select count(id) from {grade_items} where categoryid=:categoryid and aggregationcoef!=1";
2204                     $defaultaggregationcoef = 0;
2205                 }
2207                 $params = array('categoryid'=>$instance->id);
2208                 $count = $DB->count_records_sql($sql, $params);
2209                 if ($count===0) { //category is either empty or all items are set to a default value so we can switch defaults
2210                     $params['aggregationcoef'] = $defaultaggregationcoef;
2211                     $DB->execute("update {grade_items} set aggregationcoef=:aggregationcoef where categoryid=:categoryid",$params);
2212                 }
2213             }
2214         }
2215     }
2217     /**
2218      * Sets the grade_item's hidden variable and updates the grade_item.
2219      *
2220      * Overrides grade_item::set_hidden() to add cascading of the hidden value to grade items in this grade category
2221      *
2222      * @param int $hidden 0 mean always visible, 1 means always hidden and a number > 1 is a timestamp to hide until
2223      * @param bool $cascade apply to child objects too
2224      */
2225     public function set_hidden($hidden, $cascade=false) {
2226         $this->load_grade_item();
2227         //this hides the associated grade item (the course total)
2228         $this->grade_item->set_hidden($hidden, $cascade);
2229         //this hides the category itself and everything it contains
2230         parent::set_hidden($hidden, $cascade);
2232         if ($cascade) {
2234             if ($children = grade_item::fetch_all(array('categoryid'=>$this->id))) {
2236                 foreach ($children as $child) {
2237                     if ($child->can_control_visibility()) {
2238                         $child->set_hidden($hidden, $cascade);
2239                     }
2240                 }
2241             }
2243             if ($children = grade_category::fetch_all(array('parent'=>$this->id))) {
2245                 foreach ($children as $child) {
2246                     $child->set_hidden($hidden, $cascade);
2247                 }
2248             }
2249         }
2251         //if marking category visible make sure parent category is visible MDL-21367
2252         if( !$hidden ) {
2253             $category_array = grade_category::fetch_all(array('id'=>$this->parent));
2254             if ($category_array && array_key_exists($this->parent, $category_array)) {
2255                 $category = $category_array[$this->parent];
2256                 //call set_hidden on the category regardless of whether it is hidden as its parent might be hidden
2257                 //if($category->is_hidden()) {
2258                     $category->set_hidden($hidden, false);
2259                 //}
2260             }
2261         }
2262     }
2264     /**
2265      * Applies default settings on this category
2266      *
2267      * @return bool True if anything changed
2268      */
2269     public function apply_default_settings() {
2270         global $CFG;
2272         foreach ($this->forceable as $property) {
2274             if (isset($CFG->{"grade_$property"})) {
2276                 if ($CFG->{"grade_$property"} == -1) {
2277                     continue; //temporary bc before version bump
2278                 }
2279                 $this->$property = $CFG->{"grade_$property"};
2280             }
2281         }
2282     }
2284     /**
2285      * Applies forced settings on this category
2286      *
2287      * @return bool True if anything changed
2288      */
2289     public function apply_forced_settings() {
2290         global $CFG;
2292         $updated = false;
2294         foreach ($this->forceable as $property) {
2296             if (isset($CFG->{"grade_$property"}) and isset($CFG->{"grade_{$property}_flag"}) and
2297                                                     ((int) $CFG->{"grade_{$property}_flag"} & 1)) {
2299                 if ($CFG->{"grade_$property"} == -1) {
2300                     continue; //temporary bc before version bump
2301                 }
2302                 $this->$property = $CFG->{"grade_$property"};
2303                 $updated = true;
2304             }
2305         }
2307         return $updated;
2308     }
2310     /**
2311      * Notification of change in forced category settings.
2312      *
2313      * Causes all course and category grade items to be marked as needing to be updated
2314      */
2315     public static function updated_forced_settings() {
2316         global $CFG, $DB;
2317         $params = array(1, 'course', 'category');
2318         $sql = "UPDATE {grade_items} SET needsupdate=? WHERE itemtype=? or itemtype=?";
2319         $DB->execute($sql, $params);
2320     }