mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-01-19 06:18:28 +01:00
Code Issues Projects Releases Wiki Activity

MDL-47064 Grades: Add comments to explain this tricky code.

Browse Source 
Part of: MDL-46576
This commit is contained in:
Damyon Wiese 2014-09-24 13:22:41 +08:00 committed by Adrian Greeve
parent 852fae0b71
commit 6070e53313
3 changed files with 45 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
grade/report/user/lib.php
View File

@ -350,6 +350,14 @@ class grade_report_user extends grade_report {
return true;
}
/**
* Fill the table with data.
*
* @param $element - An array containing the table data for the current row.
* @param $aggregationhints - An array that collects the aggregationhints for every
* grade_item. The hints contain grade, grademin, grademax
* status, weight and parent.
*/
private function fill_table_recursive(&$element, &$aggregationhints = array()) {
global $DB, $CFG;
@ -660,6 +668,8 @@ class grade_report_user extends grade_report {
}
}
// Check we are showing this column, and we are looking at the root of the table.
// This should be the very last thing this fill_table_recursive function does.
if ($this->showcontributiontocoursetotal && ($type == 'category' && $depth == 1)) {
// We should have collected all the hints by now - walk the tree again and build the contributions column.
@ -667,6 +677,16 @@ class grade_report_user extends grade_report {
}
}
/**
* This function is called after the table has been built and the aggregationhints
* have been collected. We need this info to walk up the list of parents of each
* grade_item.
*
* @param $element - An array containing the table data for the current row.
* @param $aggregationhints - An array that collects the aggregationhints for every
* grade_item. The hints contain grade, grademin, grademax
* status, weight and parent.
*/
public function fill_contributions_column($element, $aggregationhints) {
/// Recursively iterate through all child elements
@ -675,33 +695,46 @@ class grade_report_user extends grade_report {
$this->fill_contributions_column($element['children'][$key], $aggregationhints);
}
} else if ($element['type'] == 'item') {
// This is a grade item (We don't do this for categories or we would double count).
$grade_object = $element['object'];
$itemid = $grade_object->id;
// Ignore anything with no hint - e.g. a hidden row.
if (isset($aggregationhints[$itemid])) {
// Normalise the gradeval.
$graderange = $aggregationhints[$itemid]['grademax'] - $aggregationhints[$itemid]['grademin'];
$gradeval = ($aggregationhints[$itemid]['grade'] - $aggregationhints[$itemid]['grademin']) / $graderange;
// Multiply the normalised value by the weight
// of all the categories higher in the tree.
$parent = $aggregationhints[$itemid]['parent'];
do {
if (!is_null($aggregationhints[$itemid]['weight'])) {
$gradeval *= $aggregationhints[$itemid]['weight'];
}
// The second part of this if is to prevent infinite loops
// in case of crazy data.
if (isset($aggregationhints[$itemid]['parent']) &&
$aggregationhints[$itemid]['parent'] != $itemid) {
$parent = $aggregationhints[$itemid]['parent'];
$itemid = $parent;
} else {
// We are at the top of the tree
$parent = false;
}
} while ($parent);
// Finally multiply by the course grademax.
$gradeval *= $aggregationhints[$itemid]['grademax'];
// Now we need to loop through the "built" table data and update the
// contributions column for the current row.
$header_row = "row_{$grade_object->id}_{$this->user->id}";
foreach ($this->tabledata as $key => $row) {
if (isset($row['itemname']) &&
($row['itemname']['id'] == $header_row)) {
// Found it - update the column.
$decimals = $grade_object->get_decimals();
$this->tabledata[$key]['contributiontocoursetotal']['content'] = format_float($gradeval, $decimals, true);
break;

11
lib/grade/grade_category.php
View File

@ -599,6 +599,8 @@ class grade_category extends grade_object {
unset($grade_values[$this->grade_item->id]);
// Make sure a grade_grade exists for every grade_item.
// We need to do this so we can set the aggregationstatus
// with a set_field call instead of checking if each one exists and creating/updating.
foreach ($items as $itemid => $gradeitem) {
$gradegrade = new grade_grade(array('itemid' => $gradeitem->id,
'userid' => $userid,
@ -630,6 +632,7 @@ class grade_category extends grade_object {
// If null, it means no grade.
if ($this->aggregateonlygraded) {
unset($grade_values[$itemid]);
// Mark this item as dropped because it has no grade.
$novalue[$itemid] = 0;
continue;
}
@ -657,6 +660,8 @@ class grade_category extends grade_object {
if (!$this->aggregateonlygraded) {
$grade_values[$itemid] = 0;
} else {
// We are specifically marking these items that get dropped
// because they are empty.
$novalue[$itemid] = 0;
}
}
@ -726,9 +731,11 @@ class grade_category extends grade_object {
* @param int $userid The user we have aggregated the grades for.
* @param array $usedweights An array with keys for each of the grade_item columns included in the aggregation. The value are the relative weight.
* @param array $novalue An array with keys for each of the grade_item columns skipped because
* they had no value in the aggregation
* they had no value in the aggregation.
* @param array $dropped An array with keys for each of the grade_item columns dropped
* because of any drop lowest/highest settings in the aggregation
* because of any drop lowest/highest settings in the aggregation.
* @param array $extracredit An array with keys for each of the grade_item columns
* considered extra credit by the aggregation.
*/
private function set_usedinaggregation($userid, $usedweights, $novalue, $dropped, $extracredit) {
global $DB;

3
lib/grade/grade_grade.php
View File

@ -672,6 +672,9 @@ class grade_grade extends grade_object {
* unknown => list of item ids that may be affected by hiding (with the calculated grade as the value)
* altered => list of item ids that are definitely affected by hiding (with the calculated grade as the value)
* alteredgrademax => for each item in altered or unknown, the new value of the grademax
* alteredgrademin => for each item in altered or unknown, the new value of the grademin
* alteredgradestatus => for each item with a modified status - the value of the new status
* alteredgradeweight => for each item with a modified weight - the value of the new weight
*/
public static function get_hiding_affected(&$grade_grades, &$grade_items) {
global $CFG;