MDL-32676 improve YUI init performance via combo loader caching
[moodle.git] / grade / report / user / lib.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 the grade_user_report class is defined
19  *
20  * @package gradereport_user
21  * @copyright 2007 Nicolas Connault
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 require_once($CFG->dirroot . '/grade/report/lib.php');
26 require_once($CFG->libdir.'/tablelib.php');
28 //showhiddenitems values
29 define("GRADE_REPORT_USER_HIDE_HIDDEN", 0);
30 define("GRADE_REPORT_USER_HIDE_UNTIL", 1);
31 define("GRADE_REPORT_USER_SHOW_HIDDEN", 2);
33 /**
34  * Class providing an API for the user report building and displaying.
35  * @uses grade_report
36  * @package gradereport_user
37  */
38 class grade_report_user extends grade_report {
40     /**
41      * The user.
42      * @var object $user
43      */
44     public $user;
46     /**
47      * A flexitable to hold the data.
48      * @var object $table
49      */
50     public $table;
52     /**
53      * An array of table headers
54      * @var array
55      */
56     public $tableheaders = array();
58     /**
59      * An array of table columns
60      * @var array
61      */
62     public $tablecolumns = array();
64     /**
65      * An array containing rows of data for the table.
66      * @var type
67      */
68     public $tabledata = array();
70     /**
71      * The grade tree structure
72      * @var grade_tree
73      */
74     public $gtree;
76     /**
77      * Flat structure similar to grade tree
78      */
79     public $gseq;
81     /**
82      * show student ranks
83      */
84     public $showrank;
86     /**
87      * show grade percentages
88      */
89     public $showpercentage;
91     /**
92      * Show range
93      */
94     public $showrange = true;
96     /**
97      * Show grades in the report, default true
98      * @var bool
99      */
100     public $showgrade = true;
102     /**
103      * Decimal points to use for values in the report, default 2
104      * @var int
105      */
106     public $decimals = 2;
108     /**
109      * The number of decimal places to round range to, default 0
110      * @var int
111      */
112     public $rangedecimals = 0;
114     /**
115      * Show grade feedback in the report, default true
116      * @var bool
117      */
118     public $showfeedback = true;
120     /**
121      * Show grade weighting in the report, default false
122      * @var bool
123      */
124     public $showweight = false;
126     /**
127      * Show letter grades in the report, default false
128      * @var bool
129      */
130     public $showlettergrade = false;
132     /**
133      * Show average grades in the report, default false.
134      * @var false
135      */
136     public $showaverage = false;
138     public $maxdepth;
139     public $evenodd;
141     public $canviewhidden;
143     public $switch;
145     /**
146      * Show hidden items even when user does not have required cap
147      */
148     public $showhiddenitems;
149     public $showtotalsifcontainhidden;
151     public $baseurl;
152     public $pbarurl;
154     /**
155      * Constructor. Sets local copies of user preferences and initialises grade_tree.
156      * @param int $courseid
157      * @param object $gpr grade plugin return tracking object
158      * @param string $context
159      * @param int $userid The id of the user
160      */
161     public function __construct($courseid, $gpr, $context, $userid) {
162         global $DB, $CFG;
163         parent::__construct($courseid, $gpr, $context);
165         $this->showrank        = grade_get_setting($this->courseid, 'report_user_showrank', $CFG->grade_report_user_showrank);
166         $this->showpercentage  = grade_get_setting($this->courseid, 'report_user_showpercentage', $CFG->grade_report_user_showpercentage);
167         $this->showhiddenitems = grade_get_setting($this->courseid, 'report_user_showhiddenitems', $CFG->grade_report_user_showhiddenitems);
168         $this->showtotalsifcontainhidden = grade_get_setting($this->courseid, 'report_user_showtotalsifcontainhidden', $CFG->grade_report_user_showtotalsifcontainhidden);
170         $this->showgrade       = grade_get_setting($this->courseid, 'report_user_showgrade',       !empty($CFG->grade_report_user_showgrade));
171         $this->showrange       = grade_get_setting($this->courseid, 'report_user_showrange',       !empty($CFG->grade_report_user_showrange));
172         $this->showfeedback    = grade_get_setting($this->courseid, 'report_user_showfeedback',    !empty($CFG->grade_report_user_showfeedback));
173         $this->showweight      = grade_get_setting($this->courseid, 'report_user_showweight',      !empty($CFG->grade_report_user_showweight));
174         $this->showlettergrade = grade_get_setting($this->courseid, 'report_user_showlettergrade', !empty($CFG->grade_report_user_showlettergrade));
175         $this->showaverage     = grade_get_setting($this->courseid, 'report_user_showaverage',     !empty($CFG->grade_report_user_showaverage));
177         // The default grade decimals is 2
178         $defaultdecimals = 2;
179         if (property_exists($CFG, 'grade_decimalpoints')) {
180             $defaultdecimals = $CFG->grade_decimalpoints;
181         }
182         $this->decimals = grade_get_setting($this->courseid, 'decimalpoints', $defaultdecimals);
184         // The default range decimals is 0
185         $defaultrangedecimals = 0;
186         if (property_exists($CFG, 'grade_report_user_rangedecimals')) {
187             $defaultrangedecimals = $CFG->grade_report_user_rangedecimals;
188         }
189         $this->rangedecimals = grade_get_setting($this->courseid, 'report_user_rangedecimals', $defaultrangedecimals);
191         $this->switch = grade_get_setting($this->courseid, 'aggregationposition', $CFG->grade_aggregationposition);
193         // Grab the grade_tree for this course
194         $this->gtree = new grade_tree($this->courseid, false, $this->switch, null, !$CFG->enableoutcomes);
196         // Determine the number of rows and indentation
197         $this->maxdepth = 1;
198         $this->inject_rowspans($this->gtree->top_element);
199         $this->maxdepth++; // Need to account for the lead column that spans all children
200         for ($i = 1; $i <= $this->maxdepth; $i++) {
201             $this->evenodd[$i] = 0;
202         }
204         $this->tabledata = array();
206         $this->canviewhidden = has_capability('moodle/grade:viewhidden', get_context_instance(CONTEXT_COURSE, $this->courseid));
208         // get the user (for full name)
209         $this->user = $DB->get_record('user', array('id' => $userid));
211         // base url for sorting by first/last name
212         $this->baseurl = $CFG->wwwroot.'/grade/report?id='.$courseid.'&amp;userid='.$userid;
213         $this->pbarurl = $this->baseurl;
215         // no groups on this report - rank is from all course users
216         $this->setup_table();
218         //optionally calculate grade item averages
219         $this->calculate_averages();
220     }
222     function inject_rowspans(&$element) {
223         if ($element['depth'] > $this->maxdepth) {
224             $this->maxdepth = $element['depth'];
225         }
226         if (empty($element['children'])) {
227             return 1;
228         }
229         $count = 1;
230         foreach ($element['children'] as $key=>$child) {
231             $count += $this->inject_rowspans($element['children'][$key]);
232         }
233         $element['rowspan'] = $count;
234         return $count;
235     }
238     /**
239      * Prepares the headers and attributes of the flexitable.
240      */
241     public function setup_table() {
242         /*
243          * Table has 1-8 columns
244          *| All columns except for itemname/description are optional
245          */
247         // setting up table headers
249         $this->tablecolumns = array('itemname');
250         $this->tableheaders = array($this->get_lang_string('gradeitem', 'grades'));
252         if ($this->showweight) {
253             $this->tablecolumns[] = 'weight';
254             $this->tableheaders[] = $this->get_lang_string('weightuc', 'grades');
255         }
257         if ($this->showgrade) {
258             $this->tablecolumns[] = 'grade';
259             $this->tableheaders[] = $this->get_lang_string('grade', 'grades');
260         }
262         if ($this->showrange) {
263             $this->tablecolumns[] = 'range';
264             $this->tableheaders[] = $this->get_lang_string('range', 'grades');
265         }
267         if ($this->showpercentage) {
268             $this->tablecolumns[] = 'percentage';
269             $this->tableheaders[] = $this->get_lang_string('percentage', 'grades');
270         }
272         if ($this->showlettergrade) {
273             $this->tablecolumns[] = 'lettergrade';
274             $this->tableheaders[] = $this->get_lang_string('lettergrade', 'grades');
275         }
277         if ($this->showrank) {
278             $this->tablecolumns[] = 'rank';
279             $this->tableheaders[] = $this->get_lang_string('rank', 'grades');
280         }
282         if ($this->showaverage) {
283             $this->tablecolumns[] = 'average';
284             $this->tableheaders[] = $this->get_lang_string('average', 'grades');
285         }
287         if ($this->showfeedback) {
288             $this->tablecolumns[] = 'feedback';
289             $this->tableheaders[] = $this->get_lang_string('feedback', 'grades');
290         }
291     }
293     function fill_table() {
294         //print "<pre>";
295         //print_r($this->gtree->top_element);
296         $this->fill_table_recursive($this->gtree->top_element);
297         //print_r($this->tabledata);
298         //print "</pre>";
299         return true;
300     }
302     private function fill_table_recursive(&$element) {
303         global $DB, $CFG;
305         $type = $element['type'];
306         $depth = $element['depth'];
307         $grade_object = $element['object'];
308         $eid = $grade_object->id;
309         $element['userid'] = $this->user->id;
310         $fullname = $this->gtree->get_element_header($element, true, true, true);
311         $data = array();
312         $hidden = '';
313         $excluded = '';
314         $class = '';
315         $classfeedback = '';
317         // If this is a hidden grade category, hide it completely from the user
318         if ($type == 'category' && $grade_object->is_hidden() && !$this->canviewhidden && (
319                 $this->showhiddenitems == GRADE_REPORT_USER_HIDE_HIDDEN ||
320                 ($this->showhiddenitems == GRADE_REPORT_USER_HIDE_UNTIL && !$grade_object->is_hiddenuntil()))) {
321             return false;
322         }
324         if ($type == 'category') {
325             $this->evenodd[$depth] = (($this->evenodd[$depth] + 1) % 2);
326         }
327         $alter = ($this->evenodd[$depth] == 0) ? 'even' : 'odd';
329         /// Process those items that have scores associated
330         if ($type == 'item' or $type == 'categoryitem' or $type == 'courseitem') {
331             if (! $grade_grade = grade_grade::fetch(array('itemid'=>$grade_object->id,'userid'=>$this->user->id))) {
332                 $grade_grade = new grade_grade();
333                 $grade_grade->userid = $this->user->id;
334                 $grade_grade->itemid = $grade_object->id;
335             }
337             $grade_grade->load_grade_item();
339             /// Hidden Items
340             if ($grade_grade->grade_item->is_hidden()) {
341                 $hidden = ' hidden';
342             }
344             // If this is a hidden grade item, hide it completely from the user.
345             if ($grade_grade->is_hidden() && !$this->canviewhidden && (
346                     $this->showhiddenitems == GRADE_REPORT_USER_HIDE_HIDDEN ||
347                     ($this->showhiddenitems == GRADE_REPORT_USER_HIDE_UNTIL && !$grade_grade->is_hiddenuntil()))) {
348                 // return false;
349             } else {
350                 /// Excluded Item
351                 if ($grade_grade->is_excluded()) {
352                     $fullname .= ' ['.get_string('excluded', 'grades').']';
353                     $excluded = ' excluded';
354                 }
356                 /// Other class information
357                 $class = "$hidden $excluded";
358                 if ($this->switch) { // alter style based on whether aggregation is first or last
359                    $class .= ($type == 'categoryitem' or $type == 'courseitem') ? " ".$alter."d$depth baggt b2b" : " item b1b";
360                 } else {
361                    $class .= ($type == 'categoryitem' or $type == 'courseitem') ? " ".$alter."d$depth baggb" : " item b1b";
362                 }
364                 /// Name
365                 $data['itemname']['content'] = $fullname;
366                 $data['itemname']['class'] = $class;
367                 $data['itemname']['colspan'] = ($this->maxdepth - $depth);
369                 /// Actual Grade
370                 $gradeval = $grade_grade->finalgrade;
372                 if ($this->showfeedback) {
373                     // Copy $class before appending itemcenter as feedback should not be centered
374                     $classfeedback = $class;
375                 }
376                 $class .= " itemcenter ";
377                 if ($this->showweight) {
378                     $data['weight']['class'] = $class;
379                     $data['weight']['content'] = '-';
380                     // has a weight assigned, might be extra credit
381                     if ($grade_object->aggregationcoef > 0 && $type <> 'courseitem') {
382                         $data['weight']['content'] = number_format($grade_object->aggregationcoef,2).'%';
383                     }
384                 }
386                 if ($this->showgrade) {
387                     if ($grade_grade->grade_item->needsupdate) {
388                         $data['grade']['class'] = $class.' gradingerror';
389                         $data['grade']['content'] = get_string('error');
390                     } else if (!empty($CFG->grade_hiddenasdate) and $grade_grade->get_datesubmitted() and !$this->canviewhidden and $grade_grade->is_hidden()
391                            and !$grade_grade->grade_item->is_category_item() and !$grade_grade->grade_item->is_course_item()) {
392                         // the problem here is that we do not have the time when grade value was modified, 'timemodified' is general modification date for grade_grades records
393                         $class .= ' datesubmitted';
394                         $data['grade']['class'] = $class;
395                         $data['grade']['content'] = get_string('submittedon', 'grades', userdate($grade_grade->get_datesubmitted(), get_string('strftimedatetimeshort')));
397                     } elseif ($grade_grade->is_hidden()) {
398                             $data['grade']['class'] = $class.' hidden';
399                             $data['grade']['content'] = '-';
400                     } else {
401                         $data['grade']['class'] = $class;
402                         $gradeval = $this->blank_hidden_total($this->courseid, $grade_grade->grade_item, $gradeval);
403                         $data['grade']['content'] = grade_format_gradevalue($gradeval, $grade_grade->grade_item, true);
404                     }
405                 }
407                 // Range
408                 if ($this->showrange) {
409                     $data['range']['class'] = $class;
410                     $data['range']['content'] = $grade_grade->grade_item->get_formatted_range(GRADE_DISPLAY_TYPE_REAL, $this->rangedecimals);
411                 }
413                 // Percentage
414                 if ($this->showpercentage) {
415                     if ($grade_grade->grade_item->needsupdate) {
416                         $data['percentage']['class'] = $class.' gradingerror';
417                         $data['percentage']['content'] = get_string('error');
418                     } else if ($grade_grade->is_hidden()) {
419                         $data['percentage']['class'] = $class.' hidden';
420                         $data['percentage']['content'] = '-';
421                     } else {
422                         $data['percentage']['class'] = $class;
423                         $data['percentage']['content'] = grade_format_gradevalue($gradeval, $grade_grade->grade_item, true, GRADE_DISPLAY_TYPE_PERCENTAGE);
424                     }
425                 }
427                 // Lettergrade
428                 if ($this->showlettergrade) {
429                     if ($grade_grade->grade_item->needsupdate) {
430                         $data['lettergrade']['class'] = $class.' gradingerror';
431                         $data['lettergrade']['content'] = get_string('error');
432                     } else if ($grade_grade->is_hidden()) {
433                         $data['lettergrade']['class'] = $class.' hidden';
434                         if (!$this->canviewhidden) {
435                             $data['lettergrade']['content'] = '-';
436                         } else {
437                             $data['lettergrade']['content'] = grade_format_gradevalue($gradeval, $grade_grade->grade_item, true, GRADE_DISPLAY_TYPE_LETTER);
438                         }
439                     } else {
440                         $data['lettergrade']['class'] = $class;
441                         $data['lettergrade']['content'] = grade_format_gradevalue($gradeval, $grade_grade->grade_item, true, GRADE_DISPLAY_TYPE_LETTER);
442                     }
443                 }
445                 // Rank
446                 if ($this->showrank) {
447                     if ($grade_grade->grade_item->needsupdate) {
448                         $data['rank']['class'] = $class.' gradingerror';
449                         $data['rank']['content'] = get_string('error');
450                         } elseif ($grade_grade->is_hidden()) {
451                             $data['rank']['class'] = $class.' hidden';
452                             $data['rank']['content'] = '-';
453                     } else if (is_null($gradeval)) {
454                         // no grade, no rank
455                         $data['rank']['class'] = $class;
456                         $data['rank']['content'] = '-';
458                     } else {
459                         /// find the number of users with a higher grade
460                         $sql = "SELECT COUNT(DISTINCT(userid))
461                                   FROM {grade_grades}
462                                  WHERE finalgrade > ?
463                                        AND itemid = ?
464                                        AND hidden = 0";
465                         $rank = $DB->count_records_sql($sql, array($grade_grade->finalgrade, $grade_grade->grade_item->id)) + 1;
467                         $data['rank']['class'] = $class;
468                         $data['rank']['content'] = "$rank/".$this->get_numusers(false); // total course users
469                     }
470                 }
472                 // Average
473                 if ($this->showaverage) {
474                     $data['average']['class'] = $class;
475                     if (!empty($this->gtree->items[$eid]->avg)) {
476                         $data['average']['content'] = $this->gtree->items[$eid]->avg;
477                     } else {
478                         $data['average']['content'] = '-';
479                     }
480                 }
482                 // Feedback
483                 if ($this->showfeedback) {
484                     if ($grade_grade->overridden > 0 AND ($type == 'categoryitem' OR $type == 'courseitem')) {
485                     $data['feedback']['class'] = $classfeedback.' feedbacktext';
486                         $data['feedback']['content'] = get_string('overridden', 'grades').': ' . format_text($grade_grade->feedback, $grade_grade->feedbackformat);
487                     } else if (empty($grade_grade->feedback) or (!$this->canviewhidden and $grade_grade->is_hidden())) {
488                         $data['feedback']['class'] = $classfeedback.' feedbacktext';
489                         $data['feedback']['content'] = '&nbsp;';
490                     } else {
491                         $data['feedback']['class'] = $classfeedback.' feedbacktext';
492                         $data['feedback']['content'] = format_text($grade_grade->feedback, $grade_grade->feedbackformat);
493                     }
494                 }
495             }
496         }
498         /// Category
499         if ($type == 'category') {
500             $data['leader']['class'] = $class.' '.$alter."d$depth b1t b2b b1l";
501             $data['leader']['rowspan'] = $element['rowspan'];
503             if ($this->switch) { // alter style based on whether aggregation is first or last
504                $data['itemname']['class'] = $class.' '.$alter."d$depth b1b b1t";
505             } else {
506                $data['itemname']['class'] = $class.' '.$alter."d$depth b2t";
507             }
508             $data['itemname']['colspan'] = ($this->maxdepth - $depth + count($this->tablecolumns) - 1);
509             $data['itemname']['content'] = $fullname;
510         }
512         /// Add this row to the overall system
513         $this->tabledata[] = $data;
515         /// Recursively iterate through all child elements
516         if (isset($element['children'])) {
517             foreach ($element['children'] as $key=>$child) {
518                 $this->fill_table_recursive($element['children'][$key]);
519             }
520         }
521     }
523     /**
524      * Prints or returns the HTML from the flexitable.
525      * @param bool $return Whether or not to return the data instead of printing it directly.
526      * @return string
527      */
528     public function print_table($return=false) {
529          $maxspan = $this->maxdepth;
531         /// Build table structure
532         $html = "
533             <table cellspacing='0' cellpadding='0' class='boxaligncenter generaltable user-grade'>
534             <thead>
535                 <tr>
536                     <th class=\"header\" colspan='$maxspan'>".$this->tableheaders[0]."</th>\n";
538         for ($i = 1; $i < count($this->tableheaders); $i++) {
539             $html .= "<th class=\"header\">".$this->tableheaders[$i]."</th>\n";
540         }
542         $html .= "
543                 </tr>
544             </thead>
545             <tbody>\n";
547         /// Print out the table data
548         for ($i = 0; $i < count($this->tabledata); $i++) {
549             $html .= "<tr>\n";
550             if (isset($this->tabledata[$i]['leader'])) {
551                 $rowspan = $this->tabledata[$i]['leader']['rowspan'];
552                 $class = $this->tabledata[$i]['leader']['class'];
553                 $html .= "<td class='$class' rowspan='$rowspan'></td>\n";
554             }
555             for ($j = 0; $j < count($this->tablecolumns); $j++) {
556                 $name = $this->tablecolumns[$j];
557                 $class = (isset($this->tabledata[$i][$name]['class'])) ? $this->tabledata[$i][$name]['class'] : '';
558                 $colspan = (isset($this->tabledata[$i][$name]['colspan'])) ? "colspan='".$this->tabledata[$i][$name]['colspan']."'" : '';
559                 $content = (isset($this->tabledata[$i][$name]['content'])) ? $this->tabledata[$i][$name]['content'] : null;
560                 if (isset($content)) {
561                     $html .= "<td class='$class' $colspan>$content</td>\n";
562                 }
563             }
564             $html .= "</tr>\n";
565         }
567         $html .= "</tbody></table>";
569         if ($return) {
570             return $html;
571         } else {
572             echo $html;
573         }
574     }
576     /**
577      * Processes the data sent by the form (grades and feedbacks).
578      * @var array $data
579      * @return bool Success or Failure (array of errors).
580      */
581     function process_data($data) {
582     }
583     function process_action($target, $action) {
584     }
586     /**
587      * Builds the grade item averages.
588      *
589      */
590     function calculate_averages() {
591         global $USER, $DB;
593         if ($this->showaverage) {
594             // this settings are actually grader report settings (not user report)
595             // however we're using them as having two separate but identical settings the
596             // user would have to keep in sync would be annoying
597             $averagesdisplaytype   = $this->get_pref('averagesdisplaytype');
598             $averagesdecimalpoints = $this->get_pref('averagesdecimalpoints');
599             $meanselection         = $this->get_pref('meanselection');
600             $shownumberofgrades    = $this->get_pref('shownumberofgrades');
602             $avghtml = '';
603             $avgcssclass = 'avg';
605             $straverage = get_string('overallaverage', 'grades');
607             $groupsql = $this->groupsql;
608             $groupwheresql = $this->groupwheresql;
609             //$groupwheresqlparams = ;
611             if ($shownumberofgrades) {
612                 $straverage .= ' (' . get_string('submissions', 'grades') . ') ';
613             }
615             $totalcount = $this->get_numusers(false);
617             //limit to users with a gradeable role ie students
618             list($gradebookrolessql, $gradebookrolesparams) = $DB->get_in_or_equal(explode(',', $this->gradebookroles), SQL_PARAMS_NAMED, 'grbr0');
620             //limit to users with an active enrolment
621             list($enrolledsql, $enrolledparams) = get_enrolled_sql($this->context);
623             $params = array_merge($this->groupwheresql_params, $gradebookrolesparams, $enrolledparams);
624             $params['courseid'] = $this->courseid;
626             // find sums of all grade items in course
627             $sql = "SELECT gg.itemid, SUM(gg.finalgrade) AS sum
628                       FROM {grade_items} gi
629                       JOIN {grade_grades} gg ON gg.itemid = gi.id
630                       JOIN {user} u ON u.id = gg.userid
631                       JOIN ($enrolledsql) je ON je.id = gg.userid
632                       JOIN (
633                                    SELECT DISTINCT ra.userid
634                                      FROM {role_assignments} ra
635                                     WHERE ra.roleid $gradebookrolessql
636                                       AND ra.contextid " . get_related_contexts_string($this->context) . "
637                            ) rainner ON rainner.userid = u.id
638                       $groupsql
639                      WHERE gi.courseid = :courseid
640                        AND u.deleted = 0
641                        AND gg.finalgrade IS NOT NULL
642                        AND gg.hidden = 0
643                        $groupwheresql
644                   GROUP BY gg.itemid";
646             $sum_array = array();
647             $sums = $DB->get_recordset_sql($sql, $params);
648             foreach ($sums as $itemid => $csum) {
649                 $sum_array[$itemid] = $csum->sum;
650             }
651             $sums->close();
653             $columncount=0;
655             // Empty grades must be evaluated as grademin, NOT always 0
656             // This query returns a count of ungraded grades (NULL finalgrade OR no matching record in grade_grades table)
657             // No join condition when joining grade_items and user to get a grade item row for every user
658             // Then left join with grade_grades and look for rows with null final grade (which includes grade items with no grade_grade)
659             $sql = "SELECT gi.id, COUNT(u.id) AS count
660                       FROM {grade_items} gi
661                       JOIN {user} u ON u.deleted = 0
662                       JOIN ($enrolledsql) je ON je.id = u.id
663                       JOIN (
664                                SELECT DISTINCT ra.userid
665                                  FROM {role_assignments} ra
666                                 WHERE ra.roleid $gradebookrolessql
667                                   AND ra.contextid " . get_related_contexts_string($this->context) . "
668                            ) rainner ON rainner.userid = u.id
669                       LEFT JOIN {grade_grades} gg
670                              ON (gg.itemid = gi.id AND gg.userid = u.id AND gg.finalgrade IS NOT NULL AND gg.hidden = 0)
671                       $groupsql
672                      WHERE gi.courseid = :courseid
673                            AND gg.finalgrade IS NULL
674                            $groupwheresql
675                   GROUP BY gi.id";
677             $ungraded_counts = $DB->get_records_sql($sql, $params);
679             foreach ($this->gtree->items as $itemid=>$unused) {
680                 if (!empty($this->gtree->items[$itemid]->avg)) {
681                     continue;
682                 }
683                 $item = $this->gtree->items[$itemid];
685                 if ($item->needsupdate) {
686                     $avghtml .= '<td class="cell c' . $columncount++.'"><span class="gradingerror">'.get_string('error').'</span></td>';
687                     continue;
688                 }
690                 if (empty($sum_array[$item->id])) {
691                     $sum_array[$item->id] = 0;
692                 }
694                 if (empty($ungraded_counts[$itemid])) {
695                     $ungraded_count = 0;
696                 } else {
697                     $ungraded_count = $ungraded_counts[$itemid]->count;
698                 }
700                 //do they want the averages to include all grade items
701                 if ($meanselection == GRADE_REPORT_MEAN_GRADED) {
702                     $mean_count = $totalcount - $ungraded_count;
703                 } else { // Bump up the sum by the number of ungraded items * grademin
704                     $sum_array[$item->id] += ($ungraded_count * $item->grademin);
705                     $mean_count = $totalcount;
706                 }
708                 $decimalpoints = $item->get_decimals();
710                 // Determine which display type to use for this average
711                 if (!empty($USER->gradeediting) && $USER->gradeediting[$this->courseid]) {
712                     $displaytype = GRADE_DISPLAY_TYPE_REAL;
714                 } else if ($averagesdisplaytype == GRADE_REPORT_PREFERENCE_INHERIT) { // no ==0 here, please resave the report and user preferences
715                     $displaytype = $item->get_displaytype();
717                 } else {
718                     $displaytype = $averagesdisplaytype;
719                 }
721                 // Override grade_item setting if a display preference (not inherit) was set for the averages
722                 if ($averagesdecimalpoints == GRADE_REPORT_PREFERENCE_INHERIT) {
723                     $decimalpoints = $item->get_decimals();
725                 } else {
726                     $decimalpoints = $averagesdecimalpoints;
727                 }
729                 if (empty($sum_array[$item->id]) || $mean_count == 0) {
730                     $this->gtree->items[$itemid]->avg = '-';
731                 } else {
732                     $sum = $sum_array[$item->id];
733                     $avgradeval = $sum/$mean_count;
734                     $gradehtml = grade_format_gradevalue($avgradeval, $item, true, $displaytype, $decimalpoints);
736                     $numberofgrades = '';
737                     if ($shownumberofgrades) {
738                         $numberofgrades = " ($mean_count)";
739                     }
741                     $this->gtree->items[$itemid]->avg = $gradehtml.$numberofgrades;
742                 }
743             }
744         }
745     }
748 function grade_report_user_settings_definition(&$mform) {
749     global $CFG;
751     $options = array(-1 => get_string('default', 'grades'),
752                       0 => get_string('hide'),
753                       1 => get_string('show'));
755     if (empty($CFG->grade_report_user_showrank)) {
756         $options[-1] = get_string('defaultprev', 'grades', $options[0]);
757     } else {
758         $options[-1] = get_string('defaultprev', 'grades', $options[1]);
759     }
761     $mform->addElement('select', 'report_user_showrank', get_string('showrank', 'grades'), $options);
762     $mform->addHelpButton('report_user_showrank', 'showrank', 'grades');
764     if (empty($CFG->grade_report_user_showpercentage)) {
765         $options[-1] = get_string('defaultprev', 'grades', $options[0]);
766     } else {
767         $options[-1] = get_string('defaultprev', 'grades', $options[1]);
768     }
770     $mform->addElement('select', 'report_user_showpercentage', get_string('showpercentage', 'grades'), $options);
771     $mform->addHelpButton('report_user_showpercentage', 'showpercentage', 'grades');
773     if (empty($CFG->grade_report_user_showgrade)) {
774         $options[-1] = get_string('defaultprev', 'grades', $options[0]);
775     } else {
776         $options[-1] = get_string('defaultprev', 'grades', $options[1]);
777     }
779     $mform->addElement('select', 'report_user_showgrade', get_string('showgrade', 'grades'), $options);
781     if (empty($CFG->grade_report_user_showfeedback)) {
782         $options[-1] = get_string('defaultprev', 'grades', $options[0]);
783     } else {
784         $options[-1] = get_string('defaultprev', 'grades', $options[1]);
785     }
787     $mform->addElement('select', 'report_user_showfeedback', get_string('showfeedback', 'grades'), $options);
789     if (empty($CFG->grade_report_user_showweight)) {
790         $options[-1] = get_string('defaultprev', 'grades', $options[0]);
791     } else {
792         $options[-1] = get_string('defaultprev', 'grades', $options[1]);
793     }
795     $mform->addElement('select', 'report_user_showweight', get_string('showweight', 'grades'), $options);
797     if (empty($CFG->grade_report_user_showaverage)) {
798         $options[-1] = get_string('defaultprev', 'grades', $options[0]);
799     } else {
800         $options[-1] = get_string('defaultprev', 'grades', $options[1]);
801     }
803     $mform->addElement('select', 'report_user_showaverage', get_string('showaverage', 'grades'), $options);
804     $mform->addHelpButton('report_user_showaverage', 'showaverage', 'grades');
806     if (empty($CFG->grade_report_user_showlettergrade)) {
807         $options[-1] = get_string('defaultprev', 'grades', $options[0]);
808     } else {
809         $options[-1] = get_string('defaultprev', 'grades', $options[1]);
810     }
812     $mform->addElement('select', 'report_user_showlettergrade', get_string('showlettergrade', 'grades'), $options);
814     if (empty($CFG->grade_report_user_showrange)) {
815         $options[-1] = get_string('defaultprev', 'grades', $options[0]);
816     } else {
817         $options[-1] = get_string('defaultprev', 'grades', $options[1]);
818     }
820     $mform->addElement('select', 'report_user_showrange', get_string('showrange', 'grades'), $options);
822     $options = array(0=>0, 1=>1, 2=>2, 3=>3, 4=>4, 5=>5);
823     if (! empty($CFG->grade_report_user_rangedecimals)) {
824         $options[-1] = $options[$CFG->grade_report_user_rangedecimals];
825     }
826     $mform->addElement('select', 'report_user_rangedecimals', get_string('rangedecimals', 'grades'), $options);
828     $options = array(-1 => get_string('default', 'grades'),
829                       0 => get_string('shownohidden', 'grades'),
830                       1 => get_string('showhiddenuntilonly', 'grades'),
831                       2 => get_string('showallhidden', 'grades'));
833     if (empty($CFG->grade_report_user_showhiddenitems)) {
834         $options[-1] = get_string('defaultprev', 'grades', $options[0]);
835     } else {
836         $options[-1] = get_string('defaultprev', 'grades', $options[$CFG->grade_report_user_showhiddenitems]);
837     }
839     $mform->addElement('select', 'report_user_showhiddenitems', get_string('showhiddenitems', 'grades'), $options);
840     $mform->addHelpButton('report_user_showhiddenitems', 'showhiddenitems', 'grades');
842     //showtotalsifcontainhidden
843     $options = array(-1 => get_string('default', 'grades'),
844                       GRADE_REPORT_HIDE_TOTAL_IF_CONTAINS_HIDDEN => get_string('hide'),
845                       GRADE_REPORT_SHOW_TOTAL_IF_CONTAINS_HIDDEN => get_string('hidetotalshowexhiddenitems', 'grades'),
846                       GRADE_REPORT_SHOW_REAL_TOTAL_IF_CONTAINS_HIDDEN => get_string('hidetotalshowinchiddenitems', 'grades') );
848     if (empty($CFG->grade_report_user_showtotalsifcontainhidden)) {
849         $options[-1] = get_string('defaultprev', 'grades', $options[0]);
850     } else {
851         $options[-1] = get_string('defaultprev', 'grades', $options[$CFG->grade_report_user_showtotalsifcontainhidden]);
852     }
854     $mform->addElement('select', 'report_user_showtotalsifcontainhidden', get_string('hidetotalifhiddenitems', 'grades'), $options);
855     $mform->addHelpButton('report_user_showtotalsifcontainhidden', 'hidetotalifhiddenitems', 'grades');
858 function grade_report_user_profilereport($course, $user) {
859     global $OUTPUT;
860     if (!empty($course->showgrades)) {
862         $context = get_context_instance(CONTEXT_COURSE, $course->id);
864         //first make sure we have proper final grades - this must be done before constructing of the grade tree
865         grade_regrade_final_grades($course->id);
867         /// return tracking object
868         $gpr = new grade_plugin_return(array('type'=>'report', 'plugin'=>'user', 'courseid'=>$course->id, 'userid'=>$user->id));
869         // Create a report instance
870         $report = new grade_report_user($course->id, $gpr, $context, $user->id);
872         // print the page
873         echo '<div class="grade-report-user">'; // css fix to share styles with real report page
874         echo $OUTPUT->heading(get_string('pluginname', 'gradereport_user'). ' - '.fullname($report->user));
876         if ($report->fill_table()) {
877             echo $report->print_table(true);
878         }
879         echo '</div>';
880     }