MDL-40697 core_grades: trigger the user_graded event
[moodle.git] / lib / grade / grade_category.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Definition of a class to represent a grade category
19  *
20  * @package   core_grades
21  * @copyright 2006 Nicolas Connault
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 defined('MOODLE_INTERNAL') || die();
27 require_once('grade_object.php');
29 /**
30  * grade_category is an object mapped to DB table {prefix}grade_categories
31  *
32  * @package   core_grades
33  * @category  grade
34  * @copyright 2007 Nicolas Connault
35  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
36  */
37 class grade_category extends grade_object {
38     /**
39      * The DB table.
40      * @var string $table
41      */
42     public $table = 'grade_categories';
44     /**
45      * Array of required table fields, must start with 'id'.
46      * @var array $required_fields
47      */
48     public $required_fields = array('id', 'courseid', 'parent', 'depth', 'path', 'fullname', 'aggregation',
49                                  'keephigh', 'droplow', 'aggregateonlygraded', 'aggregateoutcomes',
50                                  'aggregatesubcats', 'timecreated', 'timemodified', 'hidden');
52     /**
53      * The course this category belongs to.
54      * @var int $courseid
55      */
56     public $courseid;
58     /**
59      * The category this category belongs to (optional).
60      * @var int $parent
61      */
62     public $parent;
64     /**
65      * The grade_category object referenced by $this->parent (PK).
66      * @var grade_category $parent_category
67      */
68     public $parent_category;
70     /**
71      * The number of parents this category has.
72      * @var int $depth
73      */
74     public $depth = 0;
76     /**
77      * Shows the hierarchical path for this category as /1/2/3/ (like course_categories), the last number being
78      * this category's autoincrement ID number.
79      * @var string $path
80      */
81     public $path;
83     /**
84      * The name of this category.
85      * @var string $fullname
86      */
87     public $fullname;
89     /**
90      * A constant pointing to one of the predefined aggregation strategies (none, mean, median, sum etc) .
91      * @var int $aggregation
92      */
93     public $aggregation = GRADE_AGGREGATE_MEAN;
95     /**
96      * Keep only the X highest items.
97      * @var int $keephigh
98      */
99     public $keephigh = 0;
101     /**
102      * Drop the X lowest items.
103      * @var int $droplow
104      */
105     public $droplow = 0;
107     /**
108      * Aggregate only graded items
109      * @var int $aggregateonlygraded
110      */
111     public $aggregateonlygraded = 0;
113     /**
114      * Aggregate outcomes together with normal items
115      * @var int $aggregateoutcomes
116      */
117     public $aggregateoutcomes = 0;
119     /**
120      * Ignore subcategories when aggregating
121      * @var int $aggregatesubcats
122      */
123     public $aggregatesubcats = 0;
125     /**
126      * Array of grade_items or grade_categories nested exactly 1 level below this category
127      * @var array $children
128      */
129     public $children;
131     /**
132      * A hierarchical array of all children below this category. This is stored separately from
133      * $children because it is more memory-intensive and may not be used as often.
134      * @var array $all_children
135      */
136     public $all_children;
138     /**
139      * An associated grade_item object, with itemtype=category, used to calculate and cache a set of grade values
140      * for this category.
141      * @var grade_item $grade_item
142      */
143     public $grade_item;
145     /**
146      * Temporary sortorder for speedup of children resorting
147      * @var int $sortorder
148      */
149     public $sortorder;
151     /**
152      * List of options which can be "forced" from site settings.
153      * @var array $forceable
154      */
155     public $forceable = array('aggregation', 'keephigh', 'droplow', 'aggregateonlygraded', 'aggregateoutcomes', 'aggregatesubcats');
157     /**
158      * String representing the aggregation coefficient. Variable is used as cache.
159      * @var string $coefstring
160      */
161     public $coefstring = null;
163     /**
164      * Static variable storing the result from {@link self::can_apply_limit_rules}.
165      * @var bool
166      */
167     protected $canapplylimitrules;
169     /**
170      * Builds this category's path string based on its parents (if any) and its own id number.
171      * This is typically done just before inserting this object in the DB for the first time,
172      * or when a new parent is added or changed. It is a recursive function: once the calling
173      * object no longer has a parent, the path is complete.
174      *
175      * @param grade_category $grade_category A Grade_Category object
176      * @return string The category's path string
177      */
178     public static function build_path($grade_category) {
179         global $DB;
181         if (empty($grade_category->parent)) {
182             return '/'.$grade_category->id.'/';
184         } else {
185             $parent = $DB->get_record('grade_categories', array('id' => $grade_category->parent));
186             return grade_category::build_path($parent).$grade_category->id.'/';
187         }
188     }
190     /**
191      * Finds and returns a grade_category instance based on params.
192      *
193      * @param array $params associative arrays varname=>value
194      * @return grade_category The retrieved grade_category instance or false if none found.
195      */
196     public static function fetch($params) {
197         return grade_object::fetch_helper('grade_categories', 'grade_category', $params);
198     }
200     /**
201      * Finds and returns all grade_category instances based on params.
202      *
203      * @param array $params associative arrays varname=>value
204      * @return array array of grade_category insatnces or false if none found.
205      */
206     public static function fetch_all($params) {
207         return grade_object::fetch_all_helper('grade_categories', 'grade_category', $params);
208     }
210     /**
211      * In addition to update() as defined in grade_object, call force_regrading of parent categories, if applicable.
212      *
213      * @param string $source from where was the object updated (mod/forum, manual, etc.)
214      * @return bool success
215      */
216     public function update($source=null) {
217         // load the grade item or create a new one
218         $this->load_grade_item();
220         // force recalculation of path;
221         if (empty($this->path)) {
222             $this->path  = grade_category::build_path($this);
223             $this->depth = substr_count($this->path, '/') - 1;
224             $updatechildren = true;
226         } else {
227             $updatechildren = false;
228         }
230         $this->apply_forced_settings();
232         // these are exclusive
233         if ($this->droplow > 0) {
234             $this->keephigh = 0;
236         } else if ($this->keephigh > 0) {
237             $this->droplow = 0;
238         }
240         // Recalculate grades if needed
241         if ($this->qualifies_for_regrading()) {
242             $this->force_regrading();
243         }
245         $this->timemodified = time();
247         $result = parent::update($source);
249         // now update paths in all child categories
250         if ($result and $updatechildren) {
252             if ($children = grade_category::fetch_all(array('parent'=>$this->id))) {
254                 foreach ($children as $child) {
255                     $child->path  = null;
256                     $child->depth = 0;
257                     $child->update($source);
258                 }
259             }
260         }
262         return $result;
263     }
265     /**
266      * If parent::delete() is successful, send force_regrading message to parent category.
267      *
268      * @param string $source from where was the object deleted (mod/forum, manual, etc.)
269      * @return bool success
270      */
271     public function delete($source=null) {
272         $grade_item = $this->load_grade_item();
274         if ($this->is_course_category()) {
276             if ($categories = grade_category::fetch_all(array('courseid'=>$this->courseid))) {
278                 foreach ($categories as $category) {
280                     if ($category->id == $this->id) {
281                         continue; // do not delete course category yet
282                     }
283                     $category->delete($source);
284                 }
285             }
287             if ($items = grade_item::fetch_all(array('courseid'=>$this->courseid))) {
289                 foreach ($items as $item) {
291                     if ($item->id == $grade_item->id) {
292                         continue; // do not delete course item yet
293                     }
294                     $item->delete($source);
295                 }
296             }
298         } else {
299             $this->force_regrading();
301             $parent = $this->load_parent_category();
303             // Update children's categoryid/parent field first
304             if ($children = grade_item::fetch_all(array('categoryid'=>$this->id))) {
305                 foreach ($children as $child) {
306                     $child->set_parent($parent->id);
307                 }
308             }
310             if ($children = grade_category::fetch_all(array('parent'=>$this->id))) {
311                 foreach ($children as $child) {
312                     $child->set_parent($parent->id);
313                 }
314             }
315         }
317         // first delete the attached grade item and grades
318         $grade_item->delete($source);
320         // delete category itself
321         return parent::delete($source);
322     }
324     /**
325      * In addition to the normal insert() defined in grade_object, this method sets the depth
326      * and path for this object, and update the record accordingly.
327      *
328      * We do this here instead of in the constructor as they both need to know the record's
329      * ID number, which only gets created at insertion time.
330      * This method also creates an associated grade_item if this wasn't done during construction.
331      *
332      * @param string $source from where was the object inserted (mod/forum, manual, etc.)
333      * @return int PK ID if successful, false otherwise
334      */
335     public function insert($source=null) {
337         if (empty($this->courseid)) {
338             print_error('cannotinsertgrade');
339         }
341         if (empty($this->parent)) {
342             $course_category = grade_category::fetch_course_category($this->courseid);
343             $this->parent = $course_category->id;
344         }
346         $this->path = null;
348         $this->timecreated = $this->timemodified = time();
350         if (!parent::insert($source)) {
351             debugging("Could not insert this category: " . print_r($this, true));
352             return false;
353         }
355         $this->force_regrading();
357         // build path and depth
358         $this->update($source);
360         return $this->id;
361     }
363     /**
364      * Internal function - used only from fetch_course_category()
365      * Normal insert() can not be used for course category
366      *
367      * @param int $courseid The course ID
368      * @return int The ID of the new course category
369      */
370     public function insert_course_category($courseid) {
371         $this->courseid    = $courseid;
372         $this->fullname    = '?';
373         $this->path        = null;
374         $this->parent      = null;
375         $this->aggregation = GRADE_AGGREGATE_WEIGHTED_MEAN2;
377         $this->apply_default_settings();
378         $this->apply_forced_settings();
380         $this->timecreated = $this->timemodified = time();
382         if (!parent::insert('system')) {
383             debugging("Could not insert this category: " . print_r($this, true));
384             return false;
385         }
387         // build path and depth
388         $this->update('system');
390         return $this->id;
391     }
393     /**
394      * Compares the values held by this object with those of the matching record in DB, and returns
395      * whether or not these differences are sufficient to justify an update of all parent objects.
396      * This assumes that this object has an ID number and a matching record in DB. If not, it will return false.
397      *
398      * @return bool
399      */
400     public function qualifies_for_regrading() {
401         if (empty($this->id)) {
402             debugging("Can not regrade non existing category");
403             return false;
404         }
406         $db_item = grade_category::fetch(array('id'=>$this->id));
408         $aggregationdiff = $db_item->aggregation         != $this->aggregation;
409         $keephighdiff    = $db_item->keephigh            != $this->keephigh;
410         $droplowdiff     = $db_item->droplow             != $this->droplow;
411         $aggonlygrddiff  = $db_item->aggregateonlygraded != $this->aggregateonlygraded;
412         $aggoutcomesdiff = $db_item->aggregateoutcomes   != $this->aggregateoutcomes;
413         $aggsubcatsdiff  = $db_item->aggregatesubcats    != $this->aggregatesubcats;
415         return ($aggregationdiff || $keephighdiff || $droplowdiff || $aggonlygrddiff || $aggoutcomesdiff || $aggsubcatsdiff);
416     }
418     /**
419      * Marks this grade categories' associated grade item as needing regrading
420      */
421     public function force_regrading() {
422         $grade_item = $this->load_grade_item();
423         $grade_item->force_regrading();
424     }
426     /**
427      * Something that should be called before we start regrading the whole course.
428      *
429      * @return void
430      */
431     public function pre_regrade_final_grades() {
432         $this->auto_update_weights();
433         $this->auto_update_max();
434     }
436     /**
437      * Generates and saves final grades in associated category grade item.
438      * These immediate children must already have their own final grades.
439      * The category's aggregation method is used to generate final grades.
440      *
441      * Please note that category grade is either calculated or aggregated, not both at the same time.
442      *
443      * This method must be used ONLY from grade_item::regrade_final_grades(),
444      * because the calculation must be done in correct order!
445      *
446      * Steps to follow:
447      *  1. Get final grades from immediate children
448      *  3. Aggregate these grades
449      *  4. Save them in final grades of associated category grade item
450      *
451      * @param int $userid The user ID if final grade generation should be limited to a single user
452      * @return bool
453      */
454     public function generate_grades($userid=null) {
455         global $CFG, $DB;
457         $this->load_grade_item();
459         if ($this->grade_item->is_locked()) {
460             return true; // no need to recalculate locked items
461         }
463         // find grade items of immediate children (category or grade items) and force site settings
464         $depends_on = $this->grade_item->depends_on();
466         if (empty($depends_on)) {
467             $items = false;
469         } else {
470             list($usql, $params) = $DB->get_in_or_equal($depends_on);
471             $sql = "SELECT *
472                       FROM {grade_items}
473                      WHERE id $usql";
474             $items = $DB->get_records_sql($sql, $params);
475         }
477         $grade_inst = new grade_grade();
478         $fields = 'g.'.implode(',g.', $grade_inst->required_fields);
480         // where to look for final grades - include grade of this item too, we will store the results there
481         $gis = array_merge($depends_on, array($this->grade_item->id));
482         list($usql, $params) = $DB->get_in_or_equal($gis);
484         if ($userid) {
485             $usersql = "AND g.userid=?";
486             $params[] = $userid;
488         } else {
489             $usersql = "";
490         }
492         $sql = "SELECT $fields
493                   FROM {grade_grades} g, {grade_items} gi
494                  WHERE gi.id = g.itemid AND gi.id $usql $usersql
495               ORDER BY g.userid";
497         // group the results by userid and aggregate the grades for this user
498         $rs = $DB->get_recordset_sql($sql, $params);
499         if ($rs->valid()) {
500             $prevuser = 0;
501             $grade_values = array();
502             $excluded     = array();
503             $oldgrade     = null;
504             $grademaxoverrides = array();
505             $grademinoverrides = array();
507             foreach ($rs as $used) {
509                 if ($used->userid != $prevuser) {
510                     $this->aggregate_grades($prevuser,
511                                             $items,
512                                             $grade_values,
513                                             $oldgrade,
514                                             $excluded,
515                                             $grademinoverrides,
516                                             $grademaxoverrides);
517                     $prevuser = $used->userid;
518                     $grade_values = array();
519                     $excluded     = array();
520                     $oldgrade     = null;
521                     $grademaxoverrides = array();
522                     $grademinoverrides = array();
523                 }
524                 $grade_values[$used->itemid] = $used->finalgrade;
525                 $grademaxoverrides[$used->itemid] = $used->rawgrademax;
526                 $grademinoverrides[$used->itemid] = $used->rawgrademin;
528                 if ($used->excluded) {
529                     $excluded[] = $used->itemid;
530                 }
532                 if ($this->grade_item->id == $used->itemid) {
533                     $oldgrade = $used;
534                 }
535             }
536             $this->aggregate_grades($prevuser,
537                                     $items,
538                                     $grade_values,
539                                     $oldgrade,
540                                     $excluded,
541                                     $grademinoverrides,
542                                     $grademaxoverrides);//the last one
543         }
544         $rs->close();
546         return true;
547     }
549     /**
550      * Internal function for grade category grade aggregation
551      *
552      * @param int    $userid The User ID
553      * @param array  $items Grade items
554      * @param array  $grade_values Array of grade values
555      * @param object $oldgrade Old grade
556      * @param array  $excluded Excluded
557      * @param array  $grademinoverrides User specific grademin values if different to the grade_item grademin (key is itemid)
558      * @param array  $grademaxoverrides User specific grademax values if different to the grade_item grademax (key is itemid)
559      */
560     private function aggregate_grades($userid,
561                                       $items,
562                                       $grade_values,
563                                       $oldgrade,
564                                       $excluded,
565                                       $grademinoverrides,
566                                       $grademaxoverrides) {
567         global $CFG, $DB;
569         // Remember these so we can set flags on them to describe how they were used in the aggregation.
570         $novalue = array();
571         $dropped = array();
572         $extracredit = array();
573         $usedweights = array();
575         if (empty($userid)) {
576             //ignore first call
577             return;
578         }
580         if ($oldgrade) {
581             $oldfinalgrade = $oldgrade->finalgrade;
582             $grade = new grade_grade($oldgrade, false);
583             $grade->grade_item =& $this->grade_item;
585         } else {
586             // insert final grade - it will be needed later anyway
587             $grade = new grade_grade(array('itemid'=>$this->grade_item->id, 'userid'=>$userid), false);
588             $grade->grade_item =& $this->grade_item;
589             $grade->insert('system');
590             $oldfinalgrade = null;
591         }
593         // no need to recalculate locked or overridden grades
594         if ($grade->is_locked() or $grade->is_overridden()) {
595             return;
596         }
598         // can not use own final category grade in calculation
599         unset($grade_values[$this->grade_item->id]);
601         // Make sure a grade_grade exists for every grade_item.
602         // We need to do this so we can set the aggregationstatus
603         // with a set_field call instead of checking if each one exists and creating/updating.
604         if (!empty($items)) {
605             list($ggsql, $params) = $DB->get_in_or_equal(array_keys($items), SQL_PARAMS_NAMED, 'g');
608             $params['userid'] = $userid;
609             $sql = "SELECT itemid
610                       FROM {grade_grades}
611                      WHERE itemid $ggsql AND userid = :userid";
612             $existingitems = $DB->get_records_sql($sql, $params);
614             $notexisting = array_diff(array_keys($items), array_keys($existingitems));
615             foreach ($notexisting as $itemid) {
616                 $gradeitem = $items[$itemid];
617                 $gradegrade = new grade_grade(array('itemid' => $itemid,
618                                                     'userid' => $userid,
619                                                     'rawgrademin' => $gradeitem->grademin,
620                                                     'rawgrademax' => $gradeitem->grademax), false);
621                 $gradegrade->grade_item = $gradeitem;
622                 $gradegrade->insert('system');
623             }
624         }
626         // if no grades calculation possible or grading not allowed clear final grade
627         if (empty($grade_values) or empty($items) or ($this->grade_item->gradetype != GRADE_TYPE_VALUE and $this->grade_item->gradetype != GRADE_TYPE_SCALE)) {
628             $grade->finalgrade = null;
630             if (!is_null($oldfinalgrade)) {
631                 $success = $grade->update('aggregation');
633                 // If successful trigger a user_graded event.
634                 if ($success) {
635                     \core\event\user_graded::create_from_grade($grade)->trigger();
636                 }
637             }
638             $dropped = $grade_values;
639             $this->set_usedinaggregation($userid, $usedweights, $novalue, $dropped, $extracredit);
640             return;
641         }
643         // Normalize the grades first - all will have value 0...1
644         // ungraded items are not used in aggregation.
645         foreach ($grade_values as $itemid=>$v) {
646             if (is_null($v)) {
647                 // If null, it means no grade.
648                 if ($this->aggregateonlygraded) {
649                     unset($grade_values[$itemid]);
650                     // Mark this item as "excluded empty" because it has no grade.
651                     $novalue[$itemid] = 0;
652                     continue;
653                 }
654             }
655             if (in_array($itemid, $excluded)) {
656                 unset($grade_values[$itemid]);
657                 $dropped[$itemid] = 0;
658                 continue;
659             }
660             // Check for user specific grade min/max overrides.
661             $usergrademin = $items[$itemid]->grademin;
662             $usergrademax = $items[$itemid]->grademax;
663             if (isset($grademinoverrides[$itemid])) {
664                 $usergrademin = $grademinoverrides[$itemid];
665             }
666             if (isset($grademaxoverrides[$itemid])) {
667                 $usergrademax = $grademaxoverrides[$itemid];
668             }
669             if ($this->aggregation == GRADE_AGGREGATE_SUM) {
670                 // Assume that the grademin is 0 when standardising the score, to preserve negative grades.
671                 $grade_values[$itemid] = grade_grade::standardise_score($v, 0, $usergrademax, 0, 1);
672             } else {
673                 $grade_values[$itemid] = grade_grade::standardise_score($v, $usergrademin, $usergrademax, 0, 1);
674             }
676         }
678         // For items with no value, and not excluded - either set their grade to 0 or exclude them.
679         foreach ($items as $itemid=>$value) {
680             if (!isset($grade_values[$itemid]) and !in_array($itemid, $excluded)) {
681                 if (!$this->aggregateonlygraded) {
682                     $grade_values[$itemid] = 0;
683                 } else {
684                     // We are specifically marking these items as "excluded empty".
685                     $novalue[$itemid] = 0;
686                 }
687             }
688         }
690         // limit and sort
691         $allvalues = $grade_values;
692         if ($this->can_apply_limit_rules()) {
693             $this->apply_limit_rules($grade_values, $items);
694         }
696         $moredropped = array_diff($allvalues, $grade_values);
697         foreach ($moredropped as $drop => $unused) {
698             $dropped[$drop] = 0;
699         }
701         foreach ($grade_values as $itemid => $val) {
702             if (self::is_extracredit_used() && ($items[$itemid]->aggregationcoef > 0)) {
703                 $extracredit[$itemid] = 0;
704             }
705         }
707         asort($grade_values, SORT_NUMERIC);
709         // let's see we have still enough grades to do any statistics
710         if (count($grade_values) == 0) {
711             // not enough attempts yet
712             $grade->finalgrade = null;
714             if (!is_null($oldfinalgrade)) {
715                 $success = $grade->update('aggregation');
717                 // If successful trigger a user_graded event.
718                 if ($success) {
719                     \core\event\user_graded::create_from_grade($grade)->trigger();
720                 }
721             }
722             $this->set_usedinaggregation($userid, $usedweights, $novalue, $dropped, $extracredit);
723             return;
724         }
726         // do the maths
727         $result = $this->aggregate_values_and_adjust_bounds($grade_values,
728                                                             $items,
729                                                             $usedweights,
730                                                             $grademinoverrides,
731                                                             $grademaxoverrides);
732         $agg_grade = $result['grade'];
734         // Set the actual grademin and max to bind the grade properly.
735         $this->grade_item->grademin = $result['grademin'];
736         $this->grade_item->grademax = $result['grademax'];
738         if ($this->aggregation == GRADE_AGGREGATE_SUM) {
739             // The natural aggregation always displays the range as coming from 0 for categories.
740             // However, when we bind the grade we allow for negative values.
741             $result['grademin'] = 0;
742         }
744         // Recalculate the grade back to requested range.
745         $finalgrade = grade_grade::standardise_score($agg_grade, 0, 1, $result['grademin'], $result['grademax']);
746         $grade->finalgrade = $this->grade_item->bounded_grade($finalgrade);
748         $oldrawgrademin = $grade->rawgrademin;
749         $oldrawgrademax = $grade->rawgrademax;
750         $grade->rawgrademin = $result['grademin'];
751         $grade->rawgrademax = $result['grademax'];
753         // Update in db if changed.
754         if (grade_floats_different($grade->finalgrade, $oldfinalgrade) ||
755                 grade_floats_different($grade->rawgrademax, $oldrawgrademax) ||
756                 grade_floats_different($grade->rawgrademin, $oldrawgrademin)) {
757             $success = $grade->update('aggregation');
759             // If successful trigger a user_graded event.
760             if ($success) {
761                 \core\event\user_graded::create_from_grade($grade)->trigger();
762             }
763         }
765         $this->set_usedinaggregation($userid, $usedweights, $novalue, $dropped, $extracredit);
767         return;
768     }
770     /**
771      * Set the flags on the grade_grade items to indicate how individual grades are used
772      * in the aggregation.
773      *
774      * @param int $userid The user we have aggregated the grades for.
775      * @param array $usedweights An array with keys for each of the grade_item columns included in the aggregation. The value are the relative weight.
776      * @param array $novalue An array with keys for each of the grade_item columns skipped because
777      *                       they had no value in the aggregation.
778      * @param array $dropped An array with keys for each of the grade_item columns dropped
779      *                       because of any drop lowest/highest settings in the aggregation.
780      * @param array $extracredit An array with keys for each of the grade_item columns
781      *                       considered extra credit by the aggregation.
782      */
783     private function set_usedinaggregation($userid, $usedweights, $novalue, $dropped, $extracredit) {
784         global $DB;
786         // Included.
787         if (!empty($usedweights)) {
788             // The usedweights items are updated individually to record the weights.
789             foreach ($usedweights as $gradeitemid => $contribution) {
790                 $DB->set_field_select('grade_grades',
791                                       'aggregationweight',
792                                       $contribution,
793                                       "itemid = :itemid AND userid = :userid",
794                                       array('itemid'=>$gradeitemid, 'userid'=>$userid));
795             }
797             // Now set the status flag for all these weights.
798             list($itemsql, $itemlist) = $DB->get_in_or_equal(array_keys($usedweights), SQL_PARAMS_NAMED, 'g');
799             $itemlist['userid'] = $userid;
801             $DB->set_field_select('grade_grades',
802                                   'aggregationstatus',
803                                   'used',
804                                   "itemid $itemsql AND userid = :userid",
805                                   $itemlist);
806         }
808         // No value.
809         if (!empty($novalue)) {
810             list($itemsql, $itemlist) = $DB->get_in_or_equal(array_keys($novalue), SQL_PARAMS_NAMED, 'g');
812             $itemlist['userid'] = $userid;
814             $DB->set_field_select('grade_grades',
815                                   'aggregationstatus',
816                                   'novalue',
817                                   "itemid $itemsql AND userid = :userid",
818                                   $itemlist);
819         }
821         // Dropped.
822         if (!empty($dropped)) {
823             list($itemsql, $itemlist) = $DB->get_in_or_equal(array_keys($dropped), SQL_PARAMS_NAMED, 'g');
825             $itemlist['userid'] = $userid;
827             $DB->set_field_select('grade_grades',
828                                   'aggregationstatus',
829                                   'dropped',
830                                   "itemid $itemsql AND userid = :userid",
831                                   $itemlist);
832         }
833         // Extra credit.
834         if (!empty($extracredit)) {
835             list($itemsql, $itemlist) = $DB->get_in_or_equal(array_keys($extracredit), SQL_PARAMS_NAMED, 'g');
837             $itemlist['userid'] = $userid;
839             $DB->set_field_select('grade_grades',
840                                   'aggregationstatus',
841                                   'extra',
842                                   "itemid $itemsql AND userid = :userid",
843                                   $itemlist);
844         }
845     }
847     /**
848      * Internal function that calculates the aggregated grade and new min/max for this grade category
849      *
850      * Must be public as it is used by grade_grade::get_hiding_affected()
851      *
852      * @param array $grade_values An array of values to be aggregated
853      * @param array $items The array of grade_items
854      * @since Moodle 2.6.5, 2.7.2
855      * @param array & $weights If provided, will be filled with the normalized weights
856      *                         for each grade_item as used in the aggregation.
857      *                         Some rules for the weights are:
858      *                         1. The weights must add up to 1 (unless there are extra credit)
859      *                         2. The contributed points column must add up to the course
860      *                         final grade and this column is calculated from these weights.
861      * @param array  $grademinoverrides User specific grademin values if different to the grade_item grademin (key is itemid)
862      * @param array  $grademaxoverrides User specific grademax values if different to the grade_item grademax (key is itemid)
863      * @return array containing values for:
864      *                'grade' => the new calculated grade
865      *                'grademin' => the new calculated min grade for the category
866      *                'grademax' => the new calculated max grade for the category
867      */
868     public function aggregate_values_and_adjust_bounds($grade_values,
869                                                        $items,
870                                                        & $weights = null,
871                                                        $grademinoverrides = array(),
872                                                        $grademaxoverrides = array()) {
873         $category_item = $this->get_grade_item();
874         $grademin = $category_item->grademin;
875         $grademax = $category_item->grademax;
877         switch ($this->aggregation) {
879             case GRADE_AGGREGATE_MEDIAN: // Middle point value in the set: ignores frequencies
880                 $num = count($grade_values);
881                 $grades = array_values($grade_values);
883                 // The median gets 100% - others get 0.
884                 if ($weights !== null && $num > 0) {
885                     $count = 0;
886                     foreach ($grade_values as $itemid=>$grade_value) {
887                         if (($num % 2 == 0) && ($count == intval($num/2)-1 || $count == intval($num/2))) {
888                             $weights[$itemid] = 0.5;
889                         } else if (($num % 2 != 0) && ($count == intval(($num/2)-0.5))) {
890                             $weights[$itemid] = 1.0;
891                         } else {
892                             $weights[$itemid] = 0;
893                         }
894                         $count++;
895                     }
896                 }
897                 if ($num % 2 == 0) {
898                     $agg_grade = ($grades[intval($num/2)-1] + $grades[intval($num/2)]) / 2;
899                 } else {
900                     $agg_grade = $grades[intval(($num/2)-0.5)];
901                 }
903                 break;
905             case GRADE_AGGREGATE_MIN:
906                 $agg_grade = reset($grade_values);
907                 // Record the weights as used.
908                 if ($weights !== null) {
909                     foreach ($grade_values as $itemid=>$grade_value) {
910                         $weights[$itemid] = 0;
911                     }
912                 }
913                 // Set the first item to 1.
914                 $itemids = array_keys($grade_values);
915                 $weights[reset($itemids)] = 1;
916                 break;
918             case GRADE_AGGREGATE_MAX:
919                 // Record the weights as used.
920                 if ($weights !== null) {
921                     foreach ($grade_values as $itemid=>$grade_value) {
922                         $weights[$itemid] = 0;
923                     }
924                 }
925                 // Set the last item to 1.
926                 $itemids = array_keys($grade_values);
927                 $weights[end($itemids)] = 1;
928                 $agg_grade = end($grade_values);
929                 break;
931             case GRADE_AGGREGATE_MODE:       // the most common value
932                 // array_count_values only counts INT and STRING, so if grades are floats we must convert them to string
933                 $converted_grade_values = array();
935                 foreach ($grade_values as $k => $gv) {
937                     if (!is_int($gv) && !is_string($gv)) {
938                         $converted_grade_values[$k] = (string) $gv;
940                     } else {
941                         $converted_grade_values[$k] = $gv;
942                     }
943                     if ($weights !== null) {
944                         $weights[$k] = 0;
945                     }
946                 }
948                 $freq = array_count_values($converted_grade_values);
949                 arsort($freq);                      // sort by frequency keeping keys
950                 $top = reset($freq);               // highest frequency count
951                 $modes = array_keys($freq, $top);  // search for all modes (have the same highest count)
952                 rsort($modes, SORT_NUMERIC);       // get highest mode
953                 $agg_grade = reset($modes);
954                 // Record the weights as used.
955                 if ($weights !== null && $top > 0) {
956                     foreach ($grade_values as $k => $gv) {
957                         if ($gv == $agg_grade) {
958                             $weights[$k] = 1.0 / $top;
959                         }
960                     }
961                 }
962                 break;
964             case GRADE_AGGREGATE_WEIGHTED_MEAN: // Weighted average of all existing final grades, weight specified in coef
965                 $weightsum = 0;
966                 $sum       = 0;
968                 foreach ($grade_values as $itemid=>$grade_value) {
970                     if ($items[$itemid]->aggregationcoef <= 0) {
971                         continue;
972                     }
973                     $weightsum += $items[$itemid]->aggregationcoef;
974                     $sum       += $items[$itemid]->aggregationcoef * $grade_value;
975                     if ($weights !== null) {
976                         $weights[$itemid] = $items[$itemid]->aggregationcoef;
977                     }
978                 }
979                 if ($weightsum == 0) {
980                     $agg_grade = null;
982                 } else {
983                     $agg_grade = $sum / $weightsum;
984                     if ($weights !== null) {
985                         // Normalise the weights.
986                         foreach ($weights as $itemid => $weight) {
987                             $weights[$itemid] = $weight / $weightsum;
988                         }
989                     }
991                 }
992                 break;
994             case GRADE_AGGREGATE_WEIGHTED_MEAN2:
995                 // Weighted average of all existing final grades with optional extra credit flag,
996                 // weight is the range of grade (usually grademax)
997                 $weightsum = 0;
998                 $sum       = null;
1000                 foreach ($grade_values as $itemid=>$grade_value) {
1001                     $weight = $items[$itemid]->grademax - $items[$itemid]->grademin;
1003                     if ($weight <= 0) {
1004                         continue;
1005                     }
1007                     if ($items[$itemid]->aggregationcoef == 0) {
1008                         $weightsum += $weight;
1009                     }
1010                     $sum += $weight * $grade_value;
1011                 }
1012                 if ($weightsum == 0) {
1013                     $agg_grade = $sum; // only extra credits
1015                 } else {
1016                     $agg_grade = $sum / $weightsum;
1017                 }
1018                 // Record the weights as used.
1019                 if ($weights !== null) {
1020                     foreach ($grade_values as $itemid=>$grade_value) {
1021                         if ($weightsum > 0) {
1022                             $weight = $items[$itemid]->grademax - $items[$itemid]->grademin;
1023                             $weights[$itemid] = $weight / $weightsum;
1024                         } else {
1025                             $weights[$itemid] = 0;
1026                         }
1027                     }
1028                 }
1029                 break;
1031             case GRADE_AGGREGATE_EXTRACREDIT_MEAN: // special average
1032                 $num = 0;
1033                 $sum = null;
1035                 foreach ($grade_values as $itemid=>$grade_value) {
1037                     if ($items[$itemid]->aggregationcoef == 0) {
1038                         $num += 1;
1039                         $sum += $grade_value;
1040                         if ($weights !== null) {
1041                             $weights[$itemid] = 1;
1042                         }
1044                     } else if ($items[$itemid]->aggregationcoef > 0) {
1045                         $sum += $items[$itemid]->aggregationcoef * $grade_value;
1046                         if ($weights !== null) {
1047                             $weights[$itemid] = 1;
1048                         }
1049                     }
1050                 }
1051                 if ($weights !== null && $num > 0) {
1052                     foreach ($grade_values as $itemid=>$grade_value) {
1053                         if ($weights[$itemid]) {
1054                             $weights[$itemid] = 1.0 / $num;
1055                         }
1056                     }
1057                 }
1059                 if ($num == 0) {
1060                     $agg_grade = $sum; // only extra credits or wrong coefs
1062                 } else {
1063                     $agg_grade = $sum / $num;
1064                 }
1065                 break;
1067             case GRADE_AGGREGATE_SUM:    // Add up all the items.
1068                 $num = count($grade_values);
1069                 $sum = 0;
1070                 $sumweights = 0;
1071                 $grademin = 0;
1072                 $grademax = 0;
1073                 foreach ($grade_values as $itemid => $gradevalue) {
1074                     // We need to check if the grademax/min was adjusted per user because of excluded items.
1075                     $usergrademin = $items[$itemid]->grademin;
1076                     $usergrademax = $items[$itemid]->grademax;
1077                     if (isset($grademinoverrides[$itemid])) {
1078                         $usergrademin = $grademinoverrides[$itemid];
1079                     }
1080                     if (isset($grademaxoverrides[$itemid])) {
1081                         $usergrademax = $grademaxoverrides[$itemid];
1082                     }
1084                     // Ignore extra credit and items with a weight of 0.
1085                     if ($items[$itemid]->aggregationcoef <= 0 && $items[$itemid]->aggregationcoef2 > 0) {
1086                         $grademin += $usergrademin;
1087                         $grademax += $usergrademax;
1088                         $sumweights += $items[$itemid]->aggregationcoef2;
1089                     }
1090                 }
1091                 $userweights = array();
1092                 $totaloverriddenweight = 0;
1093                 $totaloverriddengrademax = 0;
1094                 // We first need to rescale all manually assigned weights down by the
1095                 // percentage of weights missing from the category.
1096                 foreach ($grade_values as $itemid => $gradevalue) {
1097                     if ($items[$itemid]->weightoverride) {
1098                         if ($items[$itemid]->aggregationcoef2 <= 0) {
1099                             // Records the weight of 0 and continue.
1100                             $userweights[$itemid] = 0;
1101                             continue;
1102                         }
1103                         $userweights[$itemid] = $items[$itemid]->aggregationcoef2 / $sumweights;
1104                         $totaloverriddenweight += $userweights[$itemid];
1105                         $usergrademax = $items[$itemid]->grademax;
1106                         if (isset($grademaxoverrides[$itemid])) {
1107                             $usergrademax = $grademaxoverrides[$itemid];
1108                         }
1109                         $totaloverriddengrademax += $usergrademax;
1110                     }
1111                 }
1112                 $nonoverriddenpoints = $grademax - $totaloverriddengrademax;
1114                 // Then we need to recalculate the automatic weights.
1115                 foreach ($grade_values as $itemid => $gradevalue) {
1116                     if (!$items[$itemid]->weightoverride) {
1117                         $usergrademax = $items[$itemid]->grademax;
1118                         if (isset($grademaxoverrides[$itemid])) {
1119                             $usergrademax = $grademaxoverrides[$itemid];
1120                         }
1121                         if ($nonoverriddenpoints > 0) {
1122                             $userweights[$itemid] = ($usergrademax/$nonoverriddenpoints) * (1 - $totaloverriddenweight);
1123                         } else {
1124                             $userweights[$itemid] = 0;
1125                             if ($items[$itemid]->aggregationcoef2 > 0) {
1126                                 // Items with a weight of 0 should not count for the grade max,
1127                                 // though this only applies if the weight was changed to 0.
1128                                 $grademax -= $usergrademax;
1129                             }
1130                         }
1131                     }
1132                 }
1134                 // We can use our freshly corrected weights below.
1135                 foreach ($grade_values as $itemid => $gradevalue) {
1136                     $sum += $gradevalue * $userweights[$itemid] * $grademax;
1137                     if ($weights !== null) {
1138                         $weights[$itemid] = $userweights[$itemid];
1139                     }
1140                 }
1141                 if ($grademax > 0) {
1142                     $agg_grade = $sum / $grademax; // Re-normalize score.
1143                 } else {
1144                     // Every item in the category is extra credit.
1145                     $agg_grade = $sum;
1146                     $grademax = $sum;
1147                 }
1149                 break;
1151             case GRADE_AGGREGATE_MEAN:    // Arithmetic average of all grade items (if ungraded aggregated, NULL counted as minimum)
1152             default:
1153                 $num = count($grade_values);
1154                 $sum = array_sum($grade_values);
1155                 $agg_grade = $sum / $num;
1156                 // Record the weights evenly.
1157                 if ($weights !== null && $num > 0) {
1158                     foreach ($grade_values as $itemid=>$grade_value) {
1159                         $weights[$itemid] = 1.0 / $num;
1160                     }
1161                 }
1162                 break;
1163         }
1165         return array('grade' => $agg_grade, 'grademin' => $grademin, 'grademax' => $grademax);
1166     }
1168     /**
1169      * Internal function that calculates the aggregated grade for this grade category
1170      *
1171      * Must be public as it is used by grade_grade::get_hiding_affected()
1172      *
1173      * @deprecated since Moodle 2.8
1174      * @param array $grade_values An array of values to be aggregated
1175      * @param array $items The array of grade_items
1176      * @return float The aggregate grade for this grade category
1177      */
1178     public function aggregate_values($grade_values, $items) {
1179         debugging('grade_category::aggregate_values() is deprecated.
1180                    Call grade_category::aggregate_values_and_adjust_bounds() instead.', DEBUG_DEVELOPER);
1181         $result = $this->aggregate_values_and_adjust_bounds($grade_values, $items);
1182         return $result['grade'];
1183     }
1185     /**
1186      * Some aggregation types may need to update their max grade.
1187      *
1188      * This must be executed after updating the weights as it relies on them.
1189      *
1190      * @return void
1191      */
1192     private function auto_update_max() {
1193         global $DB;
1194         if ($this->aggregation != GRADE_AGGREGATE_SUM) {
1195             // not needed at all
1196             return;
1197         }
1199         // Find grade items of immediate children (category or grade items) and force site settings.
1200         $this->load_grade_item();
1201         $depends_on = $this->grade_item->depends_on();
1203         $items = false;
1204         if (!empty($depends_on)) {
1205             list($usql, $params) = $DB->get_in_or_equal($depends_on);
1206             $sql = "SELECT *
1207                       FROM {grade_items}
1208                      WHERE id $usql";
1209             $items = $DB->get_records_sql($sql, $params);
1210         }
1212         if (!$items) {
1214             if ($this->grade_item->grademax != 0 or $this->grade_item->gradetype != GRADE_TYPE_VALUE) {
1215                 $this->grade_item->grademax  = 0;
1216                 $this->grade_item->grademin  = 0;
1217                 $this->grade_item->gradetype = GRADE_TYPE_VALUE;
1218                 $this->grade_item->update('aggregation');
1219             }
1220             return;
1221         }
1223         //find max grade possible
1224         $maxes = array();
1226         foreach ($items as $item) {
1228             if ($item->aggregationcoef > 0) {
1229                 // extra credit from this activity - does not affect total
1230                 continue;
1231             } else if ($item->aggregationcoef2 <= 0) {
1232                 // Items with a weight of 0 do not affect the total.
1233                 continue;
1234             }
1236             if ($item->gradetype == GRADE_TYPE_VALUE) {
1237                 $maxes[$item->id] = $item->grademax;
1239             } else if ($item->gradetype == GRADE_TYPE_SCALE) {
1240                 $maxes[$item->id] = $item->grademax; // 0 = nograde, 1 = first scale item, 2 = second scale item
1241             }
1242         }
1244         if ($this->can_apply_limit_rules()) {
1245             // Apply droplow and keephigh.
1246             $this->apply_limit_rules($maxes, $items);
1247         }
1248         $max = array_sum($maxes);
1250         // update db if anything changed
1251         if ($this->grade_item->grademax != $max or $this->grade_item->grademin != 0 or $this->grade_item->gradetype != GRADE_TYPE_VALUE) {
1252             $this->grade_item->grademax  = $max;
1253             $this->grade_item->grademin  = 0;
1254             $this->grade_item->gradetype = GRADE_TYPE_VALUE;
1255             $this->grade_item->update('aggregation');
1256         }
1257     }
1259     /**
1260      * Recalculate the weights of the grade items in this category.
1261      *
1262      * The category total is not updated here, a further call to
1263      * {@link self::auto_update_max()} is required.
1264      *
1265      * @return void
1266      */
1267     private function auto_update_weights() {
1268         if ($this->aggregation != GRADE_AGGREGATE_SUM) {
1269             // This is only required if we are using natural weights.
1270             return;
1271         }
1272         $children = $this->get_children();
1274         $gradeitem = null;
1276         // Calculate the sum of the grademax's of all the items within this category.
1277         $totalnonoverriddengrademax = 0;
1278         $totalgrademax = 0;
1280         // Out of 1, how much weight has been manually overriden by a user?
1281         $totaloverriddenweight  = 0;
1282         $totaloverriddengrademax  = 0;
1284         // Has every assessment in this category been overridden?
1285         $automaticgradeitemspresent = false;
1286         // Does the grade item require normalising?
1287         $requiresnormalising = false;
1289         // This array keeps track of the id and weight of every grade item that has been overridden.
1290         $overridearray = array();
1291         foreach ($children as $sortorder => $child) {
1292             $gradeitem = null;
1294             if ($child['type'] == 'item') {
1295                 $gradeitem = $child['object'];
1296             } else if ($child['type'] == 'category') {
1297                 $gradeitem = $child['object']->load_grade_item();
1298             }
1300             // Record the ID and the weight for this grade item.
1301             $overridearray[$gradeitem->id] = array();
1302             $overridearray[$gradeitem->id]['extracredit'] = intval($gradeitem->aggregationcoef);
1303             $overridearray[$gradeitem->id]['weight'] = $gradeitem->aggregationcoef2;
1304             $overridearray[$gradeitem->id]['weightoverride'] = intval($gradeitem->weightoverride);
1305             // If this item has had its weight overridden then set the flag to true, but
1306             // only if all previous items were also overridden. Note that extra credit items
1307             // are counted as overridden grade items.
1308             if (!$gradeitem->weightoverride && $gradeitem->aggregationcoef == 0) {
1309                 $automaticgradeitemspresent = true;
1310             }
1312             if ($gradeitem->aggregationcoef > 0) {
1313                 // An extra credit grade item doesn't contribute to $totaloverriddengrademax.
1314                 continue;
1315             } else if ($gradeitem->weightoverride > 0 && $gradeitem->aggregationcoef2 <= 0) {
1316                 // An overriden item that defines a weight of 0 does not contribute to $totaloverriddengrademax.
1317                 continue;
1318             }
1320             $totalgrademax += $gradeitem->grademax;
1321             if ($gradeitem->weightoverride > 0) {
1322                 $totaloverriddenweight += $gradeitem->aggregationcoef2;
1323                 $totaloverriddengrademax += $gradeitem->grademax;
1324             }
1325         }
1327         // Initialise this variable (used to keep track of the weight override total).
1328         $normalisetotal = 0;
1329         // 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
1330         // other weights to zero and normalise the others.
1331         $overriddentotal = 0;
1332         // If the overridden weight total is higher than 1 then set the other untouched weights to zero.
1333         $setotherweightstozero = false;
1334         // Total up all of the weights.
1335         foreach ($overridearray as $gradeitemdetail) {
1336             // If the grade item has extra credit, then don't add it to the normalisetotal.
1337             if (!$gradeitemdetail['extracredit']) {
1338                 $normalisetotal += $gradeitemdetail['weight'];
1339             }
1340             if ($gradeitemdetail['weightoverride'] && !$gradeitemdetail['extracredit']) {
1341                 // Add overriden weights up to see if they are greater than 1.
1342                 $overriddentotal += $gradeitemdetail['weight'];
1343             }
1344         }
1345         if ($overriddentotal > 1) {
1346             // Make sure that this catergory of weights gets normalised.
1347             $requiresnormalising = true;
1348             // The normalised weights are only the overridden weights, so we just use the total of those.
1349             $normalisetotal = $overriddentotal;
1350         }
1352         $totalnonoverriddengrademax = $totalgrademax - $totaloverriddengrademax;
1354         reset($children);
1355         foreach ($children as $sortorder => $child) {
1356             $gradeitem = null;
1358             if ($child['type'] == 'item') {
1359                 $gradeitem = $child['object'];
1360             } else if ($child['type'] == 'category') {
1361                 $gradeitem = $child['object']->load_grade_item();
1362             }
1364             if (!$gradeitem->weightoverride) {
1365                 // Calculations with a grade maximum of zero will cause problems. Just set the weight to zero.
1366                 if ($totaloverriddenweight >= 1 || $totalnonoverriddengrademax == 0 || $gradeitem->grademax == 0) {
1367                     // There is no more weight to distribute.
1368                     $gradeitem->aggregationcoef2 = 0;
1369                 } else {
1370                     // Calculate this item's weight as a percentage of the non-overridden total grade maxes
1371                     // then convert it to a proportion of the available non-overriden weight.
1372                     $gradeitem->aggregationcoef2 = ($gradeitem->grademax/$totalnonoverriddengrademax) *
1373                             (1 - $totaloverriddenweight);
1374                 }
1375                 $gradeitem->update();
1376             } else if ((!$automaticgradeitemspresent && $normalisetotal != 1) || ($requiresnormalising)) {
1377                 // Just divide the overriden weight for this item against the total weight override of all
1378                 // items in this category.
1379                 if ($normalisetotal == 0) {
1380                     $gradeitem->aggregationcoef2 = 0;
1381                 } else {
1382                     $gradeitem->aggregationcoef2 = $overridearray[$gradeitem->id]['weight'] / $normalisetotal;
1383                 }
1384                 // Update the grade item to reflect these changes.
1385                 $gradeitem->update();
1386             }
1387         }
1388     }
1390     /**
1391      * Given an array of grade values (numerical indices) applies droplow or keephigh rules to limit the final array.
1392      *
1393      * @param array $grade_values itemid=>$grade_value float
1394      * @param array $items grade item objects
1395      * @return array Limited grades.
1396      */
1397     public function apply_limit_rules(&$grade_values, $items) {
1398         $extraused = $this->is_extracredit_used();
1400         if (!empty($this->droplow)) {
1401             asort($grade_values, SORT_NUMERIC);
1402             $dropped = 0;
1404             // If we have fewer grade items available to drop than $this->droplow, use this flag to escape the loop
1405             // May occur because of "extra credit" or if droplow is higher than the number of grade items
1406             $droppedsomething = true;
1408             while ($dropped < $this->droplow && $droppedsomething) {
1409                 $droppedsomething = false;
1411                 $grade_keys = array_keys($grade_values);
1412                 $gradekeycount = count($grade_keys);
1414                 if ($gradekeycount === 0) {
1415                     //We've dropped all grade items
1416                     break;
1417                 }
1419                 $originalindex = $founditemid = $foundmax = null;
1421                 // Find the first remaining grade item that is available to be dropped
1422                 foreach ($grade_keys as $gradekeyindex=>$gradekey) {
1423                     if (!$extraused || $items[$gradekey]->aggregationcoef <= 0) {
1424                         // Found a non-extra credit grade item that is eligible to be dropped
1425                         $originalindex = $gradekeyindex;
1426                         $founditemid = $grade_keys[$originalindex];
1427                         $foundmax = $items[$founditemid]->grademax;
1428                         break;
1429                     }
1430                 }
1432                 if (empty($founditemid)) {
1433                     // No grade items available to drop
1434                     break;
1435                 }
1437                 // Now iterate over the remaining grade items
1438                 // We're looking for other grade items with the same grade value but a higher grademax
1439                 $i = 1;
1440                 while ($originalindex + $i < $gradekeycount) {
1442                     $possibleitemid = $grade_keys[$originalindex+$i];
1443                     $i++;
1445                     if ($grade_values[$founditemid] != $grade_values[$possibleitemid]) {
1446                         // The next grade item has a different grade value. Stop looking.
1447                         break;
1448                     }
1450                     if ($extraused && $items[$possibleitemid]->aggregationcoef > 0) {
1451                         // Don't drop extra credit grade items. Continue the search.
1452                         continue;
1453                     }
1455                     if ($foundmax < $items[$possibleitemid]->grademax) {
1456                         // Found a grade item with the same grade value and a higher grademax
1457                         $foundmax = $items[$possibleitemid]->grademax;
1458                         $founditemid = $possibleitemid;
1459                         // Continue searching to see if there is an even higher grademax
1460                     }
1461                 }
1463                 // Now drop whatever grade item we have found
1464                 unset($grade_values[$founditemid]);
1465                 $dropped++;
1466                 $droppedsomething = true;
1467             }
1469         } else if (!empty($this->keephigh)) {
1470             arsort($grade_values, SORT_NUMERIC);
1471             $kept = 0;
1473             foreach ($grade_values as $itemid=>$value) {
1475                 if ($extraused and $items[$itemid]->aggregationcoef > 0) {
1476                     // we keep all extra credits
1478                 } else if ($kept < $this->keephigh) {
1479                     $kept++;
1481                 } else {
1482                     unset($grade_values[$itemid]);
1483                 }
1484             }
1485         }
1486     }
1488     /**
1489      * Returns whether or not we can apply the limit rules.
1490      *
1491      * There are cases where drop lowest or keep highest should not be used
1492      * at all. This method will determine whether or not this logic can be
1493      * applied considering the current setup of the category.
1494      *
1495      * @return bool
1496      */
1497     public function can_apply_limit_rules() {
1498         if ($this->canapplylimitrules !== null) {
1499             return $this->canapplylimitrules;
1500         }
1502         // Set it to be supported by default.
1503         $this->canapplylimitrules = true;
1505         // Natural aggregation.
1506         if ($this->aggregation == GRADE_AGGREGATE_SUM) {
1507             $canapply = true;
1509             // Check until one child breaks the rules.
1510             $gradeitems = $this->get_children();
1511             $validitems = 0;
1512             $lastweight = null;
1513             $lastmaxgrade = null;
1514             foreach ($gradeitems as $gradeitem) {
1515                 $gi = $gradeitem['object'];
1517                 if ($gradeitem['type'] == 'category') {
1518                     // Sub categories are not allowed because they can have dynamic weights/maxgrades.
1519                     $canapply = false;
1520                     break;
1521                 }
1523                 if ($gi->aggregationcoef > 0) {
1524                     // Extra credit items are not allowed.
1525                     $canapply = false;
1526                     break;
1527                 }
1529                 if ($lastweight !== null && $lastweight != $gi->aggregationcoef2) {
1530                     // One of the weight differs from another item.
1531                     $canapply = false;
1532                     break;
1533                 }
1535                 if ($lastmaxgrade !== null && $lastmaxgrade != $gi->grademax) {
1536                     // One of the max grade differ from another item. This is not allowed for now
1537                     // because we could be end up with different max grade between users for this category.
1538                     $canapply = false;
1539                     break;
1540                 }
1542                 $lastweight = $gi->aggregationcoef2;
1543                 $lastmaxgrade = $gi->grademax;
1544             }
1546             $this->canapplylimitrules = $canapply;
1547         }
1549         return $this->canapplylimitrules;
1550     }
1552     /**
1553      * Returns true if category uses extra credit of any kind
1554      *
1555      * @return bool True if extra credit used
1556      */
1557     public function is_extracredit_used() {
1558         return self::aggregation_uses_extracredit($this->aggregation);
1559     }
1561     /**
1562      * Returns true if aggregation passed is using extracredit.
1563      *
1564      * @param int $aggregation Aggregation const.
1565      * @return bool True if extra credit used
1566      */
1567     public static function aggregation_uses_extracredit($aggregation) {
1568         return ($aggregation == GRADE_AGGREGATE_WEIGHTED_MEAN2
1569              or $aggregation == GRADE_AGGREGATE_EXTRACREDIT_MEAN
1570              or $aggregation == GRADE_AGGREGATE_SUM);
1571     }
1573     /**
1574      * Returns true if category uses special aggregation coefficient
1575      *
1576      * @return bool True if an aggregation coefficient is being used
1577      */
1578     public function is_aggregationcoef_used() {
1579         return self::aggregation_uses_aggregationcoef($this->aggregation);
1581     }
1583     /**
1584      * Returns true if aggregation uses aggregationcoef
1585      *
1586      * @param int $aggregation Aggregation const.
1587      * @return bool True if an aggregation coefficient is being used
1588      */
1589     public static function aggregation_uses_aggregationcoef($aggregation) {
1590         return ($aggregation == GRADE_AGGREGATE_WEIGHTED_MEAN
1591              or $aggregation == GRADE_AGGREGATE_WEIGHTED_MEAN2
1592              or $aggregation == GRADE_AGGREGATE_EXTRACREDIT_MEAN
1593              or $aggregation == GRADE_AGGREGATE_SUM);
1595     }
1597     /**
1598      * Recursive function to find which weight/extra credit field to use in the grade item form.
1599      *
1600      * Inherits from a parent category if that category has aggregatesubcats set to true.
1601      *
1602      * @param string $first Whether or not this is the first item in the recursion
1603      * @return string
1604      */
1605     public function get_coefstring($first=true) {
1606         if (!is_null($this->coefstring)) {
1607             return $this->coefstring;
1608         }
1610         $overriding_coefstring = null;
1612         // Stop recursing upwards if this category aggregates subcats or has no parent
1613         if (!$first && !$this->aggregatesubcats) {
1615             if ($parent_category = $this->load_parent_category()) {
1616                 return $parent_category->get_coefstring(false);
1618             } else {
1619                 return null;
1620             }
1622         } else if ($first) {
1624             if (!$this->aggregatesubcats) {
1626                 if ($parent_category = $this->load_parent_category()) {
1627                     $overriding_coefstring = $parent_category->get_coefstring(false);
1628                 }
1629             }
1630         }
1632         // If an overriding coefstring has trickled down from one of the parent categories, return it. Otherwise, return self.
1633         if (!is_null($overriding_coefstring)) {
1634             return $overriding_coefstring;
1635         }
1637         // No parent category is overriding this category's aggregation, return its string
1638         if ($this->aggregation == GRADE_AGGREGATE_WEIGHTED_MEAN) {
1639             $this->coefstring = 'aggregationcoefweight';
1641         } else if ($this->aggregation == GRADE_AGGREGATE_WEIGHTED_MEAN2) {
1642             $this->coefstring = 'aggregationcoefextrasum';
1644         } else if ($this->aggregation == GRADE_AGGREGATE_EXTRACREDIT_MEAN) {
1645             $this->coefstring = 'aggregationcoefextraweight';
1647         } else if ($this->aggregation == GRADE_AGGREGATE_SUM) {
1648             $this->coefstring = 'aggregationcoefextraweightsum';
1650         } else {
1651             $this->coefstring = 'aggregationcoef';
1652         }
1653         return $this->coefstring;
1654     }
1656     /**
1657      * Returns tree with all grade_items and categories as elements
1658      *
1659      * @param int $courseid The course ID
1660      * @param bool $include_category_items as category children
1661      * @return array
1662      */
1663     public static function fetch_course_tree($courseid, $include_category_items=false) {
1664         $course_category = grade_category::fetch_course_category($courseid);
1665         $category_array = array('object'=>$course_category, 'type'=>'category', 'depth'=>1,
1666                                 'children'=>$course_category->get_children($include_category_items));
1668         $course_category->sortorder = $course_category->get_sortorder();
1669         $sortorder = $course_category->get_sortorder();
1670         return grade_category::_fetch_course_tree_recursion($category_array, $sortorder);
1671     }
1673     /**
1674      * An internal function that recursively sorts grade categories within a course
1675      *
1676      * @param array $category_array The seed of the recursion
1677      * @param int   $sortorder The current sortorder
1678      * @return array An array containing 'object', 'type', 'depth' and optionally 'children'
1679      */
1680     static private function _fetch_course_tree_recursion($category_array, &$sortorder) {
1681         // update the sortorder in db if needed
1682         //NOTE: This leads to us resetting sort orders every time the categories and items page is viewed :(
1683         //if ($category_array['object']->sortorder != $sortorder) {
1684             //$category_array['object']->set_sortorder($sortorder);
1685         //}
1687         if (isset($category_array['object']->gradetype) && $category_array['object']->gradetype==GRADE_TYPE_NONE) {
1688             return null;
1689         }
1691         // store the grade_item or grade_category instance with extra info
1692         $result = array('object'=>$category_array['object'], 'type'=>$category_array['type'], 'depth'=>$category_array['depth']);
1694         // reuse final grades if there
1695         if (array_key_exists('finalgrades', $category_array)) {
1696             $result['finalgrades'] = $category_array['finalgrades'];
1697         }
1699         // recursively resort children
1700         if (!empty($category_array['children'])) {
1701             $result['children'] = array();
1702             //process the category item first
1703             $child = null;
1705             foreach ($category_array['children'] as $oldorder=>$child_array) {
1707                 if ($child_array['type'] == 'courseitem' or $child_array['type'] == 'categoryitem') {
1708                     $child = grade_category::_fetch_course_tree_recursion($child_array, $sortorder);
1709                     if (!empty($child)) {
1710                         $result['children'][$sortorder] = $child;
1711                     }
1712                 }
1713             }
1715             foreach ($category_array['children'] as $oldorder=>$child_array) {
1717                 if ($child_array['type'] != 'courseitem' and $child_array['type'] != 'categoryitem') {
1718                     $child = grade_category::_fetch_course_tree_recursion($child_array, $sortorder);
1719                     if (!empty($child)) {
1720                         $result['children'][++$sortorder] = $child;
1721                     }
1722                 }
1723             }
1724         }
1726         return $result;
1727     }
1729     /**
1730      * Fetches and returns all the children categories and/or grade_items belonging to this category.
1731      * By default only returns the immediate children (depth=1), but deeper levels can be requested,
1732      * as well as all levels (0). The elements are indexed by sort order.
1733      *
1734      * @param bool $include_category_items Whether or not to include category grade_items in the children array
1735      * @return array Array of child objects (grade_category and grade_item).
1736      */
1737     public function get_children($include_category_items=false) {
1738         global $DB;
1740         // This function must be as fast as possible ;-)
1741         // fetch all course grade items and categories into memory - we do not expect hundreds of these in course
1742         // we have to limit the number of queries though, because it will be used often in grade reports
1744         $cats  = $DB->get_records('grade_categories', array('courseid' => $this->courseid));
1745         $items = $DB->get_records('grade_items', array('courseid' => $this->courseid));
1747         // init children array first
1748         foreach ($cats as $catid=>$cat) {
1749             $cats[$catid]->children = array();
1750         }
1752         //first attach items to cats and add category sortorder
1753         foreach ($items as $item) {
1755             if ($item->itemtype == 'course' or $item->itemtype == 'category') {
1756                 $cats[$item->iteminstance]->sortorder = $item->sortorder;
1758                 if (!$include_category_items) {
1759                     continue;
1760                 }
1761                 $categoryid = $item->iteminstance;
1763             } else {
1764                 $categoryid = $item->categoryid;
1765                 if (empty($categoryid)) {
1766                     debugging('Found a grade item that isnt in a category');
1767                 }
1768             }
1770             // prevent problems with duplicate sortorders in db
1771             $sortorder = $item->sortorder;
1773             while (array_key_exists($categoryid, $cats)
1774                 && array_key_exists($sortorder, $cats[$categoryid]->children)) {
1776                 $sortorder++;
1777             }
1779             $cats[$categoryid]->children[$sortorder] = $item;
1781         }
1783         // now find the requested category and connect categories as children
1784         $category = false;
1786         foreach ($cats as $catid=>$cat) {
1788             if (empty($cat->parent)) {
1790                 if ($cat->path !== '/'.$cat->id.'/') {
1791                     $grade_category = new grade_category($cat, false);
1792                     $grade_category->path  = '/'.$cat->id.'/';
1793                     $grade_category->depth = 1;
1794                     $grade_category->update('system');
1795                     return $this->get_children($include_category_items);
1796                 }
1798             } else {
1800                 if (empty($cat->path) or !preg_match('|/'.$cat->parent.'/'.$cat->id.'/$|', $cat->path)) {
1801                     //fix paths and depts
1802                     static $recursioncounter = 0; // prevents infinite recursion
1803                     $recursioncounter++;
1805                     if ($recursioncounter < 5) {
1806                         // fix paths and depths!
1807                         $grade_category = new grade_category($cat, false);
1808                         $grade_category->depth = 0;
1809                         $grade_category->path  = null;
1810                         $grade_category->update('system');
1811                         return $this->get_children($include_category_items);
1812                     }
1813                 }
1814                 // prevent problems with duplicate sortorders in db
1815                 $sortorder = $cat->sortorder;
1817                 while (array_key_exists($sortorder, $cats[$cat->parent]->children)) {
1818                     //debugging("$sortorder exists in cat loop");
1819                     $sortorder++;
1820                 }
1822                 $cats[$cat->parent]->children[$sortorder] = &$cats[$catid];
1823             }
1825             if ($catid == $this->id) {
1826                 $category = &$cats[$catid];
1827             }
1828         }
1830         unset($items); // not needed
1831         unset($cats); // not needed
1833         $children_array = grade_category::_get_children_recursion($category);
1835         ksort($children_array);
1837         return $children_array;
1839     }
1841     /**
1842      * Private method used to retrieve all children of this category recursively
1843      *
1844      * @param grade_category $category Source of current recursion
1845      * @return array An array of child grade categories
1846      */
1847     private static function _get_children_recursion($category) {
1849         $children_array = array();
1850         foreach ($category->children as $sortorder=>$child) {
1852             if (array_key_exists('itemtype', $child)) {
1853                 $grade_item = new grade_item($child, false);
1855                 if (in_array($grade_item->itemtype, array('course', 'category'))) {
1856                     $type  = $grade_item->itemtype.'item';
1857                     $depth = $category->depth;
1859                 } else {
1860                     $type  = 'item';
1861                     $depth = $category->depth; // we use this to set the same colour
1862                 }
1863                 $children_array[$sortorder] = array('object'=>$grade_item, 'type'=>$type, 'depth'=>$depth);
1865             } else {
1866                 $children = grade_category::_get_children_recursion($child);
1867                 $grade_category = new grade_category($child, false);
1869                 if (empty($children)) {
1870                     $children = array();
1871                 }
1872                 $children_array[$sortorder] = array('object'=>$grade_category, 'type'=>'category', 'depth'=>$grade_category->depth, 'children'=>$children);
1873             }
1874         }
1876         // sort the array
1877         ksort($children_array);
1879         return $children_array;
1880     }
1882     /**
1883      * Uses {@link get_grade_item()} to load or create a grade_item, then saves it as $this->grade_item.
1884      *
1885      * @return grade_item
1886      */
1887     public function load_grade_item() {
1888         if (empty($this->grade_item)) {
1889             $this->grade_item = $this->get_grade_item();
1890         }
1891         return $this->grade_item;
1892     }
1894     /**
1895      * Retrieves this grade categories' associated grade_item from the database
1896      *
1897      * If no grade_item exists yet, creates one.
1898      *
1899      * @return grade_item
1900      */
1901     public function get_grade_item() {
1902         if (empty($this->id)) {
1903             debugging("Attempt to obtain a grade_category's associated grade_item without the category's ID being set.");
1904             return false;
1905         }
1907         if (empty($this->parent)) {
1908             $params = array('courseid'=>$this->courseid, 'itemtype'=>'course', 'iteminstance'=>$this->id);
1910         } else {
1911             $params = array('courseid'=>$this->courseid, 'itemtype'=>'category', 'iteminstance'=>$this->id);
1912         }
1914         if (!$grade_items = grade_item::fetch_all($params)) {
1915             // create a new one
1916             $grade_item = new grade_item($params, false);
1917             $grade_item->gradetype = GRADE_TYPE_VALUE;
1918             $grade_item->insert('system');
1920         } else if (count($grade_items) == 1) {
1921             // found existing one
1922             $grade_item = reset($grade_items);
1924         } else {
1925             debugging("Found more than one grade_item attached to category id:".$this->id);
1926             // return first one
1927             $grade_item = reset($grade_items);
1928         }
1930         return $grade_item;
1931     }
1933     /**
1934      * Uses $this->parent to instantiate $this->parent_category based on the referenced record in the DB
1935      *
1936      * @return grade_category The parent category
1937      */
1938     public function load_parent_category() {
1939         if (empty($this->parent_category) && !empty($this->parent)) {
1940             $this->parent_category = $this->get_parent_category();
1941         }
1942         return $this->parent_category;
1943     }
1945     /**
1946      * Uses $this->parent to instantiate and return a grade_category object
1947      *
1948      * @return grade_category Returns the parent category or null if this category has no parent
1949      */
1950     public function get_parent_category() {
1951         if (!empty($this->parent)) {
1952             $parent_category = new grade_category(array('id' => $this->parent));
1953             return $parent_category;
1954         } else {
1955             return null;
1956         }
1957     }
1959     /**
1960      * Returns the most descriptive field for this grade category
1961      *
1962      * @return string name
1963      */
1964     public function get_name() {
1965         global $DB;
1966         // For a course category, we return the course name if the fullname is set to '?' in the DB (empty in the category edit form)
1967         if (empty($this->parent) && $this->fullname == '?') {
1968             $course = $DB->get_record('course', array('id'=> $this->courseid));
1969             return format_string($course->fullname);
1971         } else {
1972             return $this->fullname;
1973         }
1974     }
1976     /**
1977      * Describe the aggregation settings for this category so the reports make more sense.
1978      *
1979      * @return string description
1980      */
1981     public function get_description() {
1982         $allhelp = array();
1983         $aggrstrings = grade_helper::get_aggregation_strings();
1984         $allhelp[] = $aggrstrings[$this->aggregation];
1986         if ($this->droplow && $this->can_apply_limit_rules()) {
1987             $allhelp[] = get_string('droplowestvalues', 'grades', $this->droplow);
1988         }
1989         if ($this->keephigh && $this->can_apply_limit_rules()) {
1990             $allhelp[] = get_string('keephighestvalues', 'grades', $this->keephigh);
1991         }
1992         if (!$this->aggregateonlygraded) {
1993             $allhelp[] = get_string('aggregatenotonlygraded', 'grades');
1994         }
1995         if ($this->aggregatesubcats) {
1996             $allhelp[] = get_string('aggregatesubcatsshort', 'grades');
1997         }
1998         return implode('. ', $allhelp) . '.';
1999     }
2001     /**
2002      * Sets this category's parent id
2003      *
2004      * @param int $parentid The ID of the category that is the new parent to $this
2005      * @param string $source From where was the object updated (mod/forum, manual, etc.)
2006      * @return bool success
2007      */
2008     public function set_parent($parentid, $source=null) {
2009         if ($this->parent == $parentid) {
2010             return true;
2011         }
2013         if ($parentid == $this->id) {
2014             print_error('cannotassignselfasparent');
2015         }
2017         if (empty($this->parent) and $this->is_course_category()) {
2018             print_error('cannothaveparentcate');
2019         }
2021         // find parent and check course id
2022         if (!$parent_category = grade_category::fetch(array('id'=>$parentid, 'courseid'=>$this->courseid))) {
2023             return false;
2024         }
2026         $this->force_regrading();
2028         // set new parent category
2029         $this->parent          = $parent_category->id;
2030         $this->parent_category =& $parent_category;
2031         $this->path            = null;       // remove old path and depth - will be recalculated in update()
2032         $this->depth           = 0;          // remove old path and depth - will be recalculated in update()
2033         $this->update($source);
2035         return $this->update($source);
2036     }
2038     /**
2039      * Returns the final grade values for this grade category.
2040      *
2041      * @param int $userid Optional user ID to retrieve a single user's final grade
2042      * @return mixed An array of all final_grades (stdClass objects) for this grade_item, or a single final_grade.
2043      */
2044     public function get_final($userid=null) {
2045         $this->load_grade_item();
2046         return $this->grade_item->get_final($userid);
2047     }
2049     /**
2050      * Returns the sortorder of the grade categories' associated grade_item
2051      *
2052      * This method is also available in grade_item for cases where the object type is not known.
2053      *
2054      * @return int Sort order
2055      */
2056     public function get_sortorder() {
2057         $this->load_grade_item();
2058         return $this->grade_item->get_sortorder();
2059     }
2061     /**
2062      * Returns the idnumber of the grade categories' associated grade_item.
2063      *
2064      * This method is also available in grade_item for cases where the object type is not known.
2065      *
2066      * @return string idnumber
2067      */
2068     public function get_idnumber() {
2069         $this->load_grade_item();
2070         return $this->grade_item->get_idnumber();
2071     }
2073     /**
2074      * Sets the sortorder variable for this category.
2075      *
2076      * This method is also available in grade_item, for cases where the object type is not know.
2077      *
2078      * @param int $sortorder The sortorder to assign to this category
2079      */
2080     public function set_sortorder($sortorder) {
2081         $this->load_grade_item();
2082         $this->grade_item->set_sortorder($sortorder);
2083     }
2085     /**
2086      * Move this category after the given sortorder
2087      *
2088      * Does not change the parent
2089      *
2090      * @param int $sortorder to place after.
2091      * @return void
2092      */
2093     public function move_after_sortorder($sortorder) {
2094         $this->load_grade_item();
2095         $this->grade_item->move_after_sortorder($sortorder);
2096     }
2098     /**
2099      * Return true if this is the top most category that represents the total course grade.
2100      *
2101      * @return bool
2102      */
2103     public function is_course_category() {
2104         $this->load_grade_item();
2105         return $this->grade_item->is_course_item();
2106     }
2108     /**
2109      * Return the course level grade_category object
2110      *
2111      * @param int $courseid The Course ID
2112      * @return grade_category Returns the course level grade_category instance
2113      */
2114     public static function fetch_course_category($courseid) {
2115         if (empty($courseid)) {
2116             debugging('Missing course id!');
2117             return false;
2118         }
2120         // course category has no parent
2121         if ($course_category = grade_category::fetch(array('courseid'=>$courseid, 'parent'=>null))) {
2122             return $course_category;
2123         }
2125         // create a new one
2126         $course_category = new grade_category();
2127         $course_category->insert_course_category($courseid);
2129         return $course_category;
2130     }
2132     /**
2133      * Is grading object editable?
2134      *
2135      * @return bool
2136      */
2137     public function is_editable() {
2138         return true;
2139     }
2141     /**
2142      * Returns the locked state/date of the grade categories' associated grade_item.
2143      *
2144      * This method is also available in grade_item, for cases where the object type is not known.
2145      *
2146      * @return bool
2147      */
2148     public function is_locked() {
2149         $this->load_grade_item();
2150         return $this->grade_item->is_locked();
2151     }
2153     /**
2154      * Sets the grade_item's locked variable and updates the grade_item.
2155      *
2156      * Calls set_locked() on the categories' grade_item
2157      *
2158      * @param int  $lockedstate 0, 1 or a timestamp int(10) after which date the item will be locked.
2159      * @param bool $cascade lock/unlock child objects too
2160      * @param bool $refresh refresh grades when unlocking
2161      * @return bool success if category locked (not all children mayb be locked though)
2162      */
2163     public function set_locked($lockedstate, $cascade=false, $refresh=true) {
2164         $this->load_grade_item();
2166         $result = $this->grade_item->set_locked($lockedstate, $cascade, true);
2168         if ($cascade) {
2169             //process all children - items and categories
2170             if ($children = grade_item::fetch_all(array('categoryid'=>$this->id))) {
2172                 foreach ($children as $child) {
2173                     $child->set_locked($lockedstate, true, false);
2175                     if (empty($lockedstate) and $refresh) {
2176                         //refresh when unlocking
2177                         $child->refresh_grades();
2178                     }
2179                 }
2180             }
2182             if ($children = grade_category::fetch_all(array('parent'=>$this->id))) {
2184                 foreach ($children as $child) {
2185                     $child->set_locked($lockedstate, true, true);
2186                 }
2187             }
2188         }
2190         return $result;
2191     }
2193     /**
2194      * Overrides grade_object::set_properties() to add special handling for changes to category aggregation types
2195      *
2196      * @param stdClass $instance the object to set the properties on
2197      * @param array|stdClass $params Either an associative array or an object containing property name, property value pairs
2198      */
2199     public static function set_properties(&$instance, $params) {
2200         global $DB;
2202         parent::set_properties($instance, $params);
2204         //if they've changed aggregation type we made need to do some fiddling to provide appropriate defaults
2205         if (!empty($params->aggregation)) {
2207             //weight and extra credit share a column :( Would like a default of 1 for weight and 0 for extra credit
2208             //Flip from the default of 0 to 1 (or vice versa) if ALL items in the category are still set to the old default.
2209             if (self::aggregation_uses_aggregationcoef($params->aggregation)) {
2210                 $sql = $defaultaggregationcoef = null;
2212                 if (!self::aggregation_uses_extracredit($params->aggregation)) {
2213                     //if all items in this category have aggregation coefficient of 0 we can change it to 1 ie evenly weighted
2214                     $sql = "select count(id) from {grade_items} where categoryid=:categoryid and aggregationcoef!=0";
2215                     $defaultaggregationcoef = 1;
2216                 } else {
2217                     //if all items in this category have aggregation coefficient of 1 we can change it to 0 ie no extra credit
2218                     $sql = "select count(id) from {grade_items} where categoryid=:categoryid and aggregationcoef!=1";
2219                     $defaultaggregationcoef = 0;
2220                 }
2222                 $params = array('categoryid'=>$instance->id);
2223                 $count = $DB->count_records_sql($sql, $params);
2224                 if ($count===0) { //category is either empty or all items are set to a default value so we can switch defaults
2225                     $params['aggregationcoef'] = $defaultaggregationcoef;
2226                     $DB->execute("update {grade_items} set aggregationcoef=:aggregationcoef where categoryid=:categoryid",$params);
2227                 }
2228             }
2229         }
2230     }
2232     /**
2233      * Sets the grade_item's hidden variable and updates the grade_item.
2234      *
2235      * Overrides grade_item::set_hidden() to add cascading of the hidden value to grade items in this grade category
2236      *
2237      * @param int $hidden 0 mean always visible, 1 means always hidden and a number > 1 is a timestamp to hide until
2238      * @param bool $cascade apply to child objects too
2239      */
2240     public function set_hidden($hidden, $cascade=false) {
2241         $this->load_grade_item();
2242         //this hides the associated grade item (the course total)
2243         $this->grade_item->set_hidden($hidden, $cascade);
2244         //this hides the category itself and everything it contains
2245         parent::set_hidden($hidden, $cascade);
2247         if ($cascade) {
2249             if ($children = grade_item::fetch_all(array('categoryid'=>$this->id))) {
2251                 foreach ($children as $child) {
2252                     if ($child->can_control_visibility()) {
2253                         $child->set_hidden($hidden, $cascade);
2254                     }
2255                 }
2256             }
2258             if ($children = grade_category::fetch_all(array('parent'=>$this->id))) {
2260                 foreach ($children as $child) {
2261                     $child->set_hidden($hidden, $cascade);
2262                 }
2263             }
2264         }
2266         //if marking category visible make sure parent category is visible MDL-21367
2267         if( !$hidden ) {
2268             $category_array = grade_category::fetch_all(array('id'=>$this->parent));
2269             if ($category_array && array_key_exists($this->parent, $category_array)) {
2270                 $category = $category_array[$this->parent];
2271                 //call set_hidden on the category regardless of whether it is hidden as its parent might be hidden
2272                 //if($category->is_hidden()) {
2273                     $category->set_hidden($hidden, false);
2274                 //}
2275             }
2276         }
2277     }
2279     /**
2280      * Applies default settings on this category
2281      *
2282      * @return bool True if anything changed
2283      */
2284     public function apply_default_settings() {
2285         global $CFG;
2287         foreach ($this->forceable as $property) {
2289             if (isset($CFG->{"grade_$property"})) {
2291                 if ($CFG->{"grade_$property"} == -1) {
2292                     continue; //temporary bc before version bump
2293                 }
2294                 $this->$property = $CFG->{"grade_$property"};
2295             }
2296         }
2297     }
2299     /**
2300      * Applies forced settings on this category
2301      *
2302      * @return bool True if anything changed
2303      */
2304     public function apply_forced_settings() {
2305         global $CFG;
2307         $updated = false;
2309         foreach ($this->forceable as $property) {
2311             if (isset($CFG->{"grade_$property"}) and isset($CFG->{"grade_{$property}_flag"}) and
2312                                                     ((int) $CFG->{"grade_{$property}_flag"} & 1)) {
2314                 if ($CFG->{"grade_$property"} == -1) {
2315                     continue; //temporary bc before version bump
2316                 }
2317                 $this->$property = $CFG->{"grade_$property"};
2318                 $updated = true;
2319             }
2320         }
2322         return $updated;
2323     }
2325     /**
2326      * Notification of change in forced category settings.
2327      *
2328      * Causes all course and category grade items to be marked as needing to be updated
2329      */
2330     public static function updated_forced_settings() {
2331         global $CFG, $DB;
2332         $params = array(1, 'course', 'category');
2333         $sql = "UPDATE {grade_items} SET needsupdate=? WHERE itemtype=? or itemtype=?";
2334         $DB->execute($sql, $params);
2335     }