82535428828b3db79bb1dbe73f7475c922a5d6d5
[moodle.git] / grade / report / grader / lib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * File in which the grader_report class is defined.
20  * @package gradebook
21  */
23 require_once($CFG->dirroot . '/grade/report/lib.php');
24 require_once($CFG->libdir.'/tablelib.php');
26 /**
27  * Class providing an API for the grader report building and displaying.
28  * @uses grade_report
29  * @package gradebook
30  */
31 class grade_report_grader extends grade_report {
32     /**
33      * The final grades.
34      * @var array $grades
35      */
36     public $grades;
38     /**
39      * Array of errors for bulk grades updating.
40      * @var array $gradeserror
41      */
42     public $gradeserror = array();
44 //// SQL-RELATED
46     /**
47      * The id of the grade_item by which this report will be sorted.
48      * @var int $sortitemid
49      */
50     public $sortitemid;
52     /**
53      * Sortorder used in the SQL selections.
54      * @var int $sortorder
55      */
56     public $sortorder;
58     /**
59      * An SQL fragment affecting the search for users.
60      * @var string $userselect
61      */
62     public $userselect;
64     /**
65      * The bound params for $userselect
66      * @var array $userselectparams
67      */
68     public $userselectparams = array();
70     /**
71      * List of collapsed categories from user preference
72      * @var array $collapsed
73      */
74     public $collapsed;
76     /**
77      * A count of the rows, used for css classes.
78      * @var int $rowcount
79      */
80     public $rowcount = 0;
82     /**
83      * Capability check caching
84      * */
85     public $canviewhidden;
87     var $preferencespage=false;
89     /**
90      * Length at which feedback will be truncated (to the nearest word) and an ellipsis be added.
91      * TODO replace this by a report preference
92      * @var int $feedback_trunc_length
93      */
94     protected $feedback_trunc_length = 50;
96     /**
97      * Constructor. Sets local copies of user preferences and initialises grade_tree.
98      * @param int $courseid
99      * @param object $gpr grade plugin return tracking object
100      * @param string $context
101      * @param int $page The current page being viewed (when report is paged)
102      * @param int $sortitemid The id of the grade_item by which to sort the table
103      */
104     public function __construct($courseid, $gpr, $context, $page=null, $sortitemid=null) {
105         global $CFG;
106         parent::__construct($courseid, $gpr, $context, $page);
108         $this->canviewhidden = has_capability('moodle/grade:viewhidden', get_context_instance(CONTEXT_COURSE, $this->course->id));
110         // load collapsed settings for this report
111         if ($collapsed = get_user_preferences('grade_report_grader_collapsed_categories')) {
112             $this->collapsed = unserialize($collapsed);
113         } else {
114             $this->collapsed = array('aggregatesonly' => array(), 'gradesonly' => array());
115         }
117         if (empty($CFG->enableoutcomes)) {
118             $nooutcomes = false;
119         } else {
120             $nooutcomes = get_user_preferences('grade_report_shownooutcomes');
121         }
123         // if user report preference set or site report setting set use it, otherwise use course or site setting
124         $switch = $this->get_pref('aggregationposition');
125         if ($switch == '') {
126             $switch = grade_get_setting($this->courseid, 'aggregationposition', $CFG->grade_aggregationposition);
127         }
129         // Grab the grade_tree for this course
130         $this->gtree = new grade_tree($this->courseid, true, $switch, $this->collapsed, $nooutcomes);
132         $this->sortitemid = $sortitemid;
134         // base url for sorting by first/last name
136         $this->baseurl = new moodle_url('index.php', array('id' => $this->courseid));
138         $studentsperpage = $this->get_pref('studentsperpage');
139         if (!empty($studentsperpage)) {
140             $this->baseurl->params(array('perpage' => $studentsperpage, 'page' => $this->page));
141         }
143         $this->pbarurl = new moodle_url('/grade/report/grader/index.php', array('id' => $this->courseid, 'perpage' => $studentsperpage));
145         $this->setup_groups();
147         $this->setup_sortitemid();
148     }
150     /**
151      * Processes the data sent by the form (grades and feedbacks).
152      * Caller is reposible for all access control checks
153      * @param array $data form submission (with magic quotes)
154      * @return array empty array if success, array of warnings if something fails.
155      */
156     public function process_data($data) {
157         global $DB;
158         $warnings = array();
160         $separategroups = false;
161         $mygroups       = array();
162         if ($this->groupmode == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $this->context)) {
163             $separategroups = true;
164             $mygroups = groups_get_user_groups($this->course->id);
165             $mygroups = $mygroups[0]; // ignore groupings
166             // reorder the groups fro better perf bellow
167             $current = array_search($this->currentgroup, $mygroups);
168             if ($current !== false) {
169                 unset($mygroups[$current]);
170                 array_unshift($mygroups, $this->currentgroup);
171             }
172         }
174         // always initialize all arrays
175         $queue = array();
176         foreach ($data as $varname => $postedvalue) {
178             $needsupdate = false;
180             // skip, not a grade nor feedback
181             if (strpos($varname, 'grade') === 0) {
182                 $datatype = 'grade';
183             } else if (strpos($varname, 'feedback') === 0) {
184                 $datatype = 'feedback';
185             } else {
186                 continue;
187             }
189             $gradeinfo = explode("_", $varname);
190             $userid = clean_param($gradeinfo[1], PARAM_INT);
191             $itemid = clean_param($gradeinfo[2], PARAM_INT);
193             $oldvalue = $data->{'old'.$varname};
195             // was change requested?
196             if ($oldvalue == $postedvalue) { // string comparison
197                 continue;
198             }
200             if (!$gradeitem = grade_item::fetch(array('id'=>$itemid, 'courseid'=>$this->courseid))) { // we must verify course id here!
201                 print_error('invalidgradeitmeid');
202             }
204             // Pre-process grade
205             if ($datatype == 'grade') {
206                 $feedback = false;
207                 $feedbackformat = false;
208                 if ($gradeitem->gradetype == GRADE_TYPE_SCALE) {
209                     if ($postedvalue == -1) { // -1 means no grade
210                         $finalgrade = null;
211                     } else {
212                         $finalgrade = $postedvalue;
213                     }
214                 } else {
215                     $finalgrade = unformat_float($postedvalue);
216                 }
218                 $errorstr = '';
219                 // Warn if the grade is out of bounds.
220                 if (is_null($finalgrade)) {
221                     // ok
222                 } else {
223                     $bounded = $gradeitem->bounded_grade($finalgrade);
224                     if ($bounded > $finalgrade) {
225                     $errorstr = 'lessthanmin';
226                     } else if ($bounded < $finalgrade) {
227                         $errorstr = 'morethanmax';
228                     }
229                 }
230                 if ($errorstr) {
231                     $user = $DB->get_record('user', array('id' => $userid), 'id, firstname, lastname');
232                     $gradestr = new object();
233                     $gradestr->username = fullname($user);
234                     $gradestr->itemname = $gradeitem->get_name();
235                     $warnings[] = get_string($errorstr, 'grades', $gradestr);
236                 }
238             } else if ($datatype == 'feedback') {
239                 $finalgrade = false;
240                 $trimmed = trim($postedvalue);
241                 if (empty($trimmed)) {
242                      $feedback = NULL;
243                 } else {
244                      $feedback = stripslashes($postedvalue);
245                 }
246             }
248             // group access control
249             if ($separategroups) {
250                 // note: we can not use $this->currentgroup because it would fail badly
251                 //       when having two browser windows each with different group
252                 $sharinggroup = false;
253                 foreach($mygroups as $groupid) {
254                     if (groups_is_member($groupid, $userid)) {
255                         $sharinggroup = true;
256                         break;
257                     }
258                 }
259                 if (!$sharinggroup) {
260                     // either group membership changed or somebedy is hacking grades of other group
261                     $warnings[] = get_string('errorsavegrade', 'grades');
262                     continue;
263                 }
264             }
266             $gradeitem->update_final_grade($userid, $finalgrade, 'gradebook', $feedback, FORMAT_MOODLE);
267         }
269         return $warnings;
270     }
273     /**
274      * Setting the sort order, this depends on last state
275      * all this should be in the new table class that we might need to use
276      * for displaying grades.
277      */
278     private function setup_sortitemid() {
280         global $SESSION;
282         if ($this->sortitemid) {
283             if (!isset($SESSION->gradeuserreport->sort)) {
284                 if ($this->sortitemid == 'firstname' || $this->sortitemid == 'lastname') {
285                     $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC';
286                 } else {
287                     $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC';
288                 }
289             } else {
290                 // this is the first sort, i.e. by last name
291                 if (!isset($SESSION->gradeuserreport->sortitemid)) {
292                     if ($this->sortitemid == 'firstname' || $this->sortitemid == 'lastname') {
293                         $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC';
294                     } else {
295                         $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC';
296                     }
297                 } else if ($SESSION->gradeuserreport->sortitemid == $this->sortitemid) {
298                     // same as last sort
299                     if ($SESSION->gradeuserreport->sort == 'ASC') {
300                         $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC';
301                     } else {
302                         $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC';
303                     }
304                 } else {
305                     if ($this->sortitemid == 'firstname' || $this->sortitemid == 'lastname') {
306                         $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC';
307                     } else {
308                         $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC';
309                     }
310                 }
311             }
312             $SESSION->gradeuserreport->sortitemid = $this->sortitemid;
313         } else {
314             // not requesting sort, use last setting (for paging)
316             if (isset($SESSION->gradeuserreport->sortitemid)) {
317                 $this->sortitemid = $SESSION->gradeuserreport->sortitemid;
318             }else{
319                 $this->sortitemid = 'lastname';
320             }
322             if (isset($SESSION->gradeuserreport->sort)) {
323                 $this->sortorder = $SESSION->gradeuserreport->sort;
324             } else {
325                 $this->sortorder = 'ASC';
326             }
327         }
328     }
330     /**
331      * pulls out the userids of the users to be display, and sorts them
332      */
333     public function load_users() {
334         global $CFG, $DB;
336         list($usql, $gbrparams) = $DB->get_in_or_equal(explode(',', $this->gradebookroles), SQL_PARAMS_NAMED, 'grbr0');
338         if (is_numeric($this->sortitemid)) {
339             $params = array_merge(array('gitemid'=>$this->sortitemid), $gbrparams, $this->groupwheresql_params);
340             // the MAX() magic is required in order to please PG
341             $sort = "MAX(g.finalgrade) $this->sortorder";
343             $sql = "SELECT u.id, u.firstname, u.lastname, u.imagealt, u.picture, u.idnumber
344                       FROM {user} u
345                            JOIN {role_assignments} ra ON ra.userid = u.id
346                            $this->groupsql
347                            LEFT JOIN {grade_grades} g ON (g.userid = u.id AND g.itemid = :gitemid)
348                      WHERE ra.roleid $usql AND u.deleted = 0
349                            $this->groupwheresql
350                            AND ra.contextid ".get_related_contexts_string($this->context)."
351                   GROUP BY u.id, u.firstname, u.lastname, u.imagealt, u.picture, u.idnumber
352                   ORDER BY $sort";
354         } else {
355             switch($this->sortitemid) {
356                 case 'lastname':
357                     $sort = "u.lastname $this->sortorder, u.firstname $this->sortorder"; break;
358                 case 'firstname':
359                     $sort = "u.firstname $this->sortorder, u.lastname $this->sortorder"; break;
360                 case 'idnumber':
361                 default:
362                     $sort = "u.idnumber $this->sortorder"; break;
363             }
365             $params = array_merge($gbrparams, $this->groupwheresql_params);
366             $sql = "SELECT DISTINCT u.id, u.firstname, u.lastname, u.imagealt, u.picture, u.idnumber
367                       FROM {user} u
368                            JOIN {role_assignments} ra ON u.id = ra.userid
369                            $this->groupsql
370                      WHERE ra.roleid $usql AND u.deleted = 0
371                            $this->groupwheresql
372                            AND ra.contextid ".get_related_contexts_string($this->context)."
373                   ORDER BY $sort";
374         }
377         $this->users = $DB->get_records_sql($sql, $params, $this->get_pref('studentsperpage') * $this->page, $this->get_pref('studentsperpage'));
379         if (empty($this->users)) {
380             $this->userselect = '';
381             $this->users = array();
382             $this->userselect_params = array();
383         } else {
384             list($usql, $params) = $DB->get_in_or_equal(array_keys($this->users), SQL_PARAMS_NAMED, 'usid0');
385             $this->userselect = "AND g.userid $usql";
386             $this->userselect_params = $params;
387         }
389         return $this->users;
390     }
392     /**
393      * we supply the userids in this query, and get all the grades
394      * pulls out all the grades, this does not need to worry about paging
395      */
396     public function load_final_grades() {
397         global $CFG, $DB;
399         // please note that we must fetch all grade_grades fields if we want to contruct grade_grade object from it!
400         $params = array_merge(array('courseid'=>$this->courseid), $this->userselect_params);
401         $sql = "SELECT g.*
402                   FROM {grade_items} gi,
403                        {grade_grades} g
404                  WHERE g.itemid = gi.id AND gi.courseid = :courseid {$this->userselect}";
406         $userids = array_keys($this->users);
409         if ($grades = $DB->get_records_sql($sql, $params)) {
410             foreach ($grades as $graderec) {
411                 if (in_array($graderec->userid, $userids) and array_key_exists($graderec->itemid, $this->gtree->get_items())) { // some items may not be present!!
412                     $this->grades[$graderec->userid][$graderec->itemid] = new grade_grade($graderec, false);
413                     $this->grades[$graderec->userid][$graderec->itemid]->grade_item =& $this->gtree->get_item($graderec->itemid); // db caching
414                 }
415             }
416         }
418         // prefil grades that do not exist yet
419         foreach ($userids as $userid) {
420             foreach ($this->gtree->get_items() as $itemid=>$unused) {
421                 if (!isset($this->grades[$userid][$itemid])) {
422                     $this->grades[$userid][$itemid] = new grade_grade();
423                     $this->grades[$userid][$itemid]->itemid = $itemid;
424                     $this->grades[$userid][$itemid]->userid = $userid;
425                     $this->grades[$userid][$itemid]->grade_item =& $this->gtree->get_item($itemid); // db caching
426                 }
427             }
428         }
429     }
431     /**
432      * Builds and returns a div with on/off toggles.
433      * @return string HTML code
434      */
435     public function get_toggles_html() {
436         global $CFG, $USER, $COURSE, $OUTPUT;
438         $html = '';
439         if ($USER->gradeediting[$this->courseid]) {
440             if (has_capability('moodle/grade:manage', $this->context) or has_capability('moodle/grade:hide', $this->context)) {
441                 $html .= $this->print_toggle('eyecons');
442             }
443             if (has_capability('moodle/grade:manage', $this->context)
444              or has_capability('moodle/grade:lock', $this->context)
445              or has_capability('moodle/grade:unlock', $this->context)) {
446                 $html .= $this->print_toggle('locks');
447             }
448             if (has_capability('moodle/grade:manage', $this->context)) {
449                 $html .= $this->print_toggle('quickfeedback');
450             }
452             if (has_capability('moodle/grade:manage', $this->context)) {
453                 $html .= $this->print_toggle('calculations');
454             }
455         }
457         if ($this->canviewhidden) {
458             $html .= $this->print_toggle('averages');
459         }
461         $html .= $this->print_toggle('ranges');
462         if (!empty($CFG->enableoutcomes)) {
463             $html .= $this->print_toggle('nooutcomes');
464         }
466         return $OUTPUT->container($html, 'grade-report-toggles');
467     }
469     /**
470     * Shortcut function for printing the grader report toggles.
471     * @param string $type The type of toggle
472     * @param bool $return Whether to return the HTML string rather than printing it
473     * @return void
474     */
475     public function print_toggle($type) {
476         global $CFG, $OUTPUT;
478         $icons = array('eyecons' => 't/hide',
479                        'calculations' => 't/calc',
480                        'locks' => 't/lock',
481                        'averages' => 't/mean',
482                        'quickfeedback' => 't/feedback',
483                        'nooutcomes' => 't/outcomes');
485         $prefname = 'grade_report_show' . $type;
487         if (array_key_exists($prefname, $CFG)) {
488             $showpref = get_user_preferences($prefname, $CFG->$prefname);
489         } else {
490             $showpref = get_user_preferences($prefname);
491         }
493         $strshow = $this->get_lang_string('show' . $type, 'grades');
494         $strhide = $this->get_lang_string('hide' . $type, 'grades');
496         $showhide = 'show';
497         $toggleaction = 1;
499         if ($showpref) {
500             $showhide = 'hide';
501             $toggleaction = 0;
502         }
504         if (array_key_exists($type, $icons)) {
505             $imagename = $icons[$type];
506         } else {
507             $imagename = "t/$type.gif";
508         }
510         $string = ${'str' . $showhide};
512         $aurl = clone($this->baseurl);
513         $url->params(array('toggle' => $toggleaction, 'toggle_type' => $type));
515         $retval = $OUTPUT->container($OUTPUT->action_icon($url, new pix_icon($imagename, $string))); // TODO: this container looks wrong here
517         return $retval;
518     }
520     /**
521      * Builds and returns the rows that will make up the left part of the grader report
522      * This consists of student names and icons, links to user reports and id numbers, as well
523      * as header cells for these columns. It also includes the fillers required for the
524      * categories displayed on the right side of the report.
525      * @return array Array of html_table_row objects
526      */
527     public function get_left_rows() {
528         global $CFG, $USER, $OUTPUT;
530         $rows = array();
532         $showuserimage = $this->get_pref('showuserimage');
533         $showuseridnumber = $this->get_pref('showuseridnumber');
534         $fixedstudents = $this->is_fixed_students();
536         $strfeedback  = $this->get_lang_string("feedback");
537         $strgrade     = $this->get_lang_string('grade');
539         $arrows = $this->get_sort_arrows();
541         $colspan = 1;
543         if (has_capability('gradereport/'.$CFG->grade_profilereport.':view', $this->context)) {
544             $colspan++;
545         }
547         if ($showuseridnumber) {
548             $colspan++;
549         }
551         $levels = count($this->gtree->levels) - 1;
553         for ($i = 0; $i < $levels; $i++) {
554             $fillercell = new html_table_cell();
555             $fillercell->attributes['class'] = 'fixedcolumn cell topleft';
556             $fillercell->text = ' ';
557             $fillercell->colspan = $colspan;
558             $row = new html_table_row(array($fillercell));
559             $rows[] = $row;
560         }
562         $headerrow = new html_table_row();
563         $headerrow->attributes['class'] = 'heading';
565         $studentheader = new html_table_cell();
566         $studentheader->attributes['class'] = 'header';
567         $studentheader->scope = 'col';
568         $studentheader->header = true;
569         $studentheader->id = 'studentheader';
570         if (has_capability('gradereport/'.$CFG->grade_profilereport.':view', $this->context)) {
571             $studentheader->colspan = 2;
572         }
573         $studentheader->text = $arrows['studentname'];
575         $headerrow->cells[] = $studentheader;
577         if ($showuseridnumber) {
578             // TODO: weird, this is not used anywhere
579             $sortidnumberlink = html_writer::link(new moodle_url($this->baseurl, array('sortitemid'=>'idnumber')), get_string('idnumber'));
581             $idnumberheader = new html_table_cell();
582             $idnumberheader->attributes['class'] = 'header useridnumber';
583             $idnumberheader->scope = 'col';
584             $idnumberheader->header = true;
585             $idnumberheader->text = $arrows['idnumber'];
587             $headerrow->cells[] = $idnumberheader;
588         }
590         $rows[] = $headerrow;
592         $rows = $this->get_left_icons_row($rows, $colspan);
594         $rowclasses = array('even', 'odd');
596         foreach ($this->users as $userid => $user) {
597             $userrow = new html_table_row();
598             $userrow->id = 'fixed_user_'.$userid;
599             $userrow->attributes['class'] = 'r'.$this->rowcount++.' '.$rowclasses[$this->rowcount % 2];
601             $usercell = new html_table_cell();
602             $usercell->attributes['class'] = 'user';
603             $usercell->header = true;
604             $usercell->scope = 'row';
606             if ($showuserimage) {
607                 $usercell->text = $OUTPUT->container($OUTPUT->user_picture($user), 'userpic');
608             }
610             $usercell->text .= html_writer::link(new moodle_url('/user/view.php', array('id' => $user->id, 'course' => $this->course->id)), fullname($user));
612             $userrow->cells[] = $usercell;
614             if (has_capability('gradereport/'.$CFG->grade_profilereport.':view', $this->context)) {
615                 $userreportcell = new html_table_cell();
616                 $userreportcell->attributes['class'] = 'userreport';
617                 $userreportcell->header = true;
618                 $a->user = fullname($user);
619                 $strgradesforuser = get_string('gradesforuser', 'grades', $a);
620                 $url = new moodle_url('/grade/report/'.$CFG->grade_profilereport.'/index.php', array('userid' => $user->id, 'id' => $this->course->id));
621                 $userreportcell->text = $OUTPUT->action_icon($url, new pix_icon('t/grades', $strgradesforuser));
622                 $userrow->cells[] = $userreportcell;
623             }
625             if ($showuseridnumber) {
626                 $idnumbercell = new html_table_cell();
627                 $idnumbercell->attributes['class'] = 'header useridnumber';
628                 $idnumbercell->header = true;
629                 $idnumbercell->scope = 'row';
630                 $userrow->cells[] = $idnumbercell;
631             }
633             $rows[] = $userrow;
634         }
636         $rows = $this->get_left_range_row($rows, $colspan);
637         $rows = $this->get_left_avg_row($rows, $colspan, true);
638         $rows = $this->get_left_avg_row($rows, $colspan);
640         return $rows;
641     }
643     /**
644      * Builds and returns the rows that will make up the right part of the grader report
645      * @return array Array of html_table_row objects
646      */
647     public function get_right_rows() {
648         global $CFG, $USER, $OUTPUT, $DB, $PAGE;
650         $rows = array();
651         $this->rowcount = 0;
652         $numrows = count($this->gtree->get_levels());
653         $numusers = count($this->users);
654         $gradetabindex = 1;
655         $columnstounset = array();
656         $strgrade = $this->get_lang_string('grade');
657         $strfeedback  = $this->get_lang_string("feedback");
658         $arrows = $this->get_sort_arrows();
660         $jsarguments = array(
661             'id'        => '#fixed_column',
662             'cfg'       => array('ajaxenabled'=>false),
663             'items'     => array(),
664             'users'     => array(),
665             'feedback'  => array()
666         );
667         $jsscales = array();
669         foreach ($this->gtree->get_levels() as $key=>$row) {
670             if ($key == 0) {
671                 // do not display course grade category
672                 // continue;
673             }
675             $headingrow = new html_table_row();
676             $headingrow->attributes['class'] = 'heading_name_row';
678             foreach ($row as $columnkey => $element) {
679                 $sortlink = clone($this->baseurl);
680                 if (isset($element['object']->id)) {
681                     $sortlink->param('sortitemid', $element['object']->id);
682                 }
684                 $eid    = $element['eid'];
685                 $object = $element['object'];
686                 $type   = $element['type'];
687                 $categorystate = @$element['categorystate'];
688                 $itemmodule = null;
689                 $iteminstance = null;
691                 if (!empty($element['colspan'])) {
692                     $colspan = $element['colspan'];
693                 } else {
694                     $colspan = 1;
695                 }
697                 if (!empty($element['depth'])) {
698                     $catlevel = 'catlevel'.$element['depth'];
699                 } else {
700                     $catlevel = '';
701                 }
703 // Element is a filler
704                 if ($type == 'filler' or $type == 'fillerfirst' or $type == 'fillerlast') {
705                     $fillercell = new html_table_cell();
706                     $fillercell->attributes['class'] = $type . ' ' . $catlevel;
707                     $fillercell->colspan = $colspan;
708                     $fillercell->text = '&nbsp;';
709                     $fillercell->header = true;
710                     $fillercell->scope = 'col';
711                     $headingrow->cells[] = $fillercell;
712                 }
713 // Element is a category
714                 else if ($type == 'category') {
715                     $categorycell = new html_table_cell();
716                     $categorycell->attributes['class'] = 'category ' . $catlevel;
717                     $categorycell->colspan = $colspan;
718                     $categorycell->text = shorten_text($element['object']->get_name());
719                     $categorycell->text .= $this->get_collapsing_icon($element);
720                     $categorycell->header = true;
721                     $categorycell->scope = 'col';
723                     // Print icons
724                     if ($USER->gradeediting[$this->courseid]) {
725                         $categorycell->text .= $this->get_icons($element);
726                     }
728                     $headingrow->cells[] = $categorycell;
729                 }
730 // Element is a grade_item
731                 else {
732                     $itemmodule = $element['object']->itemmodule;
733                     $iteminstance = $element['object']->iteminstance;
735                     if ($element['object']->id == $this->sortitemid) {
736                         if ($this->sortorder == 'ASC') {
737                             $arrow = $this->get_sort_arrow('up', $sortlink);
738                         } else {
739                             $arrow = $this->get_sort_arrow('down', $sortlink);
740                         }
741                     } else {
742                         $arrow = $this->get_sort_arrow('move', $sortlink);
743                     }
745                     $headerlink = $this->gtree->get_element_header($element, true, $this->get_pref('showactivityicons'), false);
747                     $itemcell = new html_table_cell();
748                     $itemcell->attributes['class'] = $type . ' ' . $catlevel . 'highlightable';
750                     if ($element['object']->is_hidden()) {
751                         $itemcell->attributes['class'] .= ' hidden';
752                     }
754                     $itemcell->colspan = $colspan;
755                     $itemcell->text = shorten_text($headerlink) . $arrow;
756                     $itemcell->header = true;
757                     $itemcell->scope = 'col';
759                     $headingrow->cells[] = $itemcell;
760                 }
761             }
762             $rows[] = $headingrow;
763         }
765         $rows = $this->get_right_icons_row($rows);
767         // Preload scale objects for items with a scaleid
768         $scaleslist = array();
769         $tabindices = array();
771         foreach ($this->gtree->get_items() as $itemid=>$item) {
772             $scale = null;
773             if (!empty($item->scaleid)) {
774                 $scaleslist[] = $item->scaleid;
775                 $jsarguments['items'][$itemid] = array('id'=>$itemid, 'name'=>$item->get_name(true), 'type'=>'scale', 'scale'=>$item->scaleid, 'decimals'=>$item->get_decimals());
776             } else {
777                 $jsarguments['items'][$itemid] = array('id'=>$itemid, 'name'=>$item->get_name(true), 'type'=>'value', 'scale'=>false, 'decimals'=>$item->get_decimals());
778             }
779             $tabindices[$item->id]['grade'] = $gradetabindex;
780             $tabindices[$item->id]['feedback'] = $gradetabindex + $numusers;
781             $gradetabindex += $numusers * 2;
782         }
783         $scalesarray = array();
785         if (!empty($scaleslist)) {
786             $scalesarray = $DB->get_records_list('scale', 'id', $scaleslist);
787         }
788         $jsscales = $scalesarray;
790         $rowclasses = array('even', 'odd');
792         foreach ($this->users as $userid => $user) {
794             if ($this->canviewhidden) {
795                 $altered = array();
796                 $unknown = array();
797             } else {
798                 $hidingaffected = grade_grade::get_hiding_affected($this->grades[$userid], $this->gtree->get_items());
799                 $altered = $hidingaffected['altered'];
800                 $unknown = $hidingaffected['unknown'];
801                 unset($hidingaffected);
802             }
805             $itemrow = new html_table_row();
806             $itemrow->id = 'user_'.$userid;
807             $itemrow->attributes['class'] = $rowclasses[$this->rowcount % 2];
809             $jsarguments['users'][$userid] = fullname($user);
811             foreach ($this->gtree->items as $itemid=>$unused) {
812                 $item =& $this->gtree->items[$itemid];
813                 $grade = $this->grades[$userid][$item->id];
815                 $itemcell = new html_table_cell();
817                 $itemcell->id = 'u'.$userid.'i'.$itemid;
819                 // Get the decimal points preference for this item
820                 $decimalpoints = $item->get_decimals();
822                 if (in_array($itemid, $unknown)) {
823                     $gradeval = null;
824                 } else if (array_key_exists($itemid, $altered)) {
825                     $gradeval = $altered[$itemid];
826                 } else {
827                     $gradeval = $grade->finalgrade;
828                 }
830                 // MDL-11274
831                 // Hide grades in the grader report if the current grader doesn't have 'moodle/grade:viewhidden'
832                 if (!$this->canviewhidden and $grade->is_hidden()) {
833                     if (!empty($CFG->grade_hiddenasdate) and $grade->get_datesubmitted() and !$item->is_category_item() and !$item->is_course_item()) {
834                         // 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
835                         $itemcell->text = html_writer::tag('span', userdate($grade->get_datesubmitted(),get_string('strftimedatetimeshort')), array('class'=>'datesubmitted'));
836                     } else {
837                         $itemcell->text = '-';
838                     }
839                     $itemrow->cells[] = $itemcell;
840                     continue;
841                 }
843                 // emulate grade element
844                 $eid = $this->gtree->get_grade_eid($grade);
845                 $element = array('eid'=>$eid, 'object'=>$grade, 'type'=>'grade');
847                 $itemcell->attributes['class'] .= ' grade';
848                 if ($item->is_category_item()) {
849                     $itemcell->attributes['class'] .= ' cat';
850                 }
851                 if ($item->is_course_item()) {
852                     $itemcell->attributes['class'] .= ' course';
853                 }
854                 if ($grade->is_overridden()) {
855                     $itemcell->attributes['class'] .= ' overridden';
856                 }
858                 if ($grade->is_excluded()) {
859                     // $itemcell->attributes['class'] .= ' excluded';
860                 }
862                 if (!empty($grade->feedback)) {
863                     //should we be truncating feedback? ie $short_feedback = shorten_text($feedback, $this->feedback_trunc_length);
864                     $jsarguments['feedback'][] = array('user'=>$userid, 'item'=>$itemid, 'content'=>wordwrap(trim(format_string($grade->feedback, $grade->feedbackformat)), 34, '<br/ >'));
865                 }
867                 if ($grade->is_excluded()) {
868                     $itemcell->text .= html_writer::tag('span', get_string('excluded', 'grades'), array('class'=>'excludedfloater'));
869                 }
871                 // Do not show any icons if no grade (no record in DB to match)
872                 if (!$item->needsupdate and $USER->gradeediting[$this->courseid]) {
873                     $itemcell->text .= $this->get_icons($element);
874                 }
876                 $hidden = '';
877                 if ($grade->is_hidden()) {
878                     $hidden = ' hidden ';
879                 }
881                 $gradepass = ' gradefail ';
882                 if ($grade->is_passed($item)) {
883                     $gradepass = ' gradepass ';
884                 } elseif (is_null($grade->is_passed($item))) {
885                     $gradepass = '';
886                 }
888                 // if in editting mode, we need to print either a text box
889                 // or a drop down (for scales)
890                 // grades in item of type grade category or course are not directly editable
891                 if ($item->needsupdate) {
892                     $itemcell->text .= html_writer::tag('span', get_string('error'), array('class'=>"gradingerror$hidden"));
894                 } else if ($USER->gradeediting[$this->courseid]) {
896                     if ($item->scaleid && !empty($scalesarray[$item->scaleid])) {
897                         $scale = $scalesarray[$item->scaleid];
898                         $gradeval = (int)$gradeval; // scales use only integers
899                         $scales = explode(",", $scale->scale);
900                         // reindex because scale is off 1
902                         // MDL-12104 some previous scales might have taken up part of the array
903                         // so this needs to be reset
904                         $scaleopt = array();
905                         $i = 0;
906                         foreach ($scales as $scaleoption) {
907                             $i++;
908                             $scaleopt[$i] = $scaleoption;
909                         }
911                         if ($this->get_pref('quickgrading') and $grade->is_editable()) {
912                             $oldval = empty($gradeval) ? -1 : $gradeval;
913                             if (empty($item->outcomeid)) {
914                                 $nogradestr = $this->get_lang_string('nograde');
915                             } else {
916                                 $nogradestr = $this->get_lang_string('nooutcome', 'grades');
917                             }
918                             $itemcell->text .= '<input type="hidden" id="oldgrade_'.$userid.'_'.$item->id.'" name="oldgrade_'.$userid.'_'.$item->id.'" value="'.$oldval.'"/>';
919                             $attributes = array('tabindex' => $tabindices[$item->id]['grade'], 'id'=>'grade_'.$userid.'_'.$item->id);
920                             $itemcell->text .= html_writer::select($scaleopt, 'grade_'.$userid.'_'.$item->id, $gradeval, array(-1=>$nogradestr), $attributes);;
921                         } elseif(!empty($scale)) {
922                             $scales = explode(",", $scale->scale);
924                             // invalid grade if gradeval < 1
925                             if ($gradeval < 1) {
926                                 $itemcell->text .= html_writer::tag('span', '-', array('class'=>"gradevalue$hidden$gradepass"));
927                             } else {
928                                 $gradeval = $grade->grade_item->bounded_grade($gradeval); //just in case somebody changes scale
929                                 $itemcell->text .= html_writer::tag('span', $scales[$gradeval-1], array('class'=>"gradevalue$hidden$gradepass"));
930                             }
931                         } else {
932                             // no such scale, throw error?
933                         }
935                     } else if ($item->gradetype != GRADE_TYPE_TEXT) { // Value type
936                         if ($this->get_pref('quickgrading') and $grade->is_editable()) {
937                             $value = format_float($gradeval, $decimalpoints);
938                             $itemcell->text .= '<input type="hidden" id="oldgrade_'.$userid.'_'.$item->id.'" name="oldgrade_'.$userid.'_'.$item->id.'" value="'.$value.'" />';
939                             $itemcell->text .= '<input size="6" tabindex="' . $tabindices[$item->id]['grade']
940                                           . '" type="text" class="text" title="'. $strgrade .'" name="grade_'
941                                           .$userid.'_' .$item->id.'" id="grade_'.$userid.'_'.$item->id.'" value="'.$value.'" />';
942                         } else {
943                             $itemcell->text .= html_writer::tag('span', format_float($gradeval, $decimalpoints), array('class'=>"gradevalue$hidden$gradepass"));
944                         }
945                     }
948                     // If quickfeedback is on, print an input element
949                     if ($this->get_pref('showquickfeedback') and $grade->is_editable()) {
951                         $itemcell->text .= '<input type="hidden" id="oldfeedback_'.$userid.'_'.$item->id.'" name="oldfeedback_'.$userid.'_'.$item->id.'" value="' . s($grade->feedback) . '" />';
952                         $itemcell->text .= '<input class="quickfeedback" tabindex="' . $tabindices[$item->id]['feedback'].'" id="feedback_'.$userid.'_'.$item->id
953                                       . '" size="6" title="' . $strfeedback . '" type="text" name="feedback_'.$userid.'_'.$item->id.'" value="' . s($grade->feedback) . '" />';
954                     }
956                 } else { // Not editing
957                     $gradedisplaytype = $item->get_displaytype();
959                     if ($item->scaleid && !empty($scalesarray[$item->scaleid])) {
960                         $itemcell->attributes['class'] .= ' grade_type_scale';
961                     } else if ($item->gradetype != GRADE_TYPE_TEXT) {
962                         $itemcell->attributes['class'] .= ' grade_type_text';
963                     }
965                     if ($this->get_pref('enableajax')) {
966                         $itemcell->attributes['class'] .= ' clickable';
967                     }
969                     if ($item->needsupdate) {
970                         $itemcell->text .= html_writer::tag('span', get_string('error'), array('class'=>"gradingerror$hidden$gradepass"));
971                     } else {
972                         $itemcell->text .= html_writer::tag('span', grade_format_gradevalue($gradeval, $item, true, $gradedisplaytype, null), array('class'=>"gradevalue$hidden$gradepass"));
973                     }
974                 }
976                 if (!empty($this->gradeserror[$item->id][$userid])) {
977                     $itemcell->text .= $this->gradeserror[$item->id][$userid];
978                 }
980                 $itemrow->cells[] = $itemcell;
981             }
982             $rows[] = $itemrow;
983         }
985         if ($this->get_pref('enableajax')) {
986             $jsarguments['cfg']['ajaxenabled'] = true;
987             $jsarguments['cfg']['scales'] = array();
988             foreach ($jsscales as $scale) {
989                 $jsarguments['cfg']['scales'][$scale->id] = explode(',',$scale->scale);
990             }
991             $jsarguments['cfg']['feedbacktrunclength'] =  $this->feedback_trunc_length;
993             //feedbacks are now being stored in $jsarguments['feedback'] in get_right_rows()
994             //$jsarguments['cfg']['feedback'] =  $this->feedbacks;
995         }
996         $jsarguments['cfg']['isediting'] = (bool)$USER->gradeediting[$this->courseid];
997         $jsarguments['cfg']['courseid'] =  $this->courseid;
998         $jsarguments['cfg']['studentsperpage'] =  $this->get_pref('studentsperpage');
999         $jsarguments['cfg']['showquickfeedback'] =  (bool)$this->get_pref('showquickfeedback');
1001         $module = array(
1002             'name'      => 'gradereport_grader',
1003             'fullpath'  => '/grade/report/grader/module.js',
1004             'requires'  => array('base', 'dom', 'event', 'event-mouseenter', 'event-key', 'io', 'json-parse', 'overlay')
1005         );
1006         $PAGE->requires->js_init_call('M.gradereport_grader.init_report', $jsarguments, false, $module);
1007         $PAGE->requires->strings_for_js(array('addfeedback','feedback', 'grade'), 'grades');
1008         $PAGE->requires->strings_for_js(array('ajaxchoosescale','ajaxclicktoclose','ajaxerror','ajaxfailedupdate', 'ajaxfieldchanged'), 'gradereport_grader');
1010         $rows = $this->get_right_range_row($rows);
1011         $rows = $this->get_right_avg_row($rows, true);
1012         $rows = $this->get_right_avg_row($rows);
1014         return $rows;
1015     }
1017     /**
1018      * Depending on the style of report (fixedstudents vs traditional one-table),
1019      * arranges the rows of data in one or two tables, and returns the output of
1020      * these tables in HTML
1021      * @return string HTML
1022      */
1023     public function get_grade_table() {
1024         global $OUTPUT;
1025         $fixedstudents = $this->is_fixed_students();
1027         $leftrows = $this->get_left_rows();
1028         $rightrows = $this->get_right_rows();
1030         $html = '';
1033         if ($fixedstudents) {
1034             $fixedcolumntable = new html_table();
1035             $fixedcolumntable->id = 'fixed_column';
1036             $fixedcolumntable->data = $leftrows;
1037             $html .= $OUTPUT->container(html_writer::table($fixedcolumntable), 'left_scroller');
1039             $righttable = new html_table();
1040             $righttable->id = 'user-grades';
1041             $righttable->data = $rightrows;
1043             $html .= $OUTPUT->container(html_writer::table($righttable), 'right_scroller');
1044         } else {
1045             $fulltable = new html_table();
1046             $fulltable->attributes['class'] = 'gradestable flexible boxaligncenter generaltable';
1047             $fulltable->id = 'user-grades';
1049             // Extract rows from each side (left and right) and collate them into one row each
1050             foreach ($leftrows as $key => $row) {
1051                 $row->cells = array_merge($row->cells, $rightrows[$key]->cells);
1052                 $fulltable->data[] = $row;
1053             }
1054             $html .= html_writer::table($fulltable);
1055         }
1056         return $OUTPUT->container($html, 'gradeparent');
1057     }
1059     /**
1060      * Builds and return the row of icons for the left side of the report.
1061      * It only has one cell that says "Controls"
1062      * @param array $rows The Array of rows for the left part of the report
1063      * @param int $colspan The number of columns this cell has to span
1064      * @return array Array of rows for the left part of the report
1065      */
1066     public function get_left_icons_row($rows=array(), $colspan=1) {
1067         global $USER;
1069         if ($USER->gradeediting[$this->courseid]) {
1070             $controlsrow = new html_table_row();
1071             $controlsrow->attributes['class'] = 'controls';
1072             $controlscell = new html_table_cell();
1073             $controlscell->attributes['class'] = 'header controls';
1074             $controlscell->colspan = $colspan;
1075             $controlscell->text = $this->get_lang_string('controls','grades');
1077             $controlsrow->cells[] = $controlscell;
1078             $rows[] = $controlsrow;
1079         }
1080         return $rows;
1081     }
1083     /**
1084      * Builds and return the header for the row of ranges, for the left part of the grader report.
1085      * @param array $rows The Array of rows for the left part of the report
1086      * @param int $colspan The number of columns this cell has to span
1087      * @return array Array of rows for the left part of the report
1088      */
1089     public function get_left_range_row($rows=array(), $colspan=1) {
1090         global $CFG, $USER;
1092         if ($this->get_pref('showranges')) {
1093             $rangerow = new html_table_row();
1094             $rangerow->attributes['class'] = 'range r'.$this->rowcount++;
1095             $rangecell = new html_table_cell();
1096             $rangecell->attributes['class'] = 'header range';
1097             $rangecell->colspan = $colspan;
1098             $rangecell->header = true;
1099             $rangecell->scope = 'row';
1100             $rangecell->text = $this->get_lang_string('range','grades');
1101             $rangerow->cells[] = $rangecell;
1102             $rows[] = $rangerow;
1103         }
1105         return $rows;
1106     }
1108     /**
1109      * Builds and return the headers for the rows of averages, for the left part of the grader report.
1110      * @param array $rows The Array of rows for the left part of the report
1111      * @param int $colspan The number of columns this cell has to span
1112      * @param bool $groupavg If true, returns the row for group averages, otherwise for overall averages
1113      * @return array Array of rows for the left part of the report
1114      */
1115     public function get_left_avg_row($rows=array(), $colspan=1, $groupavg=false) {
1116         if (!$this->canviewhidden) {
1117             // totals might be affected by hiding, if user can not see hidden grades the aggregations might be altered
1118             // better not show them at all if user can not see all hideen grades
1119             return $rows;
1120         }
1122         $showaverages = $this->get_pref('showaverages');
1123         $showaveragesgroup = $this->currentgroup && $showaverages;
1124         $straveragegroup = get_string('groupavg', 'grades');
1126         if ($groupavg) {
1127             if ($showaveragesgroup) {
1128                 $groupavgrow = new html_table_row();
1129                 $groupavgrow->attributes['class'] = 'groupavg r'.$this->rowcount++;
1130                 $groupavgcell = new html_table_cell();
1131                 $groupavgcell->attributes['class'] = 'header range';
1132                 $groupavgcell->colspan = $colspan;
1133                 $groupavgcell->header = true;
1134                 $groupavgcell->scope = 'row';
1135                 $groupavgcell->text = $straveragegroup;
1136                 $groupavgrow->cells[] = $groupavgcell;
1137                 $rows[] = $groupavgrow;
1138             }
1139         } else {
1140             $straverage = get_string('overallaverage', 'grades');
1142             if ($showaverages) {
1143                 $avgrow = new html_table_row();
1144                 $avgrow->attributes['class'] = 'avg r'.$this->rowcount++;
1145                 $avgcell = new html_table_cell();
1146                 $avgcell->attributes['class'] = 'header range';
1147                 $avgcell->colspan = $colspan;
1148                 $avgcell->header = true;
1149                 $avgcell->scope = 'row';
1150                 $avgcell->text = $straverage;
1151                 $avgrow->cells[] = $avgcell;
1152                 $rows[] = $avgrow;
1153             }
1154         }
1156         return $rows;
1157     }
1159     /**
1160      * Builds and return the row of icons when editing is on, for the right part of the grader report.
1161      * @param array $rows The Array of rows for the right part of the report
1162      * @return array Array of rows for the right part of the report
1163      */
1164     public function get_right_icons_row($rows=array()) {
1165         global $USER;
1166         if ($USER->gradeediting[$this->courseid]) {
1167             $iconsrow = new html_table_row();
1168             $iconsrow->attributes['class'] = 'controls';
1170             $showuseridnumber = $this->get_pref('showuseridnumber');
1172             foreach ($this->gtree->items as $itemid=>$unused) {
1173                 // emulate grade element
1174                 $item =& $this->gtree->get_item($itemid);
1176                 $eid = $this->gtree->get_item_eid($item);
1177                 $element = $this->gtree->locate_element($eid);
1178                 $itemcell = new html_table_cell();
1179                 $itemcell->attributes['class'] = 'controls icons';
1180                 $itemcell->text = $this->get_icons($element);
1181                 $iconsrow->cells[] = $itemcell;
1182             }
1183             $rows[] = $iconsrow;
1184         }
1185         return $rows;
1186     }
1188     /**
1189      * Builds and return the row of ranges for the right part of the grader report.
1190      * @param array $rows The Array of rows for the right part of the report
1191      * @return array Array of rows for the right part of the report
1192      */
1193     public function get_right_range_row($rows=array()) {
1194         global $OUTPUT;
1196         if ($this->get_pref('showranges')) {
1197             $rangesdisplaytype   = $this->get_pref('rangesdisplaytype');
1198             $rangesdecimalpoints = $this->get_pref('rangesdecimalpoints');
1199             $rangerow = new html_table_row();
1200             $rangerow->attributes['class'] = 'heading range';
1202             foreach ($this->gtree->items as $itemid=>$unused) {
1203                 $item =& $this->gtree->items[$itemid];
1204                 $itemcell = new html_table_cell();
1205                 $itemcell->header = true;
1206                 $itemcell->attributes['class'] .= ' header range';
1208                 $hidden = '';
1209                 if ($item->is_hidden()) {
1210                     $hidden = ' hidden ';
1211                 }
1213                 $formattedrange = $item->get_formatted_range($rangesdisplaytype, $rangesdecimalpoints);
1215                 $itemcell->text = $OUTPUT->container($formattedrange, 'rangevalues'.$hidden);
1216                 $rangerow->cells[] = $itemcell;
1217             }
1218             $rows[] = $rangerow;
1219         }
1220         return $rows;
1221     }
1223     /**
1224      * Builds and return the row of averages for the right part of the grader report.
1225      * @param array $rows Whether to return only group averages or all averages.
1226      * @param bool $grouponly Whether to return only group averages or all averages.
1227      * @return array Array of rows for the right part of the report
1228      */
1229     public function get_right_avg_row($rows=array(), $grouponly=false) {
1230         global $CFG, $USER, $DB, $OUTPUT;
1232         if (!$this->canviewhidden) {
1233             // totals might be affected by hiding, if user can not see hidden grades the aggregations might be altered
1234             // better not show them at all if user can not see all hideen grades
1235             return $rows;
1236         }
1238         $showaverages = $this->get_pref('showaverages');
1239         $showaveragesgroup = $this->currentgroup && $showaverages;
1241         $averagesdisplaytype   = $this->get_pref('averagesdisplaytype');
1242         $averagesdecimalpoints = $this->get_pref('averagesdecimalpoints');
1243         $meanselection         = $this->get_pref('meanselection');
1244         $shownumberofgrades    = $this->get_pref('shownumberofgrades');
1246         $avghtml = '';
1247         $avgcssclass = 'avg';
1249         if ($grouponly) {
1250             $straverage = get_string('groupavg', 'grades');
1251             $showaverages = $this->currentgroup && $this->get_pref('showaverages');
1252             $groupsql = $this->groupsql;
1253             $groupwheresql = $this->groupwheresql;
1254             $groupwheresqlparams = $this->groupwheresql_params;
1255             $avgcssclass = 'groupavg';
1256         } else {
1257             $straverage = get_string('overallaverage', 'grades');
1258             $showaverages = $this->get_pref('showaverages');
1259             $groupsql = "";
1260             $groupwheresql = "";
1261             $groupwheresqlparams = array();
1262         }
1264         if ($shownumberofgrades) {
1265             $straverage .= ' (' . get_string('submissions', 'grades') . ') ';
1266         }
1268         $totalcount = $this->get_numusers($grouponly);
1270         list($usql, $rolesparams) = $DB->get_in_or_equal(explode(',', $this->gradebookroles), SQL_PARAMS_NAMED, 'grbr0');
1272         if ($showaverages) {
1273             $params = array_merge(array('courseid'=>$this->courseid), $rolesparams, $groupwheresqlparams);
1275             // find sums of all grade items in course
1276             $SQL = "SELECT g.itemid, SUM(g.finalgrade) AS sum
1277                       FROM {grade_items} gi
1278                            JOIN {grade_grades} g      ON g.itemid = gi.id
1279                            JOIN {user} u              ON u.id = g.userid
1280                            JOIN {role_assignments} ra ON ra.userid = u.id
1281                            $groupsql
1282                      WHERE gi.courseid = :courseid
1283                            AND ra.roleid $usql
1284                            AND ra.contextid ".get_related_contexts_string($this->context)."
1285                            AND g.finalgrade IS NOT NULL
1286                            $groupwheresql
1287                   GROUP BY g.itemid";
1288             $sumarray = array();
1289             if ($sums = $DB->get_records_sql($SQL, $params)) {
1290                 foreach ($sums as $itemid => $csum) {
1291                     $sumarray[$itemid] = $csum->sum;
1292                 }
1293             }
1295             // MDL-10875 Empty grades must be evaluated as grademin, NOT always 0
1296             // This query returns a count of ungraded grades (NULL finalgrade OR no matching record in grade_grades table)
1297             $params = array_merge(array('courseid'=>$this->courseid), $rolesparams, $groupwheresqlparams);
1298             $SQL = "SELECT gi.id, COUNT(u.id) AS count
1299                       FROM {grade_items} gi
1300                            CROSS JOIN {user} u
1301                            JOIN {role_assignments} ra        ON ra.userid = u.id
1302                            LEFT OUTER JOIN  {grade_grades} g ON (g.itemid = gi.id AND g.userid = u.id AND g.finalgrade IS NOT NULL)
1303                            $groupsql
1304                      WHERE gi.courseid = :courseid
1305                            AND ra.roleid $usql
1306                            AND ra.contextid ".get_related_contexts_string($this->context)."
1307                            AND g.id IS NULL
1308                            $groupwheresql
1309                   GROUP BY gi.id";
1311             $ungradedcounts = $DB->get_records_sql($SQL, $params);
1313             $avgrow = new html_table_row();
1314             $avgrow->attributes['class'] = 'avg';
1316             foreach ($this->gtree->items as $itemid=>$unused) {
1317                 $item =& $this->gtree->items[$itemid];
1319                 if ($item->needsupdate) {
1320                     $avgcell = new html_table_cell();
1321                     $avgcell->text = $OUTPUT->container(get_string('error'), 'gradingerror');
1322                     $avgrow->cells[] = $avgcell;
1323                     continue;
1324                 }
1326                 if (!isset($sumarray[$item->id])) {
1327                     $sumarray[$item->id] = 0;
1328                 }
1330                 if (empty($ungradedcounts[$itemid])) {
1331                     $ungradedcount = 0;
1332                 } else {
1333                     $ungradedcount = $ungradedcounts[$itemid]->count;
1334                 }
1336                 if ($meanselection == GRADE_REPORT_MEAN_GRADED) {
1337                     $meancount = $totalcount - $ungradedcount;
1338                 } else { // Bump up the sum by the number of ungraded items * grademin
1339                     $sumarray[$item->id] += $ungradedcount * $item->grademin;
1340                     $meancount = $totalcount;
1341                 }
1343                 $decimalpoints = $item->get_decimals();
1345                 // Determine which display type to use for this average
1346                 if ($USER->gradeediting[$this->courseid]) {
1347                     $displaytype = GRADE_DISPLAY_TYPE_REAL;
1349                 } else if ($averagesdisplaytype == GRADE_REPORT_PREFERENCE_INHERIT) { // no ==0 here, please resave the report and user preferences
1350                     $displaytype = $item->get_displaytype();
1352                 } else {
1353                     $displaytype = $averagesdisplaytype;
1354                 }
1356                 // Override grade_item setting if a display preference (not inherit) was set for the averages
1357                 if ($averagesdecimalpoints == GRADE_REPORT_PREFERENCE_INHERIT) {
1358                     $decimalpoints = $item->get_decimals();
1360                 } else {
1361                     $decimalpoints = $averagesdecimalpoints;
1362                 }
1364                 if (!isset($sumarray[$item->id]) || $meancount == 0) {
1365                     $avgcell = new html_table_cell();
1366                     $avgcell->text = '-';
1367                     $avgrow->cells[] = $avgcell;
1369                 } else {
1370                     $sum = $sumarray[$item->id];
1371                     $avgradeval = $sum/$meancount;
1372                     $gradehtml = grade_format_gradevalue($avgradeval, $item, true, $displaytype, $decimalpoints);
1374                     $numberofgrades = '';
1375                     if ($shownumberofgrades) {
1376                         $numberofgrades = " ($meancount)";
1377                     }
1379                     $avgcell = new html_table_cell();
1380                     $avgcell->text = $gradehtml.$numberofgrades;
1381                     $avgrow->cells[] = $avgcell;
1382                 }
1383             }
1384             $rows[] = $avgrow;
1385         }
1386         return $rows;
1387     }
1389     /**
1390      * Given a grade_category, grade_item or grade_grade, this function
1391      * figures out the state of the object and builds then returns a div
1392      * with the icons needed for the grader report.
1393      *
1394      * @param object $object
1395      * @return string HTML
1396      */
1397     protected function get_icons($element) {
1398         global $CFG, $USER, $OUTPUT;
1400         if (!$USER->gradeediting[$this->courseid]) {
1401             return '<div class="grade_icons" />';
1402         }
1404         // Init all icons
1405         $editicon = '';
1407         if ($element['type'] != 'categoryitem' && $element['type'] != 'courseitem') {
1408             $editicon = $this->gtree->get_edit_icon($element, $this->gpr);
1409         }
1411         $editcalculationicon = '';
1412         $showhideicon        = '';
1413         $lockunlockicon      = '';
1415         if (has_capability('moodle/grade:manage', $this->context)) {
1417             if ($this->get_pref('showcalculations')) {
1418                 $editcalculationicon = $this->gtree->get_calculation_icon($element, $this->gpr);
1419             }
1421             if ($this->get_pref('showeyecons')) {
1422                $showhideicon = $this->gtree->get_hiding_icon($element, $this->gpr);
1423             }
1425             if ($this->get_pref('showlocks')) {
1426                 $lockunlockicon = $this->gtree->get_locking_icon($element, $this->gpr);
1427             }
1428         }
1430         return $OUTPUT->container($editicon.$editcalculationicon.$showhideicon.$lockunlockicon, 'grade_icons');
1431     }
1433     /**
1434      * Given a category element returns collapsing +/- icon if available
1435      * @param object $object
1436      * @return string HTML
1437      */
1438     protected function get_collapsing_icon($element) {
1439         global $OUTPUT;
1441         $icon = '';
1442         // If object is a category, display expand/contract icon
1443         if ($element['type'] == 'category') {
1444             // Load language strings
1445             $strswitchminus = $this->get_lang_string('aggregatesonly', 'grades');
1446             $strswitchplus  = $this->get_lang_string('gradesonly', 'grades');
1447             $strswitchwhole = $this->get_lang_string('fullmode', 'grades');
1449             $url = new moodle_url($this->gpr->get_return_url(null, array('target'=>$element['eid'], 'sesskey'=>sesskey())));
1451             if (in_array($element['object']->id, $this->collapsed['aggregatesonly'])) {
1452                 $url->param('action', 'switch_plus');
1453                 $icon = $OUTPUT->action_icon($url, new pix_icon('t/switch_plus', $strswitchplus));
1455             } else if (in_array($element['object']->id, $this->collapsed['gradesonly'])) {
1456                 $url->param('action', 'switch_whole');
1457                 $icon = $OUTPUT->action_icon($url, new pix_icon('t/switch_whole', $strswitchwhole));
1458                 $contractexpandicon->image->src = $OUTPUT->pix_url('t/switch_whole');
1460             } else {
1461                 $url->param('action', 'switch_minus');
1462                 $icon = $OUTPUT->action_icon($url, new pix_icon('t/switch_minus', $strswitchminus));
1463             }
1464         }
1465         return $icon;
1466     }
1468     /**
1469      * Processes a single action against a category, grade_item or grade.
1470      * @param string $target eid ({type}{id}, e.g. c4 for category4)
1471      * @param string $action Which action to take (edit, delete etc...)
1472      * @return
1473      */
1474     public function process_action($target, $action) {
1475         // TODO: this code should be in some grade_tree static method
1476         $targettype = substr($target, 0, 1);
1477         $targetid = substr($target, 1);
1478         // TODO: end
1480         if ($collapsed = get_user_preferences('grade_report_grader_collapsed_categories')) {
1481             $collapsed = unserialize($collapsed);
1482         } else {
1483             $collapsed = array('aggregatesonly' => array(), 'gradesonly' => array());
1484         }
1486         switch ($action) {
1487             case 'switch_minus': // Add category to array of aggregatesonly
1488                 if (!in_array($targetid, $collapsed['aggregatesonly'])) {
1489                     $collapsed['aggregatesonly'][] = $targetid;
1490                     set_user_preference('grade_report_grader_collapsed_categories', serialize($collapsed));
1491                 }
1492                 break;
1494             case 'switch_plus': // Remove category from array of aggregatesonly, and add it to array of gradesonly
1495                 $key = array_search($targetid, $collapsed['aggregatesonly']);
1496                 if ($key !== false) {
1497                     unset($collapsed['aggregatesonly'][$key]);
1498                 }
1499                 if (!in_array($targetid, $collapsed['gradesonly'])) {
1500                     $collapsed['gradesonly'][] = $targetid;
1501                 }
1502                 set_user_preference('grade_report_grader_collapsed_categories', serialize($collapsed));
1503                 break;
1504             case 'switch_whole': // Remove the category from the array of collapsed cats
1505                 $key = array_search($targetid, $collapsed['gradesonly']);
1506                 if ($key !== false) {
1507                     unset($collapsed['gradesonly'][$key]);
1508                     set_user_preference('grade_report_grader_collapsed_categories', serialize($collapsed));
1509                 }
1511                 break;
1512             default:
1513                 break;
1514         }
1516         return true;
1517     }
1519     /**
1520      * Returns whether or not to display fixed students column.
1521      * Includes a browser check, because IE6 doesn't support the scrollbar.
1522      *
1523      * @return bool
1524      */
1525     public function is_fixed_students() {
1526         global $USER, $CFG;
1527         return empty($USER->screenreader) && $CFG->grade_report_fixedstudents &&
1528             (check_browser_version('MSIE', '7.0') ||
1529              check_browser_version('Firefox', '2.0') ||
1530              check_browser_version('Gecko', '2006010100') ||
1531              check_browser_version('Camino', '1.0') ||
1532              check_browser_version('Opera', '6.0') ||
1533              check_browser_version('Safari', '2.0'));
1534     }
1536     /**
1537      * Refactored function for generating HTML of sorting links with matching arrows.
1538      * Returns an array with 'studentname' and 'idnumber' as keys, with HTML ready
1539      * to inject into a table header cell.
1540      * @return array An associative array of HTML sorting links+arrows
1541      */
1542     public function get_sort_arrows() {
1543         global $OUTPUT;
1544         $arrows = array();
1546         $strsortasc   = $this->get_lang_string('sortasc', 'grades');
1547         $strsortdesc  = $this->get_lang_string('sortdesc', 'grades');
1548         $strfirstname = $this->get_lang_string('firstname');
1549         $strlastname  = $this->get_lang_string('lastname');
1551         $firstlink = html_writer::link(new moodle_url($this->baseurl, array('sortitemid'=>'firstname')), $strfirstname);
1552         $lastlink = html_writer::link(new moodle_url($this->baseurl, array('sortitemid'=>'lastname')), $strlastname);
1553         $idnumberlink = html_writer::link(new moodle_url($this->baseurl, array('sortitemid'=>'idnumber')), get_string('idnumber'));
1555         $arrows['studentname'] = $lastlink;
1557         if ($this->sortitemid === 'lastname') {
1558             if ($this->sortorder == 'ASC') {
1559                 $arrows['studentname'] .= print_arrow('up', $strsortasc, true);
1560             } else {
1561                 $arrows['studentname'] .= print_arrow('down', $strsortdesc, true);
1562             }
1563         }
1565         $arrows['studentname'] .= ' ' . $firstlink;
1567         if ($this->sortitemid === 'firstname') {
1568             if ($this->sortorder == 'ASC') {
1569                 $arrows['studentname'] .= print_arrow('up', $strsortasc, true);
1570             } else {
1571                 $arrows['studentname'] .= print_arrow('down', $strsortdesc, true);
1572             }
1573         }
1575         $arrows['idnumber'] = $idnumberlink;
1577         if ('idnumber' == $this->sortitemid) {
1578             if ($this->sortorder == 'ASC') {
1579                 $arrows['idnumber'] .= print_arrow('up', $strsortasc, true);
1580             } else {
1581                 $arrows['idnumber'] .= print_arrow('down', $strsortdesc, true);
1582             }
1583         }
1585         return $arrows;
1586     }