Merge branch 'MDL-47463-master' of git://github.com/FMCorz/moodle
[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_SUM;
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->timemodified = time();
632                 $success = $grade->update('aggregation');
634                 // If successful trigger a user_graded event.
635                 if ($success) {
636                     \core\event\user_graded::create_from_grade($grade)->trigger();
637                 }
638             }
639             $dropped = $grade_values;
640             $this->set_usedinaggregation($userid, $usedweights, $novalue, $dropped, $extracredit);
641             return;
642         }
644         // Normalize the grades first - all will have value 0...1
645         // ungraded items are not used in aggregation.
646         foreach ($grade_values as $itemid=>$v) {
647             if (is_null($v)) {
648                 // If null, it means no grade.
649                 if ($this->aggregateonlygraded) {
650                     unset($grade_values[$itemid]);
651                     // Mark this item as "excluded empty" because it has no grade.
652                     $novalue[$itemid] = 0;
653                     continue;
654                 }
655             }
656             if (in_array($itemid, $excluded)) {
657                 unset($grade_values[$itemid]);
658                 $dropped[$itemid] = 0;
659                 continue;
660             }
661             // Check for user specific grade min/max overrides.
662             $usergrademin = $items[$itemid]->grademin;
663             $usergrademax = $items[$itemid]->grademax;
664             if (isset($grademinoverrides[$itemid])) {
665                 $usergrademin = $grademinoverrides[$itemid];
666             }
667             if (isset($grademaxoverrides[$itemid])) {
668                 $usergrademax = $grademaxoverrides[$itemid];
669             }
670             if ($this->aggregation == GRADE_AGGREGATE_SUM) {
671                 // Assume that the grademin is 0 when standardising the score, to preserve negative grades.
672                 $grade_values[$itemid] = grade_grade::standardise_score($v, 0, $usergrademax, 0, 1);
673             } else {
674                 $grade_values[$itemid] = grade_grade::standardise_score($v, $usergrademin, $usergrademax, 0, 1);
675             }
677         }
679         // For items with no value, and not excluded - either set their grade to 0 or exclude them.
680         foreach ($items as $itemid=>$value) {
681             if (!isset($grade_values[$itemid]) and !in_array($itemid, $excluded)) {
682                 if (!$this->aggregateonlygraded) {
683                     $grade_values[$itemid] = 0;
684                 } else {
685                     // We are specifically marking these items as "excluded empty".
686                     $novalue[$itemid] = 0;
687                 }
688             }
689         }
691         // limit and sort
692         $allvalues = $grade_values;
693         if ($this->can_apply_limit_rules()) {
694             $this->apply_limit_rules($grade_values, $items);
695         }
697         $moredropped = array_diff($allvalues, $grade_values);
698         foreach ($moredropped as $drop => $unused) {
699             $dropped[$drop] = 0;
700         }
702         foreach ($grade_values as $itemid => $val) {
703             if (self::is_extracredit_used() && ($items[$itemid]->aggregationcoef > 0)) {
704                 $extracredit[$itemid] = 0;
705             }
706         }
708         asort($grade_values, SORT_NUMERIC);
710         // let's see we have still enough grades to do any statistics
711         if (count($grade_values) == 0) {
712             // not enough attempts yet
713             $grade->finalgrade = null;
715             if (!is_null($oldfinalgrade)) {
716                 $grade->timemodified = time();
717                 $success = $grade->update('aggregation');
719                 // If successful trigger a user_graded event.
720                 if ($success) {
721                     \core\event\user_graded::create_from_grade($grade)->trigger();
722                 }
723             }
724             $this->set_usedinaggregation($userid, $usedweights, $novalue, $dropped, $extracredit);
725             return;
726         }
728         // do the maths
729         $result = $this->aggregate_values_and_adjust_bounds($grade_values,
730                                                             $items,
731                                                             $usedweights,
732                                                             $grademinoverrides,
733                                                             $grademaxoverrides);
734         $agg_grade = $result['grade'];
736         // Set the actual grademin and max to bind the grade properly.
737         $this->grade_item->grademin = $result['grademin'];
738         $this->grade_item->grademax = $result['grademax'];
740         if ($this->aggregation == GRADE_AGGREGATE_SUM) {
741             // The natural aggregation always displays the range as coming from 0 for categories.
742             // However, when we bind the grade we allow for negative values.
743             $result['grademin'] = 0;
744         }
746         // Recalculate the grade back to requested range.
747         $finalgrade = grade_grade::standardise_score($agg_grade, 0, 1, $result['grademin'], $result['grademax']);
748         $grade->finalgrade = $this->grade_item->bounded_grade($finalgrade);
750         $oldrawgrademin = $grade->rawgrademin;
751         $oldrawgrademax = $grade->rawgrademax;
752         $grade->rawgrademin = $result['grademin'];
753         $grade->rawgrademax = $result['grademax'];
755         // Update in db if changed.
756         if (grade_floats_different($grade->finalgrade, $oldfinalgrade) ||
757                 grade_floats_different($grade->rawgrademax, $oldrawgrademax) ||
758                 grade_floats_different($grade->rawgrademin, $oldrawgrademin)) {
759             $grade->timemodified = time();
760             $success = $grade->update('aggregation');
762             // If successful trigger a user_graded event.
763             if ($success) {
764                 \core\event\user_graded::create_from_grade($grade)->trigger();
765             }
766         }
768         $this->set_usedinaggregation($userid, $usedweights, $novalue, $dropped, $extracredit);
770         return;
771     }
773     /**
774      * Set the flags on the grade_grade items to indicate how individual grades are used
775      * in the aggregation.
776      *
777      * @param int $userid The user we have aggregated the grades for.
778      * @param array $usedweights An array with keys for each of the grade_item columns included in the aggregation. The value are the relative weight.
779      * @param array $novalue An array with keys for each of the grade_item columns skipped because
780      *                       they had no value in the aggregation.
781      * @param array $dropped An array with keys for each of the grade_item columns dropped
782      *                       because of any drop lowest/highest settings in the aggregation.
783      * @param array $extracredit An array with keys for each of the grade_item columns
784      *                       considered extra credit by the aggregation.
785      */
786     private function set_usedinaggregation($userid, $usedweights, $novalue, $dropped, $extracredit) {
787         global $DB;
789         // Included.
790         if (!empty($usedweights)) {
791             // The usedweights items are updated individually to record the weights.
792             foreach ($usedweights as $gradeitemid => $contribution) {
793                 $DB->set_field_select('grade_grades',
794                                       'aggregationweight',
795                                       $contribution,
796                                       "itemid = :itemid AND userid = :userid",
797                                       array('itemid'=>$gradeitemid, 'userid'=>$userid));
798             }
800             // Now set the status flag for all these weights.
801             list($itemsql, $itemlist) = $DB->get_in_or_equal(array_keys($usedweights), SQL_PARAMS_NAMED, 'g');
802             $itemlist['userid'] = $userid;
804             $DB->set_field_select('grade_grades',
805                                   'aggregationstatus',
806                                   'used',
807                                   "itemid $itemsql AND userid = :userid",
808                                   $itemlist);
809         }
811         // No value.
812         if (!empty($novalue)) {
813             list($itemsql, $itemlist) = $DB->get_in_or_equal(array_keys($novalue), SQL_PARAMS_NAMED, 'g');
815             $itemlist['userid'] = $userid;
817             $DB->set_field_select('grade_grades',
818                                   'aggregationstatus',
819                                   'novalue',
820                                   "itemid $itemsql AND userid = :userid",
821                                   $itemlist);
822         }
824         // Dropped.
825         if (!empty($dropped)) {
826             list($itemsql, $itemlist) = $DB->get_in_or_equal(array_keys($dropped), SQL_PARAMS_NAMED, 'g');
828             $itemlist['userid'] = $userid;
830             $DB->set_field_select('grade_grades',
831                                   'aggregationstatus',
832                                   'dropped',
833                                   "itemid $itemsql AND userid = :userid",
834                                   $itemlist);
835         }
836         // Extra credit.
837         if (!empty($extracredit)) {
838             list($itemsql, $itemlist) = $DB->get_in_or_equal(array_keys($extracredit), SQL_PARAMS_NAMED, 'g');
840             $itemlist['userid'] = $userid;
842             $DB->set_field_select('grade_grades',
843                                   'aggregationstatus',
844                                   'extra',
845                                   "itemid $itemsql AND userid = :userid",
846                                   $itemlist);
847         }
848     }
850     /**
851      * Internal function that calculates the aggregated grade and new min/max for this grade category
852      *
853      * Must be public as it is used by grade_grade::get_hiding_affected()
854      *
855      * @param array $grade_values An array of values to be aggregated
856      * @param array $items The array of grade_items
857      * @since Moodle 2.6.5, 2.7.2
858      * @param array & $weights If provided, will be filled with the normalized weights
859      *                         for each grade_item as used in the aggregation.
860      *                         Some rules for the weights are:
861      *                         1. The weights must add up to 1 (unless there are extra credit)
862      *                         2. The contributed points column must add up to the course
863      *                         final grade and this column is calculated from these weights.
864      * @param array  $grademinoverrides User specific grademin values if different to the grade_item grademin (key is itemid)
865      * @param array  $grademaxoverrides User specific grademax values if different to the grade_item grademax (key is itemid)
866      * @return array containing values for:
867      *                'grade' => the new calculated grade
868      *                'grademin' => the new calculated min grade for the category
869      *                'grademax' => the new calculated max grade for the category
870      */
871     public function aggregate_values_and_adjust_bounds($grade_values,
872                                                        $items,
873                                                        & $weights = null,
874                                                        $grademinoverrides = array(),
875                                                        $grademaxoverrides = array()) {
876         $category_item = $this->get_grade_item();
877         $grademin = $category_item->grademin;
878         $grademax = $category_item->grademax;
880         switch ($this->aggregation) {
882             case GRADE_AGGREGATE_MEDIAN: // Middle point value in the set: ignores frequencies
883                 $num = count($grade_values);
884                 $grades = array_values($grade_values);
886                 // The median gets 100% - others get 0.
887                 if ($weights !== null && $num > 0) {
888                     $count = 0;
889                     foreach ($grade_values as $itemid=>$grade_value) {
890                         if (($num % 2 == 0) && ($count == intval($num/2)-1 || $count == intval($num/2))) {
891                             $weights[$itemid] = 0.5;
892                         } else if (($num % 2 != 0) && ($count == intval(($num/2)-0.5))) {
893                             $weights[$itemid] = 1.0;
894                         } else {
895                             $weights[$itemid] = 0;
896                         }
897                         $count++;
898                     }
899                 }
900                 if ($num % 2 == 0) {
901                     $agg_grade = ($grades[intval($num/2)-1] + $grades[intval($num/2)]) / 2;
902                 } else {
903                     $agg_grade = $grades[intval(($num/2)-0.5)];
904                 }
906                 break;
908             case GRADE_AGGREGATE_MIN:
909                 $agg_grade = reset($grade_values);
910                 // Record the weights as used.
911                 if ($weights !== null) {
912                     foreach ($grade_values as $itemid=>$grade_value) {
913                         $weights[$itemid] = 0;
914                     }
915                 }
916                 // Set the first item to 1.
917                 $itemids = array_keys($grade_values);
918                 $weights[reset($itemids)] = 1;
919                 break;
921             case GRADE_AGGREGATE_MAX:
922                 // Record the weights as used.
923                 if ($weights !== null) {
924                     foreach ($grade_values as $itemid=>$grade_value) {
925                         $weights[$itemid] = 0;
926                     }
927                 }
928                 // Set the last item to 1.
929                 $itemids = array_keys($grade_values);
930                 $weights[end($itemids)] = 1;
931                 $agg_grade = end($grade_values);
932                 break;
934             case GRADE_AGGREGATE_MODE:       // the most common value
935                 // array_count_values only counts INT and STRING, so if grades are floats we must convert them to string
936                 $converted_grade_values = array();
938                 foreach ($grade_values as $k => $gv) {
940                     if (!is_int($gv) && !is_string($gv)) {
941                         $converted_grade_values[$k] = (string) $gv;
943                     } else {
944                         $converted_grade_values[$k] = $gv;
945                     }
946                     if ($weights !== null) {
947                         $weights[$k] = 0;
948                     }
949                 }
951                 $freq = array_count_values($converted_grade_values);
952                 arsort($freq);                      // sort by frequency keeping keys
953                 $top = reset($freq);               // highest frequency count
954                 $modes = array_keys($freq, $top);  // search for all modes (have the same highest count)
955                 rsort($modes, SORT_NUMERIC);       // get highest mode
956                 $agg_grade = reset($modes);
957                 // Record the weights as used.
958                 if ($weights !== null && $top > 0) {
959                     foreach ($grade_values as $k => $gv) {
960                         if ($gv == $agg_grade) {
961                             $weights[$k] = 1.0 / $top;
962                         }
963                     }
964                 }
965                 break;
967             case GRADE_AGGREGATE_WEIGHTED_MEAN: // Weighted average of all existing final grades, weight specified in coef
968                 $weightsum = 0;
969                 $sum       = 0;
971                 foreach ($grade_values as $itemid=>$grade_value) {
972                     if ($weights !== null) {
973                         $weights[$itemid] = $items[$itemid]->aggregationcoef;
974                     }
975                     if ($items[$itemid]->aggregationcoef <= 0) {
976                         continue;
977                     }
978                     $weightsum += $items[$itemid]->aggregationcoef;
979                     $sum       += $items[$itemid]->aggregationcoef * $grade_value;
980                 }
981                 if ($weightsum == 0) {
982                     $agg_grade = null;
984                 } else {
985                     $agg_grade = $sum / $weightsum;
986                     if ($weights !== null) {
987                         // Normalise the weights.
988                         foreach ($weights as $itemid => $weight) {
989                             $weights[$itemid] = $weight / $weightsum;
990                         }
991                     }
993                 }
994                 break;
996             case GRADE_AGGREGATE_WEIGHTED_MEAN2:
997                 // Weighted average of all existing final grades with optional extra credit flag,
998                 // weight is the range of grade (usually grademax)
999                 $weightsum = 0;
1000                 $sum       = null;
1002                 foreach ($grade_values as $itemid=>$grade_value) {
1003                     $weight = $items[$itemid]->grademax - $items[$itemid]->grademin;
1005                     if ($weight <= 0) {
1006                         continue;
1007                     }
1009                     if ($items[$itemid]->aggregationcoef == 0) {
1010                         $weightsum += $weight;
1011                     }
1012                     $sum += $weight * $grade_value;
1013                 }
1014                 if ($weightsum == 0) {
1015                     $agg_grade = $sum; // only extra credits
1017                 } else {
1018                     $agg_grade = $sum / $weightsum;
1019                 }
1020                 // Record the weights as used.
1021                 if ($weights !== null) {
1022                     foreach ($grade_values as $itemid=>$grade_value) {
1023                         if ($weightsum > 0) {
1024                             $weight = $items[$itemid]->grademax - $items[$itemid]->grademin;
1025                             $weights[$itemid] = $weight / $weightsum;
1026                         } else {
1027                             $weights[$itemid] = 0;
1028                         }
1029                     }
1030                 }
1031                 break;
1033             case GRADE_AGGREGATE_EXTRACREDIT_MEAN: // special average
1034                 $num = 0;
1035                 $sum = null;
1037                 foreach ($grade_values as $itemid=>$grade_value) {
1039                     if ($items[$itemid]->aggregationcoef == 0) {
1040                         $num += 1;
1041                         $sum += $grade_value;
1042                         if ($weights !== null) {
1043                             $weights[$itemid] = 1;
1044                         }
1046                     } else if ($items[$itemid]->aggregationcoef > 0) {
1047                         $sum += $items[$itemid]->aggregationcoef * $grade_value;
1048                         if ($weights !== null) {
1049                             $weights[$itemid] = 1;
1050                         }
1051                     }
1052                 }
1053                 if ($weights !== null && $num > 0) {
1054                     foreach ($grade_values as $itemid=>$grade_value) {
1055                         if ($weights[$itemid]) {
1056                             $weights[$itemid] = 1.0 / $num;
1057                         }
1058                     }
1059                 }
1061                 if ($num == 0) {
1062                     $agg_grade = $sum; // only extra credits or wrong coefs
1064                 } else {
1065                     $agg_grade = $sum / $num;
1066                 }
1067                 break;
1069             case GRADE_AGGREGATE_SUM:    // Add up all the items.
1070                 $num = count($grade_values);
1071                 $sum = 0;
1072                 $sumweights = 0;
1073                 $grademin = 0;
1074                 $grademax = 0;
1075                 foreach ($grade_values as $itemid => $gradevalue) {
1076                     // We need to check if the grademax/min was adjusted per user because of excluded items.
1077                     $usergrademin = $items[$itemid]->grademin;
1078                     $usergrademax = $items[$itemid]->grademax;
1079                     if (isset($grademinoverrides[$itemid])) {
1080                         $usergrademin = $grademinoverrides[$itemid];
1081                     }
1082                     if (isset($grademaxoverrides[$itemid])) {
1083                         $usergrademax = $grademaxoverrides[$itemid];
1084                     }
1086                     // Ignore extra credit and items with a weight of 0.
1087                     if ($items[$itemid]->aggregationcoef <= 0 && $items[$itemid]->aggregationcoef2 > 0) {
1088                         $grademin += $usergrademin;
1089                         $grademax += $usergrademax;
1090                         $sumweights += $items[$itemid]->aggregationcoef2;
1091                     }
1092                 }
1093                 $userweights = array();
1094                 $totaloverriddenweight = 0;
1095                 $totaloverriddengrademax = 0;
1096                 // We first need to rescale all manually assigned weights down by the
1097                 // percentage of weights missing from the category.
1098                 foreach ($grade_values as $itemid => $gradevalue) {
1099                     if ($items[$itemid]->weightoverride) {
1100                         if ($items[$itemid]->aggregationcoef2 <= 0) {
1101                             // Records the weight of 0 and continue.
1102                             $userweights[$itemid] = 0;
1103                             continue;
1104                         }
1105                         $userweights[$itemid] = $items[$itemid]->aggregationcoef2 / $sumweights;
1106                         $totaloverriddenweight += $userweights[$itemid];
1107                         $usergrademax = $items[$itemid]->grademax;
1108                         if (isset($grademaxoverrides[$itemid])) {
1109                             $usergrademax = $grademaxoverrides[$itemid];
1110                         }
1111                         $totaloverriddengrademax += $usergrademax;
1112                     }
1113                 }
1114                 $nonoverriddenpoints = $grademax - $totaloverriddengrademax;
1116                 // Then we need to recalculate the automatic weights.
1117                 foreach ($grade_values as $itemid => $gradevalue) {
1118                     if (!$items[$itemid]->weightoverride) {
1119                         $usergrademax = $items[$itemid]->grademax;
1120                         if (isset($grademaxoverrides[$itemid])) {
1121                             $usergrademax = $grademaxoverrides[$itemid];
1122                         }
1123                         if ($nonoverriddenpoints > 0) {
1124                             $userweights[$itemid] = ($usergrademax/$nonoverriddenpoints) * (1 - $totaloverriddenweight);
1125                         } else {
1126                             $userweights[$itemid] = 0;
1127                             if ($items[$itemid]->aggregationcoef2 > 0) {
1128                                 // Items with a weight of 0 should not count for the grade max,
1129                                 // though this only applies if the weight was changed to 0.
1130                                 $grademax -= $usergrademax;
1131                             }
1132                         }
1133                     }
1134                 }
1136                 // We can use our freshly corrected weights below.
1137                 foreach ($grade_values as $itemid => $gradevalue) {
1138                     $sum += $gradevalue * $userweights[$itemid] * $grademax;
1139                     if ($weights !== null) {
1140                         $weights[$itemid] = $userweights[$itemid];
1141                     }
1142                 }
1143                 if ($grademax > 0) {
1144                     $agg_grade = $sum / $grademax; // Re-normalize score.
1145                 } else {
1146                     // Every item in the category is extra credit.
1147                     $agg_grade = $sum;
1148                     $grademax = $sum;
1149                 }
1151                 break;
1153             case GRADE_AGGREGATE_MEAN:    // Arithmetic average of all grade items (if ungraded aggregated, NULL counted as minimum)
1154             default:
1155                 $num = count($grade_values);
1156                 $sum = array_sum($grade_values);
1157                 $agg_grade = $sum / $num;
1158                 // Record the weights evenly.
1159                 if ($weights !== null && $num > 0) {
1160                     foreach ($grade_values as $itemid=>$grade_value) {
1161                         $weights[$itemid] = 1.0 / $num;
1162                     }
1163                 }
1164                 break;
1165         }
1167         return array('grade' => $agg_grade, 'grademin' => $grademin, 'grademax' => $grademax);
1168     }
1170     /**
1171      * Internal function that calculates the aggregated grade for this grade category
1172      *
1173      * Must be public as it is used by grade_grade::get_hiding_affected()
1174      *
1175      * @deprecated since Moodle 2.8
1176      * @param array $grade_values An array of values to be aggregated
1177      * @param array $items The array of grade_items
1178      * @return float The aggregate grade for this grade category
1179      */
1180     public function aggregate_values($grade_values, $items) {
1181         debugging('grade_category::aggregate_values() is deprecated.
1182                    Call grade_category::aggregate_values_and_adjust_bounds() instead.', DEBUG_DEVELOPER);
1183         $result = $this->aggregate_values_and_adjust_bounds($grade_values, $items);
1184         return $result['grade'];
1185     }
1187     /**
1188      * Some aggregation types may need to update their max grade.
1189      *
1190      * This must be executed after updating the weights as it relies on them.
1191      *
1192      * @return void
1193      */
1194     private function auto_update_max() {
1195         global $DB;
1196         if ($this->aggregation != GRADE_AGGREGATE_SUM) {
1197             // not needed at all
1198             return;
1199         }
1201         // Find grade items of immediate children (category or grade items) and force site settings.
1202         $this->load_grade_item();
1203         $depends_on = $this->grade_item->depends_on();
1205         $items = false;
1206         if (!empty($depends_on)) {
1207             list($usql, $params) = $DB->get_in_or_equal($depends_on);
1208             $sql = "SELECT *
1209                       FROM {grade_items}
1210                      WHERE id $usql";
1211             $items = $DB->get_records_sql($sql, $params);
1212         }
1214         if (!$items) {
1216             if ($this->grade_item->grademax != 0 or $this->grade_item->gradetype != GRADE_TYPE_VALUE) {
1217                 $this->grade_item->grademax  = 0;
1218                 $this->grade_item->grademin  = 0;
1219                 $this->grade_item->gradetype = GRADE_TYPE_VALUE;
1220                 $this->grade_item->update('aggregation');
1221             }
1222             return;
1223         }
1225         //find max grade possible
1226         $maxes = array();
1228         foreach ($items as $item) {
1230             if ($item->aggregationcoef > 0) {
1231                 // extra credit from this activity - does not affect total
1232                 continue;
1233             } else if ($item->aggregationcoef2 <= 0) {
1234                 // Items with a weight of 0 do not affect the total.
1235                 continue;
1236             }
1238             if ($item->gradetype == GRADE_TYPE_VALUE) {
1239                 $maxes[$item->id] = $item->grademax;
1241             } else if ($item->gradetype == GRADE_TYPE_SCALE) {
1242                 $maxes[$item->id] = $item->grademax; // 0 = nograde, 1 = first scale item, 2 = second scale item
1243             }
1244         }
1246         if ($this->can_apply_limit_rules()) {
1247             // Apply droplow and keephigh.
1248             $this->apply_limit_rules($maxes, $items);
1249         }
1250         $max = array_sum($maxes);
1252         // update db if anything changed
1253         if ($this->grade_item->grademax != $max or $this->grade_item->grademin != 0 or $this->grade_item->gradetype != GRADE_TYPE_VALUE) {
1254             $this->grade_item->grademax  = $max;
1255             $this->grade_item->grademin  = 0;
1256             $this->grade_item->gradetype = GRADE_TYPE_VALUE;
1257             $this->grade_item->update('aggregation');
1258         }
1259     }
1261     /**
1262      * Recalculate the weights of the grade items in this category.
1263      *
1264      * The category total is not updated here, a further call to
1265      * {@link self::auto_update_max()} is required.
1266      *
1267      * @return void
1268      */
1269     private function auto_update_weights() {
1270         if ($this->aggregation != GRADE_AGGREGATE_SUM) {
1271             // This is only required if we are using natural weights.
1272             return;
1273         }
1274         $children = $this->get_children();
1276         $gradeitem = null;
1278         // Calculate the sum of the grademax's of all the items within this category.
1279         $totalnonoverriddengrademax = 0;
1280         $totalgrademax = 0;
1282         // Out of 1, how much weight has been manually overriden by a user?
1283         $totaloverriddenweight  = 0;
1284         $totaloverriddengrademax  = 0;
1286         // Has every assessment in this category been overridden?
1287         $automaticgradeitemspresent = false;
1288         // Does the grade item require normalising?
1289         $requiresnormalising = false;
1291         // This array keeps track of the id and weight of every grade item that has been overridden.
1292         $overridearray = array();
1293         foreach ($children as $sortorder => $child) {
1294             $gradeitem = null;
1296             if ($child['type'] == 'item') {
1297                 $gradeitem = $child['object'];
1298             } else if ($child['type'] == 'category') {
1299                 $gradeitem = $child['object']->load_grade_item();
1300             }
1302             // Record the ID and the weight for this grade item.
1303             $overridearray[$gradeitem->id] = array();
1304             $overridearray[$gradeitem->id]['extracredit'] = intval($gradeitem->aggregationcoef);
1305             $overridearray[$gradeitem->id]['weight'] = $gradeitem->aggregationcoef2;
1306             $overridearray[$gradeitem->id]['weightoverride'] = intval($gradeitem->weightoverride);
1307             // If this item has had its weight overridden then set the flag to true, but
1308             // only if all previous items were also overridden. Note that extra credit items
1309             // are counted as overridden grade items.
1310             if (!$gradeitem->weightoverride && $gradeitem->aggregationcoef == 0) {
1311                 $automaticgradeitemspresent = true;
1312             }
1314             if ($gradeitem->aggregationcoef > 0) {
1315                 // An extra credit grade item doesn't contribute to $totaloverriddengrademax.
1316                 continue;
1317             } else if ($gradeitem->weightoverride > 0 && $gradeitem->aggregationcoef2 <= 0) {
1318                 // An overriden item that defines a weight of 0 does not contribute to $totaloverriddengrademax.
1319                 continue;
1320             }
1322             $totalgrademax += $gradeitem->grademax;
1323             if ($gradeitem->weightoverride > 0) {
1324                 $totaloverriddenweight += $gradeitem->aggregationcoef2;
1325                 $totaloverriddengrademax += $gradeitem->grademax;
1326             }
1327         }
1329         // Initialise this variable (used to keep track of the weight override total).
1330         $normalisetotal = 0;
1331         // 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
1332         // other weights to zero and normalise the others.
1333         $overriddentotal = 0;
1334         // If the overridden weight total is higher than 1 then set the other untouched weights to zero.
1335         $setotherweightstozero = false;
1336         // Total up all of the weights.
1337         foreach ($overridearray as $gradeitemdetail) {
1338             // If the grade item has extra credit, then don't add it to the normalisetotal.
1339             if (!$gradeitemdetail['extracredit']) {
1340                 $normalisetotal += $gradeitemdetail['weight'];
1341             }
1342             if ($gradeitemdetail['weightoverride'] && !$gradeitemdetail['extracredit']) {
1343                 // Add overriden weights up to see if they are greater than 1.
1344                 $overriddentotal += $gradeitemdetail['weight'];
1345             }
1346         }
1347         if ($overriddentotal > 1) {
1348             // Make sure that this catergory of weights gets normalised.
1349             $requiresnormalising = true;
1350             // The normalised weights are only the overridden weights, so we just use the total of those.
1351             $normalisetotal = $overriddentotal;
1352         }
1354         $totalnonoverriddengrademax = $totalgrademax - $totaloverriddengrademax;
1356         reset($children);
1357         foreach ($children as $sortorder => $child) {
1358             $gradeitem = null;
1360             if ($child['type'] == 'item') {
1361                 $gradeitem = $child['object'];
1362             } else if ($child['type'] == 'category') {
1363                 $gradeitem = $child['object']->load_grade_item();
1364             }
1366             if (!$gradeitem->weightoverride) {
1367                 // Calculations with a grade maximum of zero will cause problems. Just set the weight to zero.
1368                 if ($totaloverriddenweight >= 1 || $totalnonoverriddengrademax == 0 || $gradeitem->grademax == 0) {
1369                     // There is no more weight to distribute.
1370                     $gradeitem->aggregationcoef2 = 0;
1371                 } else {
1372                     // Calculate this item's weight as a percentage of the non-overridden total grade maxes
1373                     // then convert it to a proportion of the available non-overriden weight.
1374                     $gradeitem->aggregationcoef2 = ($gradeitem->grademax/$totalnonoverriddengrademax) *
1375                             (1 - $totaloverriddenweight);
1376                 }
1377                 $gradeitem->update();
1378             } else if ((!$automaticgradeitemspresent && $normalisetotal != 1) || ($requiresnormalising)
1379                     || $overridearray[$gradeitem->id]['weight'] < 0) {
1380                 // Just divide the overriden weight for this item against the total weight override of all
1381                 // items in this category.
1382                 if ($normalisetotal == 0 || $overridearray[$gradeitem->id]['weight'] < 0) {
1383                     // If the normalised total equals zero, or the weight value is less than zero,
1384                     // set the weight for the grade item to zero.
1385                     $gradeitem->aggregationcoef2 = 0;
1386                 } else {
1387                     $gradeitem->aggregationcoef2 = $overridearray[$gradeitem->id]['weight'] / $normalisetotal;
1388                 }
1389                 // Update the grade item to reflect these changes.
1390                 $gradeitem->update();
1391             }
1392         }
1393     }
1395     /**
1396      * Given an array of grade values (numerical indices) applies droplow or keephigh rules to limit the final array.
1397      *
1398      * @param array $grade_values itemid=>$grade_value float
1399      * @param array $items grade item objects
1400      * @return array Limited grades.
1401      */
1402     public function apply_limit_rules(&$grade_values, $items) {
1403         $extraused = $this->is_extracredit_used();
1405         if (!empty($this->droplow)) {
1406             asort($grade_values, SORT_NUMERIC);
1407             $dropped = 0;
1409             // If we have fewer grade items available to drop than $this->droplow, use this flag to escape the loop
1410             // May occur because of "extra credit" or if droplow is higher than the number of grade items
1411             $droppedsomething = true;
1413             while ($dropped < $this->droplow && $droppedsomething) {
1414                 $droppedsomething = false;
1416                 $grade_keys = array_keys($grade_values);
1417                 $gradekeycount = count($grade_keys);
1419                 if ($gradekeycount === 0) {
1420                     //We've dropped all grade items
1421                     break;
1422                 }
1424                 $originalindex = $founditemid = $foundmax = null;
1426                 // Find the first remaining grade item that is available to be dropped
1427                 foreach ($grade_keys as $gradekeyindex=>$gradekey) {
1428                     if (!$extraused || $items[$gradekey]->aggregationcoef <= 0) {
1429                         // Found a non-extra credit grade item that is eligible to be dropped
1430                         $originalindex = $gradekeyindex;
1431                         $founditemid = $grade_keys[$originalindex];
1432                         $foundmax = $items[$founditemid]->grademax;
1433                         break;
1434                     }
1435                 }
1437                 if (empty($founditemid)) {
1438                     // No grade items available to drop
1439                     break;
1440                 }
1442                 // Now iterate over the remaining grade items
1443                 // We're looking for other grade items with the same grade value but a higher grademax
1444                 $i = 1;
1445                 while ($originalindex + $i < $gradekeycount) {
1447                     $possibleitemid = $grade_keys[$originalindex+$i];
1448                     $i++;
1450                     if ($grade_values[$founditemid] != $grade_values[$possibleitemid]) {
1451                         // The next grade item has a different grade value. Stop looking.
1452                         break;
1453                     }
1455                     if ($extraused && $items[$possibleitemid]->aggregationcoef > 0) {
1456                         // Don't drop extra credit grade items. Continue the search.
1457                         continue;
1458                     }
1460                     if ($foundmax < $items[$possibleitemid]->grademax) {
1461                         // Found a grade item with the same grade value and a higher grademax
1462                         $foundmax = $items[$possibleitemid]->grademax;
1463                         $founditemid = $possibleitemid;
1464                         // Continue searching to see if there is an even higher grademax
1465                     }
1466                 }
1468                 // Now drop whatever grade item we have found
1469                 unset($grade_values[$founditemid]);
1470                 $dropped++;
1471                 $droppedsomething = true;
1472             }
1474         } else if (!empty($this->keephigh)) {
1475             arsort($grade_values, SORT_NUMERIC);
1476             $kept = 0;
1478             foreach ($grade_values as $itemid=>$value) {
1480                 if ($extraused and $items[$itemid]->aggregationcoef > 0) {
1481                     // we keep all extra credits
1483                 } else if ($kept < $this->keephigh) {
1484                     $kept++;
1486                 } else {
1487                     unset($grade_values[$itemid]);
1488                 }
1489             }
1490         }
1491     }
1493     /**
1494      * Returns whether or not we can apply the limit rules.
1495      *
1496      * There are cases where drop lowest or keep highest should not be used
1497      * at all. This method will determine whether or not this logic can be
1498      * applied considering the current setup of the category.
1499      *
1500      * @return bool
1501      */
1502     public function can_apply_limit_rules() {
1503         if ($this->canapplylimitrules !== null) {
1504             return $this->canapplylimitrules;
1505         }
1507         // Set it to be supported by default.
1508         $this->canapplylimitrules = true;
1510         // Natural aggregation.
1511         if ($this->aggregation == GRADE_AGGREGATE_SUM) {
1512             $canapply = true;
1514             // Check until one child breaks the rules.
1515             $gradeitems = $this->get_children();
1516             $validitems = 0;
1517             $lastweight = null;
1518             $lastmaxgrade = null;
1519             foreach ($gradeitems as $gradeitem) {
1520                 $gi = $gradeitem['object'];
1522                 if ($gradeitem['type'] == 'category') {
1523                     // Sub categories are not allowed because they can have dynamic weights/maxgrades.
1524                     $canapply = false;
1525                     break;
1526                 }
1528                 if ($gi->aggregationcoef > 0) {
1529                     // Extra credit items are not allowed.
1530                     $canapply = false;
1531                     break;
1532                 }
1534                 if ($lastweight !== null && $lastweight != $gi->aggregationcoef2) {
1535                     // One of the weight differs from another item.
1536                     $canapply = false;
1537                     break;
1538                 }
1540                 if ($lastmaxgrade !== null && $lastmaxgrade != $gi->grademax) {
1541                     // One of the max grade differ from another item. This is not allowed for now
1542                     // because we could be end up with different max grade between users for this category.
1543                     $canapply = false;
1544                     break;
1545                 }
1547                 $lastweight = $gi->aggregationcoef2;
1548                 $lastmaxgrade = $gi->grademax;
1549             }
1551             $this->canapplylimitrules = $canapply;
1552         }
1554         return $this->canapplylimitrules;
1555     }
1557     /**
1558      * Returns true if category uses extra credit of any kind
1559      *
1560      * @return bool True if extra credit used
1561      */
1562     public function is_extracredit_used() {
1563         return self::aggregation_uses_extracredit($this->aggregation);
1564     }
1566     /**
1567      * Returns true if aggregation passed is using extracredit.
1568      *
1569      * @param int $aggregation Aggregation const.
1570      * @return bool True if extra credit used
1571      */
1572     public static function aggregation_uses_extracredit($aggregation) {
1573         return ($aggregation == GRADE_AGGREGATE_WEIGHTED_MEAN2
1574              or $aggregation == GRADE_AGGREGATE_EXTRACREDIT_MEAN
1575              or $aggregation == GRADE_AGGREGATE_SUM);
1576     }
1578     /**
1579      * Returns true if category uses special aggregation coefficient
1580      *
1581      * @return bool True if an aggregation coefficient is being used
1582      */
1583     public function is_aggregationcoef_used() {
1584         return self::aggregation_uses_aggregationcoef($this->aggregation);
1586     }
1588     /**
1589      * Returns true if aggregation uses aggregationcoef
1590      *
1591      * @param int $aggregation Aggregation const.
1592      * @return bool True if an aggregation coefficient is being used
1593      */
1594     public static function aggregation_uses_aggregationcoef($aggregation) {
1595         return ($aggregation == GRADE_AGGREGATE_WEIGHTED_MEAN
1596              or $aggregation == GRADE_AGGREGATE_WEIGHTED_MEAN2
1597              or $aggregation == GRADE_AGGREGATE_EXTRACREDIT_MEAN
1598              or $aggregation == GRADE_AGGREGATE_SUM);
1600     }
1602     /**
1603      * Recursive function to find which weight/extra credit field to use in the grade item form.
1604      *
1605      * Inherits from a parent category if that category has aggregatesubcats set to true.
1606      *
1607      * @param string $first Whether or not this is the first item in the recursion
1608      * @return string
1609      */
1610     public function get_coefstring($first=true) {
1611         if (!is_null($this->coefstring)) {
1612             return $this->coefstring;
1613         }
1615         $overriding_coefstring = null;
1617         // Stop recursing upwards if this category aggregates subcats or has no parent
1618         if (!$first && !$this->aggregatesubcats) {
1620             if ($parent_category = $this->load_parent_category()) {
1621                 return $parent_category->get_coefstring(false);
1623             } else {
1624                 return null;
1625             }
1627         } else if ($first) {
1629             if (!$this->aggregatesubcats) {
1631                 if ($parent_category = $this->load_parent_category()) {
1632                     $overriding_coefstring = $parent_category->get_coefstring(false);
1633                 }
1634             }
1635         }
1637         // If an overriding coefstring has trickled down from one of the parent categories, return it. Otherwise, return self.
1638         if (!is_null($overriding_coefstring)) {
1639             return $overriding_coefstring;
1640         }
1642         // No parent category is overriding this category's aggregation, return its string
1643         if ($this->aggregation == GRADE_AGGREGATE_WEIGHTED_MEAN) {
1644             $this->coefstring = 'aggregationcoefweight';
1646         } else if ($this->aggregation == GRADE_AGGREGATE_WEIGHTED_MEAN2) {
1647             $this->coefstring = 'aggregationcoefextrasum';
1649         } else if ($this->aggregation == GRADE_AGGREGATE_EXTRACREDIT_MEAN) {
1650             $this->coefstring = 'aggregationcoefextraweight';
1652         } else if ($this->aggregation == GRADE_AGGREGATE_SUM) {
1653             $this->coefstring = 'aggregationcoefextraweightsum';
1655         } else {
1656             $this->coefstring = 'aggregationcoef';
1657         }
1658         return $this->coefstring;
1659     }
1661     /**
1662      * Returns tree with all grade_items and categories as elements
1663      *
1664      * @param int $courseid The course ID
1665      * @param bool $include_category_items as category children
1666      * @return array
1667      */
1668     public static function fetch_course_tree($courseid, $include_category_items=false) {
1669         $course_category = grade_category::fetch_course_category($courseid);
1670         $category_array = array('object'=>$course_category, 'type'=>'category', 'depth'=>1,
1671                                 'children'=>$course_category->get_children($include_category_items));
1673         $course_category->sortorder = $course_category->get_sortorder();
1674         $sortorder = $course_category->get_sortorder();
1675         return grade_category::_fetch_course_tree_recursion($category_array, $sortorder);
1676     }
1678     /**
1679      * An internal function that recursively sorts grade categories within a course
1680      *
1681      * @param array $category_array The seed of the recursion
1682      * @param int   $sortorder The current sortorder
1683      * @return array An array containing 'object', 'type', 'depth' and optionally 'children'
1684      */
1685     static private function _fetch_course_tree_recursion($category_array, &$sortorder) {
1686         // update the sortorder in db if needed
1687         //NOTE: This leads to us resetting sort orders every time the categories and items page is viewed :(
1688         //if ($category_array['object']->sortorder != $sortorder) {
1689             //$category_array['object']->set_sortorder($sortorder);
1690         //}
1692         if (isset($category_array['object']->gradetype) && $category_array['object']->gradetype==GRADE_TYPE_NONE) {
1693             return null;
1694         }
1696         // store the grade_item or grade_category instance with extra info
1697         $result = array('object'=>$category_array['object'], 'type'=>$category_array['type'], 'depth'=>$category_array['depth']);
1699         // reuse final grades if there
1700         if (array_key_exists('finalgrades', $category_array)) {
1701             $result['finalgrades'] = $category_array['finalgrades'];
1702         }
1704         // recursively resort children
1705         if (!empty($category_array['children'])) {
1706             $result['children'] = array();
1707             //process the category item first
1708             $child = null;
1710             foreach ($category_array['children'] as $oldorder=>$child_array) {
1712                 if ($child_array['type'] == 'courseitem' or $child_array['type'] == 'categoryitem') {
1713                     $child = grade_category::_fetch_course_tree_recursion($child_array, $sortorder);
1714                     if (!empty($child)) {
1715                         $result['children'][$sortorder] = $child;
1716                     }
1717                 }
1718             }
1720             foreach ($category_array['children'] as $oldorder=>$child_array) {
1722                 if ($child_array['type'] != 'courseitem' and $child_array['type'] != 'categoryitem') {
1723                     $child = grade_category::_fetch_course_tree_recursion($child_array, $sortorder);
1724                     if (!empty($child)) {
1725                         $result['children'][++$sortorder] = $child;
1726                     }
1727                 }
1728             }
1729         }
1731         return $result;
1732     }
1734     /**
1735      * Fetches and returns all the children categories and/or grade_items belonging to this category.
1736      * By default only returns the immediate children (depth=1), but deeper levels can be requested,
1737      * as well as all levels (0). The elements are indexed by sort order.
1738      *
1739      * @param bool $include_category_items Whether or not to include category grade_items in the children array
1740      * @return array Array of child objects (grade_category and grade_item).
1741      */
1742     public function get_children($include_category_items=false) {
1743         global $DB;
1745         // This function must be as fast as possible ;-)
1746         // fetch all course grade items and categories into memory - we do not expect hundreds of these in course
1747         // we have to limit the number of queries though, because it will be used often in grade reports
1749         $cats  = $DB->get_records('grade_categories', array('courseid' => $this->courseid));
1750         $items = $DB->get_records('grade_items', array('courseid' => $this->courseid));
1752         // init children array first
1753         foreach ($cats as $catid=>$cat) {
1754             $cats[$catid]->children = array();
1755         }
1757         //first attach items to cats and add category sortorder
1758         foreach ($items as $item) {
1760             if ($item->itemtype == 'course' or $item->itemtype == 'category') {
1761                 $cats[$item->iteminstance]->sortorder = $item->sortorder;
1763                 if (!$include_category_items) {
1764                     continue;
1765                 }
1766                 $categoryid = $item->iteminstance;
1768             } else {
1769                 $categoryid = $item->categoryid;
1770                 if (empty($categoryid)) {
1771                     debugging('Found a grade item that isnt in a category');
1772                 }
1773             }
1775             // prevent problems with duplicate sortorders in db
1776             $sortorder = $item->sortorder;
1778             while (array_key_exists($categoryid, $cats)
1779                 && array_key_exists($sortorder, $cats[$categoryid]->children)) {
1781                 $sortorder++;
1782             }
1784             $cats[$categoryid]->children[$sortorder] = $item;
1786         }
1788         // now find the requested category and connect categories as children
1789         $category = false;
1791         foreach ($cats as $catid=>$cat) {
1793             if (empty($cat->parent)) {
1795                 if ($cat->path !== '/'.$cat->id.'/') {
1796                     $grade_category = new grade_category($cat, false);
1797                     $grade_category->path  = '/'.$cat->id.'/';
1798                     $grade_category->depth = 1;
1799                     $grade_category->update('system');
1800                     return $this->get_children($include_category_items);
1801                 }
1803             } else {
1805                 if (empty($cat->path) or !preg_match('|/'.$cat->parent.'/'.$cat->id.'/$|', $cat->path)) {
1806                     //fix paths and depts
1807                     static $recursioncounter = 0; // prevents infinite recursion
1808                     $recursioncounter++;
1810                     if ($recursioncounter < 5) {
1811                         // fix paths and depths!
1812                         $grade_category = new grade_category($cat, false);
1813                         $grade_category->depth = 0;
1814                         $grade_category->path  = null;
1815                         $grade_category->update('system');
1816                         return $this->get_children($include_category_items);
1817                     }
1818                 }
1819                 // prevent problems with duplicate sortorders in db
1820                 $sortorder = $cat->sortorder;
1822                 while (array_key_exists($sortorder, $cats[$cat->parent]->children)) {
1823                     //debugging("$sortorder exists in cat loop");
1824                     $sortorder++;
1825                 }
1827                 $cats[$cat->parent]->children[$sortorder] = &$cats[$catid];
1828             }
1830             if ($catid == $this->id) {
1831                 $category = &$cats[$catid];
1832             }
1833         }
1835         unset($items); // not needed
1836         unset($cats); // not needed
1838         $children_array = grade_category::_get_children_recursion($category);
1840         ksort($children_array);
1842         return $children_array;
1844     }
1846     /**
1847      * Private method used to retrieve all children of this category recursively
1848      *
1849      * @param grade_category $category Source of current recursion
1850      * @return array An array of child grade categories
1851      */
1852     private static function _get_children_recursion($category) {
1854         $children_array = array();
1855         foreach ($category->children as $sortorder=>$child) {
1857             if (array_key_exists('itemtype', $child)) {
1858                 $grade_item = new grade_item($child, false);
1860                 if (in_array($grade_item->itemtype, array('course', 'category'))) {
1861                     $type  = $grade_item->itemtype.'item';
1862                     $depth = $category->depth;
1864                 } else {
1865                     $type  = 'item';
1866                     $depth = $category->depth; // we use this to set the same colour
1867                 }
1868                 $children_array[$sortorder] = array('object'=>$grade_item, 'type'=>$type, 'depth'=>$depth);
1870             } else {
1871                 $children = grade_category::_get_children_recursion($child);
1872                 $grade_category = new grade_category($child, false);
1874                 if (empty($children)) {
1875                     $children = array();
1876                 }
1877                 $children_array[$sortorder] = array('object'=>$grade_category, 'type'=>'category', 'depth'=>$grade_category->depth, 'children'=>$children);
1878             }
1879         }
1881         // sort the array
1882         ksort($children_array);
1884         return $children_array;
1885     }
1887     /**
1888      * Uses {@link get_grade_item()} to load or create a grade_item, then saves it as $this->grade_item.
1889      *
1890      * @return grade_item
1891      */
1892     public function load_grade_item() {
1893         if (empty($this->grade_item)) {
1894             $this->grade_item = $this->get_grade_item();
1895         }
1896         return $this->grade_item;
1897     }
1899     /**
1900      * Retrieves this grade categories' associated grade_item from the database
1901      *
1902      * If no grade_item exists yet, creates one.
1903      *
1904      * @return grade_item
1905      */
1906     public function get_grade_item() {
1907         if (empty($this->id)) {
1908             debugging("Attempt to obtain a grade_category's associated grade_item without the category's ID being set.");
1909             return false;
1910         }
1912         if (empty($this->parent)) {
1913             $params = array('courseid'=>$this->courseid, 'itemtype'=>'course', 'iteminstance'=>$this->id);
1915         } else {
1916             $params = array('courseid'=>$this->courseid, 'itemtype'=>'category', 'iteminstance'=>$this->id);
1917         }
1919         if (!$grade_items = grade_item::fetch_all($params)) {
1920             // create a new one
1921             $grade_item = new grade_item($params, false);
1922             $grade_item->gradetype = GRADE_TYPE_VALUE;
1923             $grade_item->insert('system');
1925         } else if (count($grade_items) == 1) {
1926             // found existing one
1927             $grade_item = reset($grade_items);
1929         } else {
1930             debugging("Found more than one grade_item attached to category id:".$this->id);
1931             // return first one
1932             $grade_item = reset($grade_items);
1933         }
1935         return $grade_item;
1936     }
1938     /**
1939      * Uses $this->parent to instantiate $this->parent_category based on the referenced record in the DB
1940      *
1941      * @return grade_category The parent category
1942      */
1943     public function load_parent_category() {
1944         if (empty($this->parent_category) && !empty($this->parent)) {
1945             $this->parent_category = $this->get_parent_category();
1946         }
1947         return $this->parent_category;
1948     }
1950     /**
1951      * Uses $this->parent to instantiate and return a grade_category object
1952      *
1953      * @return grade_category Returns the parent category or null if this category has no parent
1954      */
1955     public function get_parent_category() {
1956         if (!empty($this->parent)) {
1957             $parent_category = new grade_category(array('id' => $this->parent));
1958             return $parent_category;
1959         } else {
1960             return null;
1961         }
1962     }
1964     /**
1965      * Returns the most descriptive field for this grade category
1966      *
1967      * @return string name
1968      */
1969     public function get_name() {
1970         global $DB;
1971         // For a course category, we return the course name if the fullname is set to '?' in the DB (empty in the category edit form)
1972         if (empty($this->parent) && $this->fullname == '?') {
1973             $course = $DB->get_record('course', array('id'=> $this->courseid));
1974             return format_string($course->fullname);
1976         } else {
1977             return $this->fullname;
1978         }
1979     }
1981     /**
1982      * Describe the aggregation settings for this category so the reports make more sense.
1983      *
1984      * @return string description
1985      */
1986     public function get_description() {
1987         $allhelp = array();
1988         if ($this->aggregation != GRADE_AGGREGATE_SUM) {
1989             $aggrstrings = grade_helper::get_aggregation_strings();
1990             $allhelp[] = $aggrstrings[$this->aggregation];
1991         }
1993         if ($this->droplow && $this->can_apply_limit_rules()) {
1994             $allhelp[] = get_string('droplowestvalues', 'grades', $this->droplow);
1995         }
1996         if ($this->keephigh && $this->can_apply_limit_rules()) {
1997             $allhelp[] = get_string('keephighestvalues', 'grades', $this->keephigh);
1998         }
1999         if (!$this->aggregateonlygraded) {
2000             $allhelp[] = get_string('aggregatenotonlygraded', 'grades');
2001         }
2002         if ($this->aggregatesubcats) {
2003             $allhelp[] = get_string('aggregatesubcatsshort', 'grades');
2004         }
2005         if ($allhelp) {
2006             return implode('. ', $allhelp) . '.';
2007         }
2008         return '';
2009     }
2011     /**
2012      * Sets this category's parent id
2013      *
2014      * @param int $parentid The ID of the category that is the new parent to $this
2015      * @param string $source From where was the object updated (mod/forum, manual, etc.)
2016      * @return bool success
2017      */
2018     public function set_parent($parentid, $source=null) {
2019         if ($this->parent == $parentid) {
2020             return true;
2021         }
2023         if ($parentid == $this->id) {
2024             print_error('cannotassignselfasparent');
2025         }
2027         if (empty($this->parent) and $this->is_course_category()) {
2028             print_error('cannothaveparentcate');
2029         }
2031         // find parent and check course id
2032         if (!$parent_category = grade_category::fetch(array('id'=>$parentid, 'courseid'=>$this->courseid))) {
2033             return false;
2034         }
2036         $this->force_regrading();
2038         // set new parent category
2039         $this->parent          = $parent_category->id;
2040         $this->parent_category =& $parent_category;
2041         $this->path            = null;       // remove old path and depth - will be recalculated in update()
2042         $this->depth           = 0;          // remove old path and depth - will be recalculated in update()
2043         $this->update($source);
2045         return $this->update($source);
2046     }
2048     /**
2049      * Returns the final grade values for this grade category.
2050      *
2051      * @param int $userid Optional user ID to retrieve a single user's final grade
2052      * @return mixed An array of all final_grades (stdClass objects) for this grade_item, or a single final_grade.
2053      */
2054     public function get_final($userid=null) {
2055         $this->load_grade_item();
2056         return $this->grade_item->get_final($userid);
2057     }
2059     /**
2060      * Returns the sortorder of the grade categories' associated grade_item
2061      *
2062      * This method is also available in grade_item for cases where the object type is not known.
2063      *
2064      * @return int Sort order
2065      */
2066     public function get_sortorder() {
2067         $this->load_grade_item();
2068         return $this->grade_item->get_sortorder();
2069     }
2071     /**
2072      * Returns the idnumber of the grade categories' associated grade_item.
2073      *
2074      * This method is also available in grade_item for cases where the object type is not known.
2075      *
2076      * @return string idnumber
2077      */
2078     public function get_idnumber() {
2079         $this->load_grade_item();
2080         return $this->grade_item->get_idnumber();
2081     }
2083     /**
2084      * Sets the sortorder variable for this category.
2085      *
2086      * This method is also available in grade_item, for cases where the object type is not know.
2087      *
2088      * @param int $sortorder The sortorder to assign to this category
2089      */
2090     public function set_sortorder($sortorder) {
2091         $this->load_grade_item();
2092         $this->grade_item->set_sortorder($sortorder);
2093     }
2095     /**
2096      * Move this category after the given sortorder
2097      *
2098      * Does not change the parent
2099      *
2100      * @param int $sortorder to place after.
2101      * @return void
2102      */
2103     public function move_after_sortorder($sortorder) {
2104         $this->load_grade_item();
2105         $this->grade_item->move_after_sortorder($sortorder);
2106     }
2108     /**
2109      * Return true if this is the top most category that represents the total course grade.
2110      *
2111      * @return bool
2112      */
2113     public function is_course_category() {
2114         $this->load_grade_item();
2115         return $this->grade_item->is_course_item();
2116     }
2118     /**
2119      * Return the course level grade_category object
2120      *
2121      * @param int $courseid The Course ID
2122      * @return grade_category Returns the course level grade_category instance
2123      */
2124     public static function fetch_course_category($courseid) {
2125         if (empty($courseid)) {
2126             debugging('Missing course id!');
2127             return false;
2128         }
2130         // course category has no parent
2131         if ($course_category = grade_category::fetch(array('courseid'=>$courseid, 'parent'=>null))) {
2132             return $course_category;
2133         }
2135         // create a new one
2136         $course_category = new grade_category();
2137         $course_category->insert_course_category($courseid);
2139         return $course_category;
2140     }
2142     /**
2143      * Is grading object editable?
2144      *
2145      * @return bool
2146      */
2147     public function is_editable() {
2148         return true;
2149     }
2151     /**
2152      * Returns the locked state/date of the grade categories' associated grade_item.
2153      *
2154      * This method is also available in grade_item, for cases where the object type is not known.
2155      *
2156      * @return bool
2157      */
2158     public function is_locked() {
2159         $this->load_grade_item();
2160         return $this->grade_item->is_locked();
2161     }
2163     /**
2164      * Sets the grade_item's locked variable and updates the grade_item.
2165      *
2166      * Calls set_locked() on the categories' grade_item
2167      *
2168      * @param int  $lockedstate 0, 1 or a timestamp int(10) after which date the item will be locked.
2169      * @param bool $cascade lock/unlock child objects too
2170      * @param bool $refresh refresh grades when unlocking
2171      * @return bool success if category locked (not all children mayb be locked though)
2172      */
2173     public function set_locked($lockedstate, $cascade=false, $refresh=true) {
2174         $this->load_grade_item();
2176         $result = $this->grade_item->set_locked($lockedstate, $cascade, true);
2178         if ($cascade) {
2179             //process all children - items and categories
2180             if ($children = grade_item::fetch_all(array('categoryid'=>$this->id))) {
2182                 foreach ($children as $child) {
2183                     $child->set_locked($lockedstate, true, false);
2185                     if (empty($lockedstate) and $refresh) {
2186                         //refresh when unlocking
2187                         $child->refresh_grades();
2188                     }
2189                 }
2190             }
2192             if ($children = grade_category::fetch_all(array('parent'=>$this->id))) {
2194                 foreach ($children as $child) {
2195                     $child->set_locked($lockedstate, true, true);
2196                 }
2197             }
2198         }
2200         return $result;
2201     }
2203     /**
2204      * Overrides grade_object::set_properties() to add special handling for changes to category aggregation types
2205      *
2206      * @param stdClass $instance the object to set the properties on
2207      * @param array|stdClass $params Either an associative array or an object containing property name, property value pairs
2208      */
2209     public static function set_properties(&$instance, $params) {
2210         global $DB;
2212         parent::set_properties($instance, $params);
2214         //if they've changed aggregation type we made need to do some fiddling to provide appropriate defaults
2215         if (!empty($params->aggregation)) {
2217             //weight and extra credit share a column :( Would like a default of 1 for weight and 0 for extra credit
2218             //Flip from the default of 0 to 1 (or vice versa) if ALL items in the category are still set to the old default.
2219             if (self::aggregation_uses_aggregationcoef($params->aggregation)) {
2220                 $sql = $defaultaggregationcoef = null;
2222                 if (!self::aggregation_uses_extracredit($params->aggregation)) {
2223                     //if all items in this category have aggregation coefficient of 0 we can change it to 1 ie evenly weighted
2224                     $sql = "select count(id) from {grade_items} where categoryid=:categoryid and aggregationcoef!=0";
2225                     $defaultaggregationcoef = 1;
2226                 } else {
2227                     //if all items in this category have aggregation coefficient of 1 we can change it to 0 ie no extra credit
2228                     $sql = "select count(id) from {grade_items} where categoryid=:categoryid and aggregationcoef!=1";
2229                     $defaultaggregationcoef = 0;
2230                 }
2232                 $params = array('categoryid'=>$instance->id);
2233                 $count = $DB->count_records_sql($sql, $params);
2234                 if ($count===0) { //category is either empty or all items are set to a default value so we can switch defaults
2235                     $params['aggregationcoef'] = $defaultaggregationcoef;
2236                     $DB->execute("update {grade_items} set aggregationcoef=:aggregationcoef where categoryid=:categoryid",$params);
2237                 }
2238             }
2239         }
2240     }
2242     /**
2243      * Sets the grade_item's hidden variable and updates the grade_item.
2244      *
2245      * Overrides grade_item::set_hidden() to add cascading of the hidden value to grade items in this grade category
2246      *
2247      * @param int $hidden 0 mean always visible, 1 means always hidden and a number > 1 is a timestamp to hide until
2248      * @param bool $cascade apply to child objects too
2249      */
2250     public function set_hidden($hidden, $cascade=false) {
2251         $this->load_grade_item();
2252         //this hides the associated grade item (the course total)
2253         $this->grade_item->set_hidden($hidden, $cascade);
2254         //this hides the category itself and everything it contains
2255         parent::set_hidden($hidden, $cascade);
2257         if ($cascade) {
2259             if ($children = grade_item::fetch_all(array('categoryid'=>$this->id))) {
2261                 foreach ($children as $child) {
2262                     if ($child->can_control_visibility()) {
2263                         $child->set_hidden($hidden, $cascade);
2264                     }
2265                 }
2266             }
2268             if ($children = grade_category::fetch_all(array('parent'=>$this->id))) {
2270                 foreach ($children as $child) {
2271                     $child->set_hidden($hidden, $cascade);
2272                 }
2273             }
2274         }
2276         //if marking category visible make sure parent category is visible MDL-21367
2277         if( !$hidden ) {
2278             $category_array = grade_category::fetch_all(array('id'=>$this->parent));
2279             if ($category_array && array_key_exists($this->parent, $category_array)) {
2280                 $category = $category_array[$this->parent];
2281                 //call set_hidden on the category regardless of whether it is hidden as its parent might be hidden
2282                 //if($category->is_hidden()) {
2283                     $category->set_hidden($hidden, false);
2284                 //}
2285             }
2286         }
2287     }
2289     /**
2290      * Applies default settings on this category
2291      *
2292      * @return bool True if anything changed
2293      */
2294     public function apply_default_settings() {
2295         global $CFG;
2297         foreach ($this->forceable as $property) {
2299             if (isset($CFG->{"grade_$property"})) {
2301                 if ($CFG->{"grade_$property"} == -1) {
2302                     continue; //temporary bc before version bump
2303                 }
2304                 $this->$property = $CFG->{"grade_$property"};
2305             }
2306         }
2307     }
2309     /**
2310      * Applies forced settings on this category
2311      *
2312      * @return bool True if anything changed
2313      */
2314     public function apply_forced_settings() {
2315         global $CFG;
2317         $updated = false;
2319         foreach ($this->forceable as $property) {
2321             if (isset($CFG->{"grade_$property"}) and isset($CFG->{"grade_{$property}_flag"}) and
2322                                                     ((int) $CFG->{"grade_{$property}_flag"} & 1)) {
2324                 if ($CFG->{"grade_$property"} == -1) {
2325                     continue; //temporary bc before version bump
2326                 }
2327                 $this->$property = $CFG->{"grade_$property"};
2328                 $updated = true;
2329             }
2330         }
2332         return $updated;
2333     }
2335     /**
2336      * Notification of change in forced category settings.
2337      *
2338      * Causes all course and category grade items to be marked as needing to be updated
2339      */
2340     public static function updated_forced_settings() {
2341         global $CFG, $DB;
2342         $params = array(1, 'course', 'category');
2343         $sql = "UPDATE {grade_items} SET needsupdate=? WHERE itemtype=? or itemtype=?";
2344         $DB->execute($sql, $params);
2345     }