MDL-47463 core_grades: Behat checks the contribution of scales
[moodle.git] / lib / grade / grade_category.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Definition of a class to represent a grade category
19  *
20  * @package   core_grades
21  * @copyright 2006 Nicolas Connault
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 defined('MOODLE_INTERNAL') || die();
27 require_once('grade_object.php');
29 /**
30  * grade_category is an object mapped to DB table {prefix}grade_categories
31  *
32  * @package   core_grades
33  * @category  grade
34  * @copyright 2007 Nicolas Connault
35  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
36  */
37 class grade_category extends grade_object {
38     /**
39      * The DB table.
40      * @var string $table
41      */
42     public $table = 'grade_categories';
44     /**
45      * Array of required table fields, must start with 'id'.
46      * @var array $required_fields
47      */
48     public $required_fields = array('id', 'courseid', 'parent', 'depth', 'path', 'fullname', 'aggregation',
49                                  'keephigh', 'droplow', 'aggregateonlygraded', 'aggregateoutcomes',
50                                  'aggregatesubcats', 'timecreated', 'timemodified', 'hidden');
52     /**
53      * The course this category belongs to.
54      * @var int $courseid
55      */
56     public $courseid;
58     /**
59      * The category this category belongs to (optional).
60      * @var int $parent
61      */
62     public $parent;
64     /**
65      * The grade_category object referenced by $this->parent (PK).
66      * @var grade_category $parent_category
67      */
68     public $parent_category;
70     /**
71      * The number of parents this category has.
72      * @var int $depth
73      */
74     public $depth = 0;
76     /**
77      * Shows the hierarchical path for this category as /1/2/3/ (like course_categories), the last number being
78      * this category's autoincrement ID number.
79      * @var string $path
80      */
81     public $path;
83     /**
84      * The name of this category.
85      * @var string $fullname
86      */
87     public $fullname;
89     /**
90      * A constant pointing to one of the predefined aggregation strategies (none, mean, median, sum etc) .
91      * @var int $aggregation
92      */
93     public $aggregation = GRADE_AGGREGATE_SUM;
95     /**
96      * Keep only the X highest items.
97      * @var int $keephigh
98      */
99     public $keephigh = 0;
101     /**
102      * Drop the X lowest items.
103      * @var int $droplow
104      */
105     public $droplow = 0;
107     /**
108      * Aggregate only graded items
109      * @var int $aggregateonlygraded
110      */
111     public $aggregateonlygraded = 0;
113     /**
114      * Aggregate outcomes together with normal items
115      * @var int $aggregateoutcomes
116      */
117     public $aggregateoutcomes = 0;
119     /**
120      * Ignore subcategories when aggregating
121      * @var int $aggregatesubcats
122      */
123     public $aggregatesubcats = 0;
125     /**
126      * Array of grade_items or grade_categories nested exactly 1 level below this category
127      * @var array $children
128      */
129     public $children;
131     /**
132      * A hierarchical array of all children below this category. This is stored separately from
133      * $children because it is more memory-intensive and may not be used as often.
134      * @var array $all_children
135      */
136     public $all_children;
138     /**
139      * An associated grade_item object, with itemtype=category, used to calculate and cache a set of grade values
140      * for this category.
141      * @var grade_item $grade_item
142      */
143     public $grade_item;
145     /**
146      * Temporary sortorder for speedup of children resorting
147      * @var int $sortorder
148      */
149     public $sortorder;
151     /**
152      * List of options which can be "forced" from site settings.
153      * @var array $forceable
154      */
155     public $forceable = array('aggregation', 'keephigh', 'droplow', 'aggregateonlygraded', 'aggregateoutcomes', 'aggregatesubcats');
157     /**
158      * String representing the aggregation coefficient. Variable is used as cache.
159      * @var string $coefstring
160      */
161     public $coefstring = null;
163     /**
164      * Static variable storing the result from {@link self::can_apply_limit_rules}.
165      * @var bool
166      */
167     protected $canapplylimitrules;
169     /**
170      * Builds this category's path string based on its parents (if any) and its own id number.
171      * This is typically done just before inserting this object in the DB for the first time,
172      * or when a new parent is added or changed. It is a recursive function: once the calling
173      * object no longer has a parent, the path is complete.
174      *
175      * @param grade_category $grade_category A Grade_Category object
176      * @return string The category's path string
177      */
178     public static function build_path($grade_category) {
179         global $DB;
181         if (empty($grade_category->parent)) {
182             return '/'.$grade_category->id.'/';
184         } else {
185             $parent = $DB->get_record('grade_categories', array('id' => $grade_category->parent));
186             return grade_category::build_path($parent).$grade_category->id.'/';
187         }
188     }
190     /**
191      * Finds and returns a grade_category instance based on params.
192      *
193      * @param array $params associative arrays varname=>value
194      * @return grade_category The retrieved grade_category instance or false if none found.
195      */
196     public static function fetch($params) {
197         return grade_object::fetch_helper('grade_categories', 'grade_category', $params);
198     }
200     /**
201      * Finds and returns all grade_category instances based on params.
202      *
203      * @param array $params associative arrays varname=>value
204      * @return array array of grade_category insatnces or false if none found.
205      */
206     public static function fetch_all($params) {
207         return grade_object::fetch_all_helper('grade_categories', 'grade_category', $params);
208     }
210     /**
211      * In addition to update() as defined in grade_object, call force_regrading of parent categories, if applicable.
212      *
213      * @param string $source from where was the object updated (mod/forum, manual, etc.)
214      * @return bool success
215      */
216     public function update($source=null) {
217         // load the grade item or create a new one
218         $this->load_grade_item();
220         // force recalculation of path;
221         if (empty($this->path)) {
222             $this->path  = grade_category::build_path($this);
223             $this->depth = substr_count($this->path, '/') - 1;
224             $updatechildren = true;
226         } else {
227             $updatechildren = false;
228         }
230         $this->apply_forced_settings();
232         // these are exclusive
233         if ($this->droplow > 0) {
234             $this->keephigh = 0;
236         } else if ($this->keephigh > 0) {
237             $this->droplow = 0;
238         }
240         // Recalculate grades if needed
241         if ($this->qualifies_for_regrading()) {
242             $this->force_regrading();
243         }
245         $this->timemodified = time();
247         $result = parent::update($source);
249         // now update paths in all child categories
250         if ($result and $updatechildren) {
252             if ($children = grade_category::fetch_all(array('parent'=>$this->id))) {
254                 foreach ($children as $child) {
255                     $child->path  = null;
256                     $child->depth = 0;
257                     $child->update($source);
258                 }
259             }
260         }
262         return $result;
263     }
265     /**
266      * If parent::delete() is successful, send force_regrading message to parent category.
267      *
268      * @param string $source from where was the object deleted (mod/forum, manual, etc.)
269      * @return bool success
270      */
271     public function delete($source=null) {
272         $grade_item = $this->load_grade_item();
274         if ($this->is_course_category()) {
276             if ($categories = grade_category::fetch_all(array('courseid'=>$this->courseid))) {
278                 foreach ($categories as $category) {
280                     if ($category->id == $this->id) {
281                         continue; // do not delete course category yet
282                     }
283                     $category->delete($source);
284                 }
285             }
287             if ($items = grade_item::fetch_all(array('courseid'=>$this->courseid))) {
289                 foreach ($items as $item) {
291                     if ($item->id == $grade_item->id) {
292                         continue; // do not delete course item yet
293                     }
294                     $item->delete($source);
295                 }
296             }
298         } else {
299             $this->force_regrading();
301             $parent = $this->load_parent_category();
303             // Update children's categoryid/parent field first
304             if ($children = grade_item::fetch_all(array('categoryid'=>$this->id))) {
305                 foreach ($children as $child) {
306                     $child->set_parent($parent->id);
307                 }
308             }
310             if ($children = grade_category::fetch_all(array('parent'=>$this->id))) {
311                 foreach ($children as $child) {
312                     $child->set_parent($parent->id);
313                 }
314             }
315         }
317         // first delete the attached grade item and grades
318         $grade_item->delete($source);
320         // delete category itself
321         return parent::delete($source);
322     }
324     /**
325      * In addition to the normal insert() defined in grade_object, this method sets the depth
326      * and path for this object, and update the record accordingly.
327      *
328      * We do this here instead of in the constructor as they both need to know the record's
329      * ID number, which only gets created at insertion time.
330      * This method also creates an associated grade_item if this wasn't done during construction.
331      *
332      * @param string $source from where was the object inserted (mod/forum, manual, etc.)
333      * @return int PK ID if successful, false otherwise
334      */
335     public function insert($source=null) {
337         if (empty($this->courseid)) {
338             print_error('cannotinsertgrade');
339         }
341         if (empty($this->parent)) {
342             $course_category = grade_category::fetch_course_category($this->courseid);
343             $this->parent = $course_category->id;
344         }
346         $this->path = null;
348         $this->timecreated = $this->timemodified = time();
350         if (!parent::insert($source)) {
351             debugging("Could not insert this category: " . print_r($this, true));
352             return false;
353         }
355         $this->force_regrading();
357         // build path and depth
358         $this->update($source);
360         return $this->id;
361     }
363     /**
364      * Internal function - used only from fetch_course_category()
365      * Normal insert() can not be used for course category
366      *
367      * @param int $courseid The course ID
368      * @return int The ID of the new course category
369      */
370     public function insert_course_category($courseid) {
371         $this->courseid    = $courseid;
372         $this->fullname    = '?';
373         $this->path        = null;
374         $this->parent      = null;
375         $this->aggregation = GRADE_AGGREGATE_WEIGHTED_MEAN2;
377         $this->apply_default_settings();
378         $this->apply_forced_settings();
380         $this->timecreated = $this->timemodified = time();
382         if (!parent::insert('system')) {
383             debugging("Could not insert this category: " . print_r($this, true));
384             return false;
385         }
387         // build path and depth
388         $this->update('system');
390         return $this->id;
391     }
393     /**
394      * Compares the values held by this object with those of the matching record in DB, and returns
395      * whether or not these differences are sufficient to justify an update of all parent objects.
396      * This assumes that this object has an ID number and a matching record in DB. If not, it will return false.
397      *
398      * @return bool
399      */
400     public function qualifies_for_regrading() {
401         if (empty($this->id)) {
402             debugging("Can not regrade non existing category");
403             return false;
404         }
406         $db_item = grade_category::fetch(array('id'=>$this->id));
408         $aggregationdiff = $db_item->aggregation         != $this->aggregation;
409         $keephighdiff    = $db_item->keephigh            != $this->keephigh;
410         $droplowdiff     = $db_item->droplow             != $this->droplow;
411         $aggonlygrddiff  = $db_item->aggregateonlygraded != $this->aggregateonlygraded;
412         $aggoutcomesdiff = $db_item->aggregateoutcomes   != $this->aggregateoutcomes;
413         $aggsubcatsdiff  = $db_item->aggregatesubcats    != $this->aggregatesubcats;
415         return ($aggregationdiff || $keephighdiff || $droplowdiff || $aggonlygrddiff || $aggoutcomesdiff || $aggsubcatsdiff);
416     }
418     /**
419      * Marks this grade categories' associated grade item as needing regrading
420      */
421     public function force_regrading() {
422         $grade_item = $this->load_grade_item();
423         $grade_item->force_regrading();
424     }
426     /**
427      * Something that should be called before we start regrading the whole course.
428      *
429      * @return void
430      */
431     public function pre_regrade_final_grades() {
432         $this->auto_update_weights();
433         $this->auto_update_max();
434     }
436     /**
437      * Generates and saves final grades in associated category grade item.
438      * These immediate children must already have their own final grades.
439      * The category's aggregation method is used to generate final grades.
440      *
441      * Please note that category grade is either calculated or aggregated, not both at the same time.
442      *
443      * This method must be used ONLY from grade_item::regrade_final_grades(),
444      * because the calculation must be done in correct order!
445      *
446      * Steps to follow:
447      *  1. Get final grades from immediate children
448      *  3. Aggregate these grades
449      *  4. Save them in final grades of associated category grade item
450      *
451      * @param int $userid The user ID if final grade generation should be limited to a single user
452      * @return bool
453      */
454     public function generate_grades($userid=null) {
455         global $CFG, $DB;
457         $this->load_grade_item();
459         if ($this->grade_item->is_locked()) {
460             return true; // no need to recalculate locked items
461         }
463         // find grade items of immediate children (category or grade items) and force site settings
464         $depends_on = $this->grade_item->depends_on();
466         if (empty($depends_on)) {
467             $items = false;
469         } else {
470             list($usql, $params) = $DB->get_in_or_equal($depends_on);
471             $sql = "SELECT *
472                       FROM {grade_items}
473                      WHERE id $usql";
474             $items = $DB->get_records_sql($sql, $params);
475         }
477         $grade_inst = new grade_grade();
478         $fields = 'g.'.implode(',g.', $grade_inst->required_fields);
480         // where to look for final grades - include grade of this item too, we will store the results there
481         $gis = array_merge($depends_on, array($this->grade_item->id));
482         list($usql, $params) = $DB->get_in_or_equal($gis);
484         if ($userid) {
485             $usersql = "AND g.userid=?";
486             $params[] = $userid;
488         } else {
489             $usersql = "";
490         }
492         $sql = "SELECT $fields
493                   FROM {grade_grades} g, {grade_items} gi
494                  WHERE gi.id = g.itemid AND gi.id $usql $usersql
495               ORDER BY g.userid";
497         // group the results by userid and aggregate the grades for this user
498         $rs = $DB->get_recordset_sql($sql, $params);
499         if ($rs->valid()) {
500             $prevuser = 0;
501             $grade_values = array();
502             $excluded     = array();
503             $oldgrade     = null;
504             $grademaxoverrides = array();
505             $grademinoverrides = array();
507             foreach ($rs as $used) {
509                 if ($used->userid != $prevuser) {
510                     $this->aggregate_grades($prevuser,
511                                             $items,
512                                             $grade_values,
513                                             $oldgrade,
514                                             $excluded,
515                                             $grademinoverrides,
516                                             $grademaxoverrides);
517                     $prevuser = $used->userid;
518                     $grade_values = array();
519                     $excluded     = array();
520                     $oldgrade     = null;
521                     $grademaxoverrides = array();
522                     $grademinoverrides = array();
523                 }
524                 $grade_values[$used->itemid] = $used->finalgrade;
525                 $grademaxoverrides[$used->itemid] = $used->rawgrademax;
526                 $grademinoverrides[$used->itemid] = $used->rawgrademin;
528                 if ($used->excluded) {
529                     $excluded[] = $used->itemid;
530                 }
532                 if ($this->grade_item->id == $used->itemid) {
533                     $oldgrade = $used;
534                 }
535             }
536             $this->aggregate_grades($prevuser,
537                                     $items,
538                                     $grade_values,
539                                     $oldgrade,
540                                     $excluded,
541                                     $grademinoverrides,
542                                     $grademaxoverrides);//the last one
543         }
544         $rs->close();
546         return true;
547     }
549     /**
550      * Internal function for grade category grade aggregation
551      *
552      * @param int    $userid The User ID
553      * @param array  $items Grade items
554      * @param array  $grade_values Array of grade values
555      * @param object $oldgrade Old grade
556      * @param array  $excluded Excluded
557      * @param array  $grademinoverrides User specific grademin values if different to the grade_item grademin (key is itemid)
558      * @param array  $grademaxoverrides User specific grademax values if different to the grade_item grademax (key is itemid)
559      */
560     private function aggregate_grades($userid,
561                                       $items,
562                                       $grade_values,
563                                       $oldgrade,
564                                       $excluded,
565                                       $grademinoverrides,
566                                       $grademaxoverrides) {
567         global $CFG, $DB;
569         // Remember these so we can set flags on them to describe how they were used in the aggregation.
570         $novalue = array();
571         $dropped = array();
572         $extracredit = array();
573         $usedweights = array();
575         if (empty($userid)) {
576             //ignore first call
577             return;
578         }
580         if ($oldgrade) {
581             $oldfinalgrade = $oldgrade->finalgrade;
582             $grade = new grade_grade($oldgrade, false);
583             $grade->grade_item =& $this->grade_item;
585         } else {
586             // insert final grade - it will be needed later anyway
587             $grade = new grade_grade(array('itemid'=>$this->grade_item->id, 'userid'=>$userid), false);
588             $grade->grade_item =& $this->grade_item;
589             $grade->insert('system');
590             $oldfinalgrade = null;
591         }
593         // no need to recalculate locked or overridden grades
594         if ($grade->is_locked() or $grade->is_overridden()) {
595             return;
596         }
598         // can not use own final category grade in calculation
599         unset($grade_values[$this->grade_item->id]);
601         // Make sure a grade_grade exists for every grade_item.
602         // We need to do this so we can set the aggregationstatus
603         // with a set_field call instead of checking if each one exists and creating/updating.
604         if (!empty($items)) {
605             list($ggsql, $params) = $DB->get_in_or_equal(array_keys($items), SQL_PARAMS_NAMED, 'g');
608             $params['userid'] = $userid;
609             $sql = "SELECT itemid
610                       FROM {grade_grades}
611                      WHERE itemid $ggsql AND userid = :userid";
612             $existingitems = $DB->get_records_sql($sql, $params);
614             $notexisting = array_diff(array_keys($items), array_keys($existingitems));
615             foreach ($notexisting as $itemid) {
616                 $gradeitem = $items[$itemid];
617                 $gradegrade = new grade_grade(array('itemid' => $itemid,
618                                                     'userid' => $userid,
619                                                     'rawgrademin' => $gradeitem->grademin,
620                                                     'rawgrademax' => $gradeitem->grademax), false);
621                 $gradegrade->grade_item = $gradeitem;
622                 $gradegrade->insert('system');
623             }
624         }
626         // if no grades calculation possible or grading not allowed clear final grade
627         if (empty($grade_values) or empty($items) or ($this->grade_item->gradetype != GRADE_TYPE_VALUE and $this->grade_item->gradetype != GRADE_TYPE_SCALE)) {
628             $grade->finalgrade = null;
630             if (!is_null($oldfinalgrade)) {
631                 $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) {
969                     if ($weights !== null) {
970                         $weights[$itemid] = $items[$itemid]->aggregationcoef;
971                     }
972                     if ($items[$itemid]->aggregationcoef <= 0) {
973                         continue;
974                     }
975                     $weightsum += $items[$itemid]->aggregationcoef;
976                     $sum       += $items[$itemid]->aggregationcoef * $grade_value;
977                 }
978                 if ($weightsum == 0) {
979                     $agg_grade = null;
981                 } else {
982                     $agg_grade = $sum / $weightsum;
983                     if ($weights !== null) {
984                         // Normalise the weights.
985                         foreach ($weights as $itemid => $weight) {
986                             $weights[$itemid] = $weight / $weightsum;
987                         }
988                     }
990                 }
991                 break;
993             case GRADE_AGGREGATE_WEIGHTED_MEAN2:
994                 // Weighted average of all existing final grades with optional extra credit flag,
995                 // weight is the range of grade (usually grademax)
996                 $weightsum = 0;
997                 $sum       = null;
999                 foreach ($grade_values as $itemid=>$grade_value) {
1000                     $weight = $items[$itemid]->grademax - $items[$itemid]->grademin;
1002                     if ($weight <= 0) {
1003                         continue;
1004                     }
1006                     if ($items[$itemid]->aggregationcoef == 0) {
1007                         $weightsum += $weight;
1008                     }
1009                     $sum += $weight * $grade_value;
1010                 }
1011                 if ($weightsum == 0) {
1012                     $agg_grade = $sum; // only extra credits
1014                 } else {
1015                     $agg_grade = $sum / $weightsum;
1016                 }
1017                 // Record the weights as used.
1018                 if ($weights !== null) {
1019                     foreach ($grade_values as $itemid=>$grade_value) {
1020                         if ($weightsum > 0) {
1021                             $weight = $items[$itemid]->grademax - $items[$itemid]->grademin;
1022                             $weights[$itemid] = $weight / $weightsum;
1023                         } else {
1024                             $weights[$itemid] = 0;
1025                         }
1026                     }
1027                 }
1028                 break;
1030             case GRADE_AGGREGATE_EXTRACREDIT_MEAN: // special average
1031                 $num = 0;
1032                 $sum = null;
1034                 foreach ($grade_values as $itemid=>$grade_value) {
1036                     if ($items[$itemid]->aggregationcoef == 0) {
1037                         $num += 1;
1038                         $sum += $grade_value;
1039                         if ($weights !== null) {
1040                             $weights[$itemid] = 1;
1041                         }
1043                     } else if ($items[$itemid]->aggregationcoef > 0) {
1044                         $sum += $items[$itemid]->aggregationcoef * $grade_value;
1045                         if ($weights !== null) {
1046                             $weights[$itemid] = 1;
1047                         }
1048                     }
1049                 }
1050                 if ($weights !== null && $num > 0) {
1051                     foreach ($grade_values as $itemid=>$grade_value) {
1052                         if ($weights[$itemid]) {
1053                             $weights[$itemid] = 1.0 / $num;
1054                         }
1055                     }
1056                 }
1058                 if ($num == 0) {
1059                     $agg_grade = $sum; // only extra credits or wrong coefs
1061                 } else {
1062                     $agg_grade = $sum / $num;
1063                 }
1064                 break;
1066             case GRADE_AGGREGATE_SUM:    // Add up all the items.
1067                 $num = count($grade_values);
1068                 $sum = 0;
1069                 $sumweights = 0;
1070                 $grademin = 0;
1071                 $grademax = 0;
1072                 foreach ($grade_values as $itemid => $gradevalue) {
1073                     // We need to check if the grademax/min was adjusted per user because of excluded items.
1074                     $usergrademin = $items[$itemid]->grademin;
1075                     $usergrademax = $items[$itemid]->grademax;
1076                     if (isset($grademinoverrides[$itemid])) {
1077                         $usergrademin = $grademinoverrides[$itemid];
1078                     }
1079                     if (isset($grademaxoverrides[$itemid])) {
1080                         $usergrademax = $grademaxoverrides[$itemid];
1081                     }
1083                     // Ignore extra credit and items with a weight of 0.
1084                     if ($items[$itemid]->aggregationcoef <= 0 && $items[$itemid]->aggregationcoef2 > 0) {
1085                         $grademin += $usergrademin;
1086                         $grademax += $usergrademax;
1087                         $sumweights += $items[$itemid]->aggregationcoef2;
1088                     }
1089                 }
1090                 $userweights = array();
1091                 $totaloverriddenweight = 0;
1092                 $totaloverriddengrademax = 0;
1093                 // We first need to rescale all manually assigned weights down by the
1094                 // percentage of weights missing from the category.
1095                 foreach ($grade_values as $itemid => $gradevalue) {
1096                     if ($items[$itemid]->weightoverride) {
1097                         if ($items[$itemid]->aggregationcoef2 <= 0) {
1098                             // Records the weight of 0 and continue.
1099                             $userweights[$itemid] = 0;
1100                             continue;
1101                         }
1102                         $userweights[$itemid] = $items[$itemid]->aggregationcoef2 / $sumweights;
1103                         $totaloverriddenweight += $userweights[$itemid];
1104                         $usergrademax = $items[$itemid]->grademax;
1105                         if (isset($grademaxoverrides[$itemid])) {
1106                             $usergrademax = $grademaxoverrides[$itemid];
1107                         }
1108                         $totaloverriddengrademax += $usergrademax;
1109                     }
1110                 }
1111                 $nonoverriddenpoints = $grademax - $totaloverriddengrademax;
1113                 // Then we need to recalculate the automatic weights.
1114                 foreach ($grade_values as $itemid => $gradevalue) {
1115                     if (!$items[$itemid]->weightoverride) {
1116                         $usergrademax = $items[$itemid]->grademax;
1117                         if (isset($grademaxoverrides[$itemid])) {
1118                             $usergrademax = $grademaxoverrides[$itemid];
1119                         }
1120                         if ($nonoverriddenpoints > 0) {
1121                             $userweights[$itemid] = ($usergrademax/$nonoverriddenpoints) * (1 - $totaloverriddenweight);
1122                         } else {
1123                             $userweights[$itemid] = 0;
1124                             if ($items[$itemid]->aggregationcoef2 > 0) {
1125                                 // Items with a weight of 0 should not count for the grade max,
1126                                 // though this only applies if the weight was changed to 0.
1127                                 $grademax -= $usergrademax;
1128                             }
1129                         }
1130                     }
1131                 }
1133                 // We can use our freshly corrected weights below.
1134                 foreach ($grade_values as $itemid => $gradevalue) {
1135                     $sum += $gradevalue * $userweights[$itemid] * $grademax;
1136                     if ($weights !== null) {
1137                         $weights[$itemid] = $userweights[$itemid];
1138                     }
1139                 }
1140                 if ($grademax > 0) {
1141                     $agg_grade = $sum / $grademax; // Re-normalize score.
1142                 } else {
1143                     // Every item in the category is extra credit.
1144                     $agg_grade = $sum;
1145                     $grademax = $sum;
1146                 }
1148                 break;
1150             case GRADE_AGGREGATE_MEAN:    // Arithmetic average of all grade items (if ungraded aggregated, NULL counted as minimum)
1151             default:
1152                 $num = count($grade_values);
1153                 $sum = array_sum($grade_values);
1154                 $agg_grade = $sum / $num;
1155                 // Record the weights evenly.
1156                 if ($weights !== null && $num > 0) {
1157                     foreach ($grade_values as $itemid=>$grade_value) {
1158                         $weights[$itemid] = 1.0 / $num;
1159                     }
1160                 }
1161                 break;
1162         }
1164         return array('grade' => $agg_grade, 'grademin' => $grademin, 'grademax' => $grademax);
1165     }
1167     /**
1168      * Internal function that calculates the aggregated grade for this grade category
1169      *
1170      * Must be public as it is used by grade_grade::get_hiding_affected()
1171      *
1172      * @deprecated since Moodle 2.8
1173      * @param array $grade_values An array of values to be aggregated
1174      * @param array $items The array of grade_items
1175      * @return float The aggregate grade for this grade category
1176      */
1177     public function aggregate_values($grade_values, $items) {
1178         debugging('grade_category::aggregate_values() is deprecated.
1179                    Call grade_category::aggregate_values_and_adjust_bounds() instead.', DEBUG_DEVELOPER);
1180         $result = $this->aggregate_values_and_adjust_bounds($grade_values, $items);
1181         return $result['grade'];
1182     }
1184     /**
1185      * Some aggregation types may need to update their max grade.
1186      *
1187      * This must be executed after updating the weights as it relies on them.
1188      *
1189      * @return void
1190      */
1191     private function auto_update_max() {
1192         global $DB;
1193         if ($this->aggregation != GRADE_AGGREGATE_SUM) {
1194             // not needed at all
1195             return;
1196         }
1198         // Find grade items of immediate children (category or grade items) and force site settings.
1199         $this->load_grade_item();
1200         $depends_on = $this->grade_item->depends_on();
1202         $items = false;
1203         if (!empty($depends_on)) {
1204             list($usql, $params) = $DB->get_in_or_equal($depends_on);
1205             $sql = "SELECT *
1206                       FROM {grade_items}
1207                      WHERE id $usql";
1208             $items = $DB->get_records_sql($sql, $params);
1209         }
1211         if (!$items) {
1213             if ($this->grade_item->grademax != 0 or $this->grade_item->gradetype != GRADE_TYPE_VALUE) {
1214                 $this->grade_item->grademax  = 0;
1215                 $this->grade_item->grademin  = 0;
1216                 $this->grade_item->gradetype = GRADE_TYPE_VALUE;
1217                 $this->grade_item->update('aggregation');
1218             }
1219             return;
1220         }
1222         //find max grade possible
1223         $maxes = array();
1225         foreach ($items as $item) {
1227             if ($item->aggregationcoef > 0) {
1228                 // extra credit from this activity - does not affect total
1229                 continue;
1230             } else if ($item->aggregationcoef2 <= 0) {
1231                 // Items with a weight of 0 do not affect the total.
1232                 continue;
1233             }
1235             if ($item->gradetype == GRADE_TYPE_VALUE) {
1236                 $maxes[$item->id] = $item->grademax;
1238             } else if ($item->gradetype == GRADE_TYPE_SCALE) {
1239                 $maxes[$item->id] = $item->grademax; // 0 = nograde, 1 = first scale item, 2 = second scale item
1240             }
1241         }
1243         if ($this->can_apply_limit_rules()) {
1244             // Apply droplow and keephigh.
1245             $this->apply_limit_rules($maxes, $items);
1246         }
1247         $max = array_sum($maxes);
1249         // update db if anything changed
1250         if ($this->grade_item->grademax != $max or $this->grade_item->grademin != 0 or $this->grade_item->gradetype != GRADE_TYPE_VALUE) {
1251             $this->grade_item->grademax  = $max;
1252             $this->grade_item->grademin  = 0;
1253             $this->grade_item->gradetype = GRADE_TYPE_VALUE;
1254             $this->grade_item->update('aggregation');
1255         }
1256     }
1258     /**
1259      * Recalculate the weights of the grade items in this category.
1260      *
1261      * The category total is not updated here, a further call to
1262      * {@link self::auto_update_max()} is required.
1263      *
1264      * @return void
1265      */
1266     private function auto_update_weights() {
1267         if ($this->aggregation != GRADE_AGGREGATE_SUM) {
1268             // This is only required if we are using natural weights.
1269             return;
1270         }
1271         $children = $this->get_children();
1273         $gradeitem = null;
1275         // Calculate the sum of the grademax's of all the items within this category.
1276         $totalnonoverriddengrademax = 0;
1277         $totalgrademax = 0;
1279         // Out of 1, how much weight has been manually overriden by a user?
1280         $totaloverriddenweight  = 0;
1281         $totaloverriddengrademax  = 0;
1283         // Has every assessment in this category been overridden?
1284         $automaticgradeitemspresent = false;
1285         // Does the grade item require normalising?
1286         $requiresnormalising = false;
1288         // This array keeps track of the id and weight of every grade item that has been overridden.
1289         $overridearray = array();
1290         foreach ($children as $sortorder => $child) {
1291             $gradeitem = null;
1293             if ($child['type'] == 'item') {
1294                 $gradeitem = $child['object'];
1295             } else if ($child['type'] == 'category') {
1296                 $gradeitem = $child['object']->load_grade_item();
1297             }
1299             // Record the ID and the weight for this grade item.
1300             $overridearray[$gradeitem->id] = array();
1301             $overridearray[$gradeitem->id]['extracredit'] = intval($gradeitem->aggregationcoef);
1302             $overridearray[$gradeitem->id]['weight'] = $gradeitem->aggregationcoef2;
1303             $overridearray[$gradeitem->id]['weightoverride'] = intval($gradeitem->weightoverride);
1304             // If this item has had its weight overridden then set the flag to true, but
1305             // only if all previous items were also overridden. Note that extra credit items
1306             // are counted as overridden grade items.
1307             if (!$gradeitem->weightoverride && $gradeitem->aggregationcoef == 0) {
1308                 $automaticgradeitemspresent = true;
1309             }
1311             if ($gradeitem->aggregationcoef > 0) {
1312                 // An extra credit grade item doesn't contribute to $totaloverriddengrademax.
1313                 continue;
1314             } else if ($gradeitem->weightoverride > 0 && $gradeitem->aggregationcoef2 <= 0) {
1315                 // An overriden item that defines a weight of 0 does not contribute to $totaloverriddengrademax.
1316                 continue;
1317             }
1319             $totalgrademax += $gradeitem->grademax;
1320             if ($gradeitem->weightoverride > 0) {
1321                 $totaloverriddenweight += $gradeitem->aggregationcoef2;
1322                 $totaloverriddengrademax += $gradeitem->grademax;
1323             }
1324         }
1326         // Initialise this variable (used to keep track of the weight override total).
1327         $normalisetotal = 0;
1328         // 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
1329         // other weights to zero and normalise the others.
1330         $overriddentotal = 0;
1331         // If the overridden weight total is higher than 1 then set the other untouched weights to zero.
1332         $setotherweightstozero = false;
1333         // Total up all of the weights.
1334         foreach ($overridearray as $gradeitemdetail) {
1335             // If the grade item has extra credit, then don't add it to the normalisetotal.
1336             if (!$gradeitemdetail['extracredit']) {
1337                 $normalisetotal += $gradeitemdetail['weight'];
1338             }
1339             if ($gradeitemdetail['weightoverride'] && !$gradeitemdetail['extracredit']) {
1340                 // Add overriden weights up to see if they are greater than 1.
1341                 $overriddentotal += $gradeitemdetail['weight'];
1342             }
1343         }
1344         if ($overriddentotal > 1) {
1345             // Make sure that this catergory of weights gets normalised.
1346             $requiresnormalising = true;
1347             // The normalised weights are only the overridden weights, so we just use the total of those.
1348             $normalisetotal = $overriddentotal;
1349         }
1351         $totalnonoverriddengrademax = $totalgrademax - $totaloverriddengrademax;
1353         reset($children);
1354         foreach ($children as $sortorder => $child) {
1355             $gradeitem = null;
1357             if ($child['type'] == 'item') {
1358                 $gradeitem = $child['object'];
1359             } else if ($child['type'] == 'category') {
1360                 $gradeitem = $child['object']->load_grade_item();
1361             }
1363             if (!$gradeitem->weightoverride) {
1364                 // Calculations with a grade maximum of zero will cause problems. Just set the weight to zero.
1365                 if ($totaloverriddenweight >= 1 || $totalnonoverriddengrademax == 0 || $gradeitem->grademax == 0) {
1366                     // There is no more weight to distribute.
1367                     $gradeitem->aggregationcoef2 = 0;
1368                 } else {
1369                     // Calculate this item's weight as a percentage of the non-overridden total grade maxes
1370                     // then convert it to a proportion of the available non-overriden weight.
1371                     $gradeitem->aggregationcoef2 = ($gradeitem->grademax/$totalnonoverriddengrademax) *
1372                             (1 - $totaloverriddenweight);
1373                 }
1374                 $gradeitem->update();
1375             } else if ((!$automaticgradeitemspresent && $normalisetotal != 1) || ($requiresnormalising)) {
1376                 // Just divide the overriden weight for this item against the total weight override of all
1377                 // items in this category.
1378                 if ($normalisetotal == 0) {
1379                     $gradeitem->aggregationcoef2 = 0;
1380                 } else {
1381                     $gradeitem->aggregationcoef2 = $overridearray[$gradeitem->id]['weight'] / $normalisetotal;
1382                 }
1383                 // Update the grade item to reflect these changes.
1384                 $gradeitem->update();
1385             }
1386         }
1387     }
1389     /**
1390      * Given an array of grade values (numerical indices) applies droplow or keephigh rules to limit the final array.
1391      *
1392      * @param array $grade_values itemid=>$grade_value float
1393      * @param array $items grade item objects
1394      * @return array Limited grades.
1395      */
1396     public function apply_limit_rules(&$grade_values, $items) {
1397         $extraused = $this->is_extracredit_used();
1399         if (!empty($this->droplow)) {
1400             asort($grade_values, SORT_NUMERIC);
1401             $dropped = 0;
1403             // If we have fewer grade items available to drop than $this->droplow, use this flag to escape the loop
1404             // May occur because of "extra credit" or if droplow is higher than the number of grade items
1405             $droppedsomething = true;
1407             while ($dropped < $this->droplow && $droppedsomething) {
1408                 $droppedsomething = false;
1410                 $grade_keys = array_keys($grade_values);
1411                 $gradekeycount = count($grade_keys);
1413                 if ($gradekeycount === 0) {
1414                     //We've dropped all grade items
1415                     break;
1416                 }
1418                 $originalindex = $founditemid = $foundmax = null;
1420                 // Find the first remaining grade item that is available to be dropped
1421                 foreach ($grade_keys as $gradekeyindex=>$gradekey) {
1422                     if (!$extraused || $items[$gradekey]->aggregationcoef <= 0) {
1423                         // Found a non-extra credit grade item that is eligible to be dropped
1424                         $originalindex = $gradekeyindex;
1425                         $founditemid = $grade_keys[$originalindex];
1426                         $foundmax = $items[$founditemid]->grademax;
1427                         break;
1428                     }
1429                 }
1431                 if (empty($founditemid)) {
1432                     // No grade items available to drop
1433                     break;
1434                 }
1436                 // Now iterate over the remaining grade items
1437                 // We're looking for other grade items with the same grade value but a higher grademax
1438                 $i = 1;
1439                 while ($originalindex + $i < $gradekeycount) {
1441                     $possibleitemid = $grade_keys[$originalindex+$i];
1442                     $i++;
1444                     if ($grade_values[$founditemid] != $grade_values[$possibleitemid]) {
1445                         // The next grade item has a different grade value. Stop looking.
1446                         break;
1447                     }
1449                     if ($extraused && $items[$possibleitemid]->aggregationcoef > 0) {
1450                         // Don't drop extra credit grade items. Continue the search.
1451                         continue;
1452                     }
1454                     if ($foundmax < $items[$possibleitemid]->grademax) {
1455                         // Found a grade item with the same grade value and a higher grademax
1456                         $foundmax = $items[$possibleitemid]->grademax;
1457                         $founditemid = $possibleitemid;
1458                         // Continue searching to see if there is an even higher grademax
1459                     }
1460                 }
1462                 // Now drop whatever grade item we have found
1463                 unset($grade_values[$founditemid]);
1464                 $dropped++;
1465                 $droppedsomething = true;
1466             }
1468         } else if (!empty($this->keephigh)) {
1469             arsort($grade_values, SORT_NUMERIC);
1470             $kept = 0;
1472             foreach ($grade_values as $itemid=>$value) {
1474                 if ($extraused and $items[$itemid]->aggregationcoef > 0) {
1475                     // we keep all extra credits
1477                 } else if ($kept < $this->keephigh) {
1478                     $kept++;
1480                 } else {
1481                     unset($grade_values[$itemid]);
1482                 }
1483             }
1484         }
1485     }
1487     /**
1488      * Returns whether or not we can apply the limit rules.
1489      *
1490      * There are cases where drop lowest or keep highest should not be used
1491      * at all. This method will determine whether or not this logic can be
1492      * applied considering the current setup of the category.
1493      *
1494      * @return bool
1495      */
1496     public function can_apply_limit_rules() {
1497         if ($this->canapplylimitrules !== null) {
1498             return $this->canapplylimitrules;
1499         }
1501         // Set it to be supported by default.
1502         $this->canapplylimitrules = true;
1504         // Natural aggregation.
1505         if ($this->aggregation == GRADE_AGGREGATE_SUM) {
1506             $canapply = true;
1508             // Check until one child breaks the rules.
1509             $gradeitems = $this->get_children();
1510             $validitems = 0;
1511             $lastweight = null;
1512             $lastmaxgrade = null;
1513             foreach ($gradeitems as $gradeitem) {
1514                 $gi = $gradeitem['object'];
1516                 if ($gradeitem['type'] == 'category') {
1517                     // Sub categories are not allowed because they can have dynamic weights/maxgrades.
1518                     $canapply = false;
1519                     break;
1520                 }
1522                 if ($gi->aggregationcoef > 0) {
1523                     // Extra credit items are not allowed.
1524                     $canapply = false;
1525                     break;
1526                 }
1528                 if ($lastweight !== null && $lastweight != $gi->aggregationcoef2) {
1529                     // One of the weight differs from another item.
1530                     $canapply = false;
1531                     break;
1532                 }
1534                 if ($lastmaxgrade !== null && $lastmaxgrade != $gi->grademax) {
1535                     // One of the max grade differ from another item. This is not allowed for now
1536                     // because we could be end up with different max grade between users for this category.
1537                     $canapply = false;
1538                     break;
1539                 }
1541                 $lastweight = $gi->aggregationcoef2;
1542                 $lastmaxgrade = $gi->grademax;
1543             }
1545             $this->canapplylimitrules = $canapply;
1546         }
1548         return $this->canapplylimitrules;
1549     }
1551     /**
1552      * Returns true if category uses extra credit of any kind
1553      *
1554      * @return bool True if extra credit used
1555      */
1556     public function is_extracredit_used() {
1557         return self::aggregation_uses_extracredit($this->aggregation);
1558     }
1560     /**
1561      * Returns true if aggregation passed is using extracredit.
1562      *
1563      * @param int $aggregation Aggregation const.
1564      * @return bool True if extra credit used
1565      */
1566     public static function aggregation_uses_extracredit($aggregation) {
1567         return ($aggregation == GRADE_AGGREGATE_WEIGHTED_MEAN2
1568              or $aggregation == GRADE_AGGREGATE_EXTRACREDIT_MEAN
1569              or $aggregation == GRADE_AGGREGATE_SUM);
1570     }
1572     /**
1573      * Returns true if category uses special aggregation coefficient
1574      *
1575      * @return bool True if an aggregation coefficient is being used
1576      */
1577     public function is_aggregationcoef_used() {
1578         return self::aggregation_uses_aggregationcoef($this->aggregation);
1580     }
1582     /**
1583      * Returns true if aggregation uses aggregationcoef
1584      *
1585      * @param int $aggregation Aggregation const.
1586      * @return bool True if an aggregation coefficient is being used
1587      */
1588     public static function aggregation_uses_aggregationcoef($aggregation) {
1589         return ($aggregation == GRADE_AGGREGATE_WEIGHTED_MEAN
1590              or $aggregation == GRADE_AGGREGATE_WEIGHTED_MEAN2
1591              or $aggregation == GRADE_AGGREGATE_EXTRACREDIT_MEAN
1592              or $aggregation == GRADE_AGGREGATE_SUM);
1594     }
1596     /**
1597      * Recursive function to find which weight/extra credit field to use in the grade item form.
1598      *
1599      * Inherits from a parent category if that category has aggregatesubcats set to true.
1600      *
1601      * @param string $first Whether or not this is the first item in the recursion
1602      * @return string
1603      */
1604     public function get_coefstring($first=true) {
1605         if (!is_null($this->coefstring)) {
1606             return $this->coefstring;
1607         }
1609         $overriding_coefstring = null;
1611         // Stop recursing upwards if this category aggregates subcats or has no parent
1612         if (!$first && !$this->aggregatesubcats) {
1614             if ($parent_category = $this->load_parent_category()) {
1615                 return $parent_category->get_coefstring(false);
1617             } else {
1618                 return null;
1619             }
1621         } else if ($first) {
1623             if (!$this->aggregatesubcats) {
1625                 if ($parent_category = $this->load_parent_category()) {
1626                     $overriding_coefstring = $parent_category->get_coefstring(false);
1627                 }
1628             }
1629         }
1631         // If an overriding coefstring has trickled down from one of the parent categories, return it. Otherwise, return self.
1632         if (!is_null($overriding_coefstring)) {
1633             return $overriding_coefstring;
1634         }
1636         // No parent category is overriding this category's aggregation, return its string
1637         if ($this->aggregation == GRADE_AGGREGATE_WEIGHTED_MEAN) {
1638             $this->coefstring = 'aggregationcoefweight';
1640         } else if ($this->aggregation == GRADE_AGGREGATE_WEIGHTED_MEAN2) {
1641             $this->coefstring = 'aggregationcoefextrasum';
1643         } else if ($this->aggregation == GRADE_AGGREGATE_EXTRACREDIT_MEAN) {
1644             $this->coefstring = 'aggregationcoefextraweight';
1646         } else if ($this->aggregation == GRADE_AGGREGATE_SUM) {
1647             $this->coefstring = 'aggregationcoefextraweightsum';
1649         } else {
1650             $this->coefstring = 'aggregationcoef';
1651         }
1652         return $this->coefstring;
1653     }
1655     /**
1656      * Returns tree with all grade_items and categories as elements
1657      *
1658      * @param int $courseid The course ID
1659      * @param bool $include_category_items as category children
1660      * @return array
1661      */
1662     public static function fetch_course_tree($courseid, $include_category_items=false) {
1663         $course_category = grade_category::fetch_course_category($courseid);
1664         $category_array = array('object'=>$course_category, 'type'=>'category', 'depth'=>1,
1665                                 'children'=>$course_category->get_children($include_category_items));
1667         $course_category->sortorder = $course_category->get_sortorder();
1668         $sortorder = $course_category->get_sortorder();
1669         return grade_category::_fetch_course_tree_recursion($category_array, $sortorder);
1670     }
1672     /**
1673      * An internal function that recursively sorts grade categories within a course
1674      *
1675      * @param array $category_array The seed of the recursion
1676      * @param int   $sortorder The current sortorder
1677      * @return array An array containing 'object', 'type', 'depth' and optionally 'children'
1678      */
1679     static private function _fetch_course_tree_recursion($category_array, &$sortorder) {
1680         // update the sortorder in db if needed
1681         //NOTE: This leads to us resetting sort orders every time the categories and items page is viewed :(
1682         //if ($category_array['object']->sortorder != $sortorder) {
1683             //$category_array['object']->set_sortorder($sortorder);
1684         //}
1686         if (isset($category_array['object']->gradetype) && $category_array['object']->gradetype==GRADE_TYPE_NONE) {
1687             return null;
1688         }
1690         // store the grade_item or grade_category instance with extra info
1691         $result = array('object'=>$category_array['object'], 'type'=>$category_array['type'], 'depth'=>$category_array['depth']);
1693         // reuse final grades if there
1694         if (array_key_exists('finalgrades', $category_array)) {
1695             $result['finalgrades'] = $category_array['finalgrades'];
1696         }
1698         // recursively resort children
1699         if (!empty($category_array['children'])) {
1700             $result['children'] = array();
1701             //process the category item first
1702             $child = null;
1704             foreach ($category_array['children'] as $oldorder=>$child_array) {
1706                 if ($child_array['type'] == 'courseitem' or $child_array['type'] == 'categoryitem') {
1707                     $child = grade_category::_fetch_course_tree_recursion($child_array, $sortorder);
1708                     if (!empty($child)) {
1709                         $result['children'][$sortorder] = $child;
1710                     }
1711                 }
1712             }
1714             foreach ($category_array['children'] as $oldorder=>$child_array) {
1716                 if ($child_array['type'] != 'courseitem' and $child_array['type'] != 'categoryitem') {
1717                     $child = grade_category::_fetch_course_tree_recursion($child_array, $sortorder);
1718                     if (!empty($child)) {
1719                         $result['children'][++$sortorder] = $child;
1720                     }
1721                 }
1722             }
1723         }
1725         return $result;
1726     }
1728     /**
1729      * Fetches and returns all the children categories and/or grade_items belonging to this category.
1730      * By default only returns the immediate children (depth=1), but deeper levels can be requested,
1731      * as well as all levels (0). The elements are indexed by sort order.
1732      *
1733      * @param bool $include_category_items Whether or not to include category grade_items in the children array
1734      * @return array Array of child objects (grade_category and grade_item).
1735      */
1736     public function get_children($include_category_items=false) {
1737         global $DB;
1739         // This function must be as fast as possible ;-)
1740         // fetch all course grade items and categories into memory - we do not expect hundreds of these in course
1741         // we have to limit the number of queries though, because it will be used often in grade reports
1743         $cats  = $DB->get_records('grade_categories', array('courseid' => $this->courseid));
1744         $items = $DB->get_records('grade_items', array('courseid' => $this->courseid));
1746         // init children array first
1747         foreach ($cats as $catid=>$cat) {
1748             $cats[$catid]->children = array();
1749         }
1751         //first attach items to cats and add category sortorder
1752         foreach ($items as $item) {
1754             if ($item->itemtype == 'course' or $item->itemtype == 'category') {
1755                 $cats[$item->iteminstance]->sortorder = $item->sortorder;
1757                 if (!$include_category_items) {
1758                     continue;
1759                 }
1760                 $categoryid = $item->iteminstance;
1762             } else {
1763                 $categoryid = $item->categoryid;
1764                 if (empty($categoryid)) {
1765                     debugging('Found a grade item that isnt in a category');
1766                 }
1767             }
1769             // prevent problems with duplicate sortorders in db
1770             $sortorder = $item->sortorder;
1772             while (array_key_exists($categoryid, $cats)
1773                 && array_key_exists($sortorder, $cats[$categoryid]->children)) {
1775                 $sortorder++;
1776             }
1778             $cats[$categoryid]->children[$sortorder] = $item;
1780         }
1782         // now find the requested category and connect categories as children
1783         $category = false;
1785         foreach ($cats as $catid=>$cat) {
1787             if (empty($cat->parent)) {
1789                 if ($cat->path !== '/'.$cat->id.'/') {
1790                     $grade_category = new grade_category($cat, false);
1791                     $grade_category->path  = '/'.$cat->id.'/';
1792                     $grade_category->depth = 1;
1793                     $grade_category->update('system');
1794                     return $this->get_children($include_category_items);
1795                 }
1797             } else {
1799                 if (empty($cat->path) or !preg_match('|/'.$cat->parent.'/'.$cat->id.'/$|', $cat->path)) {
1800                     //fix paths and depts
1801                     static $recursioncounter = 0; // prevents infinite recursion
1802                     $recursioncounter++;
1804                     if ($recursioncounter < 5) {
1805                         // fix paths and depths!
1806                         $grade_category = new grade_category($cat, false);
1807                         $grade_category->depth = 0;
1808                         $grade_category->path  = null;
1809                         $grade_category->update('system');
1810                         return $this->get_children($include_category_items);
1811                     }
1812                 }
1813                 // prevent problems with duplicate sortorders in db
1814                 $sortorder = $cat->sortorder;
1816                 while (array_key_exists($sortorder, $cats[$cat->parent]->children)) {
1817                     //debugging("$sortorder exists in cat loop");
1818                     $sortorder++;
1819                 }
1821                 $cats[$cat->parent]->children[$sortorder] = &$cats[$catid];
1822             }
1824             if ($catid == $this->id) {
1825                 $category = &$cats[$catid];
1826             }
1827         }
1829         unset($items); // not needed
1830         unset($cats); // not needed
1832         $children_array = grade_category::_get_children_recursion($category);
1834         ksort($children_array);
1836         return $children_array;
1838     }
1840     /**
1841      * Private method used to retrieve all children of this category recursively
1842      *
1843      * @param grade_category $category Source of current recursion
1844      * @return array An array of child grade categories
1845      */
1846     private static function _get_children_recursion($category) {
1848         $children_array = array();
1849         foreach ($category->children as $sortorder=>$child) {
1851             if (array_key_exists('itemtype', $child)) {
1852                 $grade_item = new grade_item($child, false);
1854                 if (in_array($grade_item->itemtype, array('course', 'category'))) {
1855                     $type  = $grade_item->itemtype.'item';
1856                     $depth = $category->depth;
1858                 } else {
1859                     $type  = 'item';
1860                     $depth = $category->depth; // we use this to set the same colour
1861                 }
1862                 $children_array[$sortorder] = array('object'=>$grade_item, 'type'=>$type, 'depth'=>$depth);
1864             } else {
1865                 $children = grade_category::_get_children_recursion($child);
1866                 $grade_category = new grade_category($child, false);
1868                 if (empty($children)) {
1869                     $children = array();
1870                 }
1871                 $children_array[$sortorder] = array('object'=>$grade_category, 'type'=>'category', 'depth'=>$grade_category->depth, 'children'=>$children);
1872             }
1873         }
1875         // sort the array
1876         ksort($children_array);
1878         return $children_array;
1879     }
1881     /**
1882      * Uses {@link get_grade_item()} to load or create a grade_item, then saves it as $this->grade_item.
1883      *
1884      * @return grade_item
1885      */
1886     public function load_grade_item() {
1887         if (empty($this->grade_item)) {
1888             $this->grade_item = $this->get_grade_item();
1889         }
1890         return $this->grade_item;
1891     }
1893     /**
1894      * Retrieves this grade categories' associated grade_item from the database
1895      *
1896      * If no grade_item exists yet, creates one.
1897      *
1898      * @return grade_item
1899      */
1900     public function get_grade_item() {
1901         if (empty($this->id)) {
1902             debugging("Attempt to obtain a grade_category's associated grade_item without the category's ID being set.");
1903             return false;
1904         }
1906         if (empty($this->parent)) {
1907             $params = array('courseid'=>$this->courseid, 'itemtype'=>'course', 'iteminstance'=>$this->id);
1909         } else {
1910             $params = array('courseid'=>$this->courseid, 'itemtype'=>'category', 'iteminstance'=>$this->id);
1911         }
1913         if (!$grade_items = grade_item::fetch_all($params)) {
1914             // create a new one
1915             $grade_item = new grade_item($params, false);
1916             $grade_item->gradetype = GRADE_TYPE_VALUE;
1917             $grade_item->insert('system');
1919         } else if (count($grade_items) == 1) {
1920             // found existing one
1921             $grade_item = reset($grade_items);
1923         } else {
1924             debugging("Found more than one grade_item attached to category id:".$this->id);
1925             // return first one
1926             $grade_item = reset($grade_items);
1927         }
1929         return $grade_item;
1930     }
1932     /**
1933      * Uses $this->parent to instantiate $this->parent_category based on the referenced record in the DB
1934      *
1935      * @return grade_category The parent category
1936      */
1937     public function load_parent_category() {
1938         if (empty($this->parent_category) && !empty($this->parent)) {
1939             $this->parent_category = $this->get_parent_category();
1940         }
1941         return $this->parent_category;
1942     }
1944     /**
1945      * Uses $this->parent to instantiate and return a grade_category object
1946      *
1947      * @return grade_category Returns the parent category or null if this category has no parent
1948      */
1949     public function get_parent_category() {
1950         if (!empty($this->parent)) {
1951             $parent_category = new grade_category(array('id' => $this->parent));
1952             return $parent_category;
1953         } else {
1954             return null;
1955         }
1956     }
1958     /**
1959      * Returns the most descriptive field for this grade category
1960      *
1961      * @return string name
1962      */
1963     public function get_name() {
1964         global $DB;
1965         // For a course category, we return the course name if the fullname is set to '?' in the DB (empty in the category edit form)
1966         if (empty($this->parent) && $this->fullname == '?') {
1967             $course = $DB->get_record('course', array('id'=> $this->courseid));
1968             return format_string($course->fullname);
1970         } else {
1971             return $this->fullname;
1972         }
1973     }
1975     /**
1976      * Describe the aggregation settings for this category so the reports make more sense.
1977      *
1978      * @return string description
1979      */
1980     public function get_description() {
1981         $allhelp = array();
1982         if ($this->aggregation != GRADE_AGGREGATE_SUM) {
1983             $aggrstrings = grade_helper::get_aggregation_strings();
1984             $allhelp[] = $aggrstrings[$this->aggregation];
1985         }
1987         if ($this->droplow && $this->can_apply_limit_rules()) {
1988             $allhelp[] = get_string('droplowestvalues', 'grades', $this->droplow);
1989         }
1990         if ($this->keephigh && $this->can_apply_limit_rules()) {
1991             $allhelp[] = get_string('keephighestvalues', 'grades', $this->keephigh);
1992         }
1993         if (!$this->aggregateonlygraded) {
1994             $allhelp[] = get_string('aggregatenotonlygraded', 'grades');
1995         }
1996         if ($this->aggregatesubcats) {
1997             $allhelp[] = get_string('aggregatesubcatsshort', 'grades');
1998         }
1999         if ($allhelp) {
2000             return implode('. ', $allhelp) . '.';
2001         }
2002         return '';
2003     }
2005     /**
2006      * Sets this category's parent id
2007      *
2008      * @param int $parentid The ID of the category that is the new parent to $this
2009      * @param string $source From where was the object updated (mod/forum, manual, etc.)
2010      * @return bool success
2011      */
2012     public function set_parent($parentid, $source=null) {
2013         if ($this->parent == $parentid) {
2014             return true;
2015         }
2017         if ($parentid == $this->id) {
2018             print_error('cannotassignselfasparent');
2019         }
2021         if (empty($this->parent) and $this->is_course_category()) {
2022             print_error('cannothaveparentcate');
2023         }
2025         // find parent and check course id
2026         if (!$parent_category = grade_category::fetch(array('id'=>$parentid, 'courseid'=>$this->courseid))) {
2027             return false;
2028         }
2030         $this->force_regrading();
2032         // set new parent category
2033         $this->parent          = $parent_category->id;
2034         $this->parent_category =& $parent_category;
2035         $this->path            = null;       // remove old path and depth - will be recalculated in update()
2036         $this->depth           = 0;          // remove old path and depth - will be recalculated in update()
2037         $this->update($source);
2039         return $this->update($source);
2040     }
2042     /**
2043      * Returns the final grade values for this grade category.
2044      *
2045      * @param int $userid Optional user ID to retrieve a single user's final grade
2046      * @return mixed An array of all final_grades (stdClass objects) for this grade_item, or a single final_grade.
2047      */
2048     public function get_final($userid=null) {
2049         $this->load_grade_item();
2050         return $this->grade_item->get_final($userid);
2051     }
2053     /**
2054      * Returns the sortorder of the grade categories' associated grade_item
2055      *
2056      * This method is also available in grade_item for cases where the object type is not known.
2057      *
2058      * @return int Sort order
2059      */
2060     public function get_sortorder() {
2061         $this->load_grade_item();
2062         return $this->grade_item->get_sortorder();
2063     }
2065     /**
2066      * Returns the idnumber of the grade categories' associated grade_item.
2067      *
2068      * This method is also available in grade_item for cases where the object type is not known.
2069      *
2070      * @return string idnumber
2071      */
2072     public function get_idnumber() {
2073         $this->load_grade_item();
2074         return $this->grade_item->get_idnumber();
2075     }
2077     /**
2078      * Sets the sortorder variable for this category.
2079      *
2080      * This method is also available in grade_item, for cases where the object type is not know.
2081      *
2082      * @param int $sortorder The sortorder to assign to this category
2083      */
2084     public function set_sortorder($sortorder) {
2085         $this->load_grade_item();
2086         $this->grade_item->set_sortorder($sortorder);
2087     }
2089     /**
2090      * Move this category after the given sortorder
2091      *
2092      * Does not change the parent
2093      *
2094      * @param int $sortorder to place after.
2095      * @return void
2096      */
2097     public function move_after_sortorder($sortorder) {
2098         $this->load_grade_item();
2099         $this->grade_item->move_after_sortorder($sortorder);
2100     }
2102     /**
2103      * Return true if this is the top most category that represents the total course grade.
2104      *
2105      * @return bool
2106      */
2107     public function is_course_category() {
2108         $this->load_grade_item();
2109         return $this->grade_item->is_course_item();
2110     }
2112     /**
2113      * Return the course level grade_category object
2114      *
2115      * @param int $courseid The Course ID
2116      * @return grade_category Returns the course level grade_category instance
2117      */
2118     public static function fetch_course_category($courseid) {
2119         if (empty($courseid)) {
2120             debugging('Missing course id!');
2121             return false;
2122         }
2124         // course category has no parent
2125         if ($course_category = grade_category::fetch(array('courseid'=>$courseid, 'parent'=>null))) {
2126             return $course_category;
2127         }
2129         // create a new one
2130         $course_category = new grade_category();
2131         $course_category->insert_course_category($courseid);
2133         return $course_category;
2134     }
2136     /**
2137      * Is grading object editable?
2138      *
2139      * @return bool
2140      */
2141     public function is_editable() {
2142         return true;
2143     }
2145     /**
2146      * Returns the locked state/date of the grade categories' associated grade_item.
2147      *
2148      * This method is also available in grade_item, for cases where the object type is not known.
2149      *
2150      * @return bool
2151      */
2152     public function is_locked() {
2153         $this->load_grade_item();
2154         return $this->grade_item->is_locked();
2155     }
2157     /**
2158      * Sets the grade_item's locked variable and updates the grade_item.
2159      *
2160      * Calls set_locked() on the categories' grade_item
2161      *
2162      * @param int  $lockedstate 0, 1 or a timestamp int(10) after which date the item will be locked.
2163      * @param bool $cascade lock/unlock child objects too
2164      * @param bool $refresh refresh grades when unlocking
2165      * @return bool success if category locked (not all children mayb be locked though)
2166      */
2167     public function set_locked($lockedstate, $cascade=false, $refresh=true) {
2168         $this->load_grade_item();
2170         $result = $this->grade_item->set_locked($lockedstate, $cascade, true);
2172         if ($cascade) {
2173             //process all children - items and categories
2174             if ($children = grade_item::fetch_all(array('categoryid'=>$this->id))) {
2176                 foreach ($children as $child) {
2177                     $child->set_locked($lockedstate, true, false);
2179                     if (empty($lockedstate) and $refresh) {
2180                         //refresh when unlocking
2181                         $child->refresh_grades();
2182                     }
2183                 }
2184             }
2186             if ($children = grade_category::fetch_all(array('parent'=>$this->id))) {
2188                 foreach ($children as $child) {
2189                     $child->set_locked($lockedstate, true, true);
2190                 }
2191             }
2192         }
2194         return $result;
2195     }
2197     /**
2198      * Overrides grade_object::set_properties() to add special handling for changes to category aggregation types
2199      *
2200      * @param stdClass $instance the object to set the properties on
2201      * @param array|stdClass $params Either an associative array or an object containing property name, property value pairs
2202      */
2203     public static function set_properties(&$instance, $params) {
2204         global $DB;
2206         parent::set_properties($instance, $params);
2208         //if they've changed aggregation type we made need to do some fiddling to provide appropriate defaults
2209         if (!empty($params->aggregation)) {
2211             //weight and extra credit share a column :( Would like a default of 1 for weight and 0 for extra credit
2212             //Flip from the default of 0 to 1 (or vice versa) if ALL items in the category are still set to the old default.
2213             if (self::aggregation_uses_aggregationcoef($params->aggregation)) {
2214                 $sql = $defaultaggregationcoef = null;
2216                 if (!self::aggregation_uses_extracredit($params->aggregation)) {
2217                     //if all items in this category have aggregation coefficient of 0 we can change it to 1 ie evenly weighted
2218                     $sql = "select count(id) from {grade_items} where categoryid=:categoryid and aggregationcoef!=0";
2219                     $defaultaggregationcoef = 1;
2220                 } else {
2221                     //if all items in this category have aggregation coefficient of 1 we can change it to 0 ie no extra credit
2222                     $sql = "select count(id) from {grade_items} where categoryid=:categoryid and aggregationcoef!=1";
2223                     $defaultaggregationcoef = 0;
2224                 }
2226                 $params = array('categoryid'=>$instance->id);
2227                 $count = $DB->count_records_sql($sql, $params);
2228                 if ($count===0) { //category is either empty or all items are set to a default value so we can switch defaults
2229                     $params['aggregationcoef'] = $defaultaggregationcoef;
2230                     $DB->execute("update {grade_items} set aggregationcoef=:aggregationcoef where categoryid=:categoryid",$params);
2231                 }
2232             }
2233         }
2234     }
2236     /**
2237      * Sets the grade_item's hidden variable and updates the grade_item.
2238      *
2239      * Overrides grade_item::set_hidden() to add cascading of the hidden value to grade items in this grade category
2240      *
2241      * @param int $hidden 0 mean always visible, 1 means always hidden and a number > 1 is a timestamp to hide until
2242      * @param bool $cascade apply to child objects too
2243      */
2244     public function set_hidden($hidden, $cascade=false) {
2245         $this->load_grade_item();
2246         //this hides the associated grade item (the course total)
2247         $this->grade_item->set_hidden($hidden, $cascade);
2248         //this hides the category itself and everything it contains
2249         parent::set_hidden($hidden, $cascade);
2251         if ($cascade) {
2253             if ($children = grade_item::fetch_all(array('categoryid'=>$this->id))) {
2255                 foreach ($children as $child) {
2256                     if ($child->can_control_visibility()) {
2257                         $child->set_hidden($hidden, $cascade);
2258                     }
2259                 }
2260             }
2262             if ($children = grade_category::fetch_all(array('parent'=>$this->id))) {
2264                 foreach ($children as $child) {
2265                     $child->set_hidden($hidden, $cascade);
2266                 }
2267             }
2268         }
2270         //if marking category visible make sure parent category is visible MDL-21367
2271         if( !$hidden ) {
2272             $category_array = grade_category::fetch_all(array('id'=>$this->parent));
2273             if ($category_array && array_key_exists($this->parent, $category_array)) {
2274                 $category = $category_array[$this->parent];
2275                 //call set_hidden on the category regardless of whether it is hidden as its parent might be hidden
2276                 //if($category->is_hidden()) {
2277                     $category->set_hidden($hidden, false);
2278                 //}
2279             }
2280         }
2281     }
2283     /**
2284      * Applies default settings on this category
2285      *
2286      * @return bool True if anything changed
2287      */
2288     public function apply_default_settings() {
2289         global $CFG;
2291         foreach ($this->forceable as $property) {
2293             if (isset($CFG->{"grade_$property"})) {
2295                 if ($CFG->{"grade_$property"} == -1) {
2296                     continue; //temporary bc before version bump
2297                 }
2298                 $this->$property = $CFG->{"grade_$property"};
2299             }
2300         }
2301     }
2303     /**
2304      * Applies forced settings on this category
2305      *
2306      * @return bool True if anything changed
2307      */
2308     public function apply_forced_settings() {
2309         global $CFG;
2311         $updated = false;
2313         foreach ($this->forceable as $property) {
2315             if (isset($CFG->{"grade_$property"}) and isset($CFG->{"grade_{$property}_flag"}) and
2316                                                     ((int) $CFG->{"grade_{$property}_flag"} & 1)) {
2318                 if ($CFG->{"grade_$property"} == -1) {
2319                     continue; //temporary bc before version bump
2320                 }
2321                 $this->$property = $CFG->{"grade_$property"};
2322                 $updated = true;
2323             }
2324         }
2326         return $updated;
2327     }
2329     /**
2330      * Notification of change in forced category settings.
2331      *
2332      * Causes all course and category grade items to be marked as needing to be updated
2333      */
2334     public static function updated_forced_settings() {
2335         global $CFG, $DB;
2336         $params = array(1, 'course', 'category');
2337         $sql = "UPDATE {grade_items} SET needsupdate=? WHERE itemtype=? or itemtype=?";
2338         $DB->execute($sql, $params);
2339     }