gradebook MDL-23033 made use of user_picture::fields()
[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);
367             $userfields = user_picture::fields('u');
368             $sql = "SELECT DISTINCT $userfields, u.idnumber
369                       FROM {user} u
370                            JOIN {role_assignments} ra ON u.id = ra.userid
371                            $this->groupsql
372                      WHERE ra.roleid $usql AND u.deleted = 0
373                            $this->groupwheresql
374                            AND ra.contextid ".get_related_contexts_string($this->context)."
375                   ORDER BY $sort";
376         }
379         $this->users = $DB->get_records_sql($sql, $params, $this->get_pref('studentsperpage') * $this->page, $this->get_pref('studentsperpage'));
381         if (empty($this->users)) {
382             $this->userselect = '';
383             $this->users = array();
384             $this->userselect_params = array();
385         } else {
386             list($usql, $params) = $DB->get_in_or_equal(array_keys($this->users), SQL_PARAMS_NAMED, 'usid0');
387             $this->userselect = "AND g.userid $usql";
388             $this->userselect_params = $params;
389         }
391         return $this->users;
392     }
394     /**
395      * we supply the userids in this query, and get all the grades
396      * pulls out all the grades, this does not need to worry about paging
397      */
398     public function load_final_grades() {
399         global $CFG, $DB;
401         // please note that we must fetch all grade_grades fields if we want to contruct grade_grade object from it!
402         $params = array_merge(array('courseid'=>$this->courseid), $this->userselect_params);
403         $sql = "SELECT g.*
404                   FROM {grade_items} gi,
405                        {grade_grades} g
406                  WHERE g.itemid = gi.id AND gi.courseid = :courseid {$this->userselect}";
408         $userids = array_keys($this->users);
411         if ($grades = $DB->get_records_sql($sql, $params)) {
412             foreach ($grades as $graderec) {
413                 if (in_array($graderec->userid, $userids) and array_key_exists($graderec->itemid, $this->gtree->get_items())) { // some items may not be present!!
414                     $this->grades[$graderec->userid][$graderec->itemid] = new grade_grade($graderec, false);
415                     $this->grades[$graderec->userid][$graderec->itemid]->grade_item =& $this->gtree->get_item($graderec->itemid); // db caching
416                 }
417             }
418         }
420         // prefil grades that do not exist yet
421         foreach ($userids as $userid) {
422             foreach ($this->gtree->get_items() as $itemid=>$unused) {
423                 if (!isset($this->grades[$userid][$itemid])) {
424                     $this->grades[$userid][$itemid] = new grade_grade();
425                     $this->grades[$userid][$itemid]->itemid = $itemid;
426                     $this->grades[$userid][$itemid]->userid = $userid;
427                     $this->grades[$userid][$itemid]->grade_item =& $this->gtree->get_item($itemid); // db caching
428                 }
429             }
430         }
431     }
433     /**
434      * Builds and returns a div with on/off toggles.
435      * @return string HTML code
436      */
437     public function get_toggles_html() {
438         global $CFG, $USER, $COURSE, $OUTPUT;
440         $html = '';
441         if ($USER->gradeediting[$this->courseid]) {
442             if (has_capability('moodle/grade:manage', $this->context) or has_capability('moodle/grade:hide', $this->context)) {
443                 $html .= $this->print_toggle('eyecons');
444             }
445             if (has_capability('moodle/grade:manage', $this->context)
446              or has_capability('moodle/grade:lock', $this->context)
447              or has_capability('moodle/grade:unlock', $this->context)) {
448                 $html .= $this->print_toggle('locks');
449             }
450             if (has_capability('moodle/grade:manage', $this->context)) {
451                 $html .= $this->print_toggle('quickfeedback');
452             }
454             if (has_capability('moodle/grade:manage', $this->context)) {
455                 $html .= $this->print_toggle('calculations');
456             }
457         }
459         if ($this->canviewhidden) {
460             $html .= $this->print_toggle('averages');
461         }
463         $html .= $this->print_toggle('ranges');
464         if (!empty($CFG->enableoutcomes)) {
465             $html .= $this->print_toggle('nooutcomes');
466         }
468         return $OUTPUT->container($html, 'grade-report-toggles');
469     }
471     /**
472     * Shortcut function for printing the grader report toggles.
473     * @param string $type The type of toggle
474     * @param bool $return Whether to return the HTML string rather than printing it
475     * @return void
476     */
477     public function print_toggle($type) {
478         global $CFG, $OUTPUT;
480         $icons = array('eyecons' => 't/hide',
481                        'calculations' => 't/calc',
482                        'locks' => 't/lock',
483                        'averages' => 't/mean',
484                        'quickfeedback' => 't/feedback',
485                        'nooutcomes' => 't/outcomes');
487         $prefname = 'grade_report_show' . $type;
489         if (array_key_exists($prefname, $CFG)) {
490             $showpref = get_user_preferences($prefname, $CFG->$prefname);
491         } else {
492             $showpref = get_user_preferences($prefname);
493         }
495         $strshow = $this->get_lang_string('show' . $type, 'grades');
496         $strhide = $this->get_lang_string('hide' . $type, 'grades');
498         $showhide = 'show';
499         $toggleaction = 1;
501         if ($showpref) {
502             $showhide = 'hide';
503             $toggleaction = 0;
504         }
506         if (array_key_exists($type, $icons)) {
507             $imagename = $icons[$type];
508         } else {
509             $imagename = "t/$type.gif";
510         }
512         $string = ${'str' . $showhide};
514         $aurl = clone($this->baseurl);
515         $url->params(array('toggle' => $toggleaction, 'toggle_type' => $type));
517         $retval = $OUTPUT->container($OUTPUT->action_icon($url, new pix_icon($imagename, $string))); // TODO: this container looks wrong here
519         return $retval;
520     }
522     /**
523      * Builds and returns the rows that will make up the left part of the grader report
524      * This consists of student names and icons, links to user reports and id numbers, as well
525      * as header cells for these columns. It also includes the fillers required for the
526      * categories displayed on the right side of the report.
527      * @return array Array of html_table_row objects
528      */
529     public function get_left_rows() {
530         global $CFG, $USER, $OUTPUT;
532         $rows = array();
534         $showuserimage = $this->get_pref('showuserimage');
535         $showuseridnumber = $this->get_pref('showuseridnumber');
536         $fixedstudents = $this->is_fixed_students();
538         $strfeedback  = $this->get_lang_string("feedback");
539         $strgrade     = $this->get_lang_string('grade');
541         $arrows = $this->get_sort_arrows();
543         $colspan = 1;
545         if (has_capability('gradereport/'.$CFG->grade_profilereport.':view', $this->context)) {
546             $colspan++;
547         }
549         if ($showuseridnumber) {
550             $colspan++;
551         }
553         $levels = count($this->gtree->levels) - 1;
555         for ($i = 0; $i < $levels; $i++) {
556             $fillercell = new html_table_cell();
557             $fillercell->attributes['class'] = 'fixedcolumn cell topleft';
558             $fillercell->text = ' ';
559             $fillercell->colspan = $colspan;
560             $row = new html_table_row(array($fillercell));
561             $rows[] = $row;
562         }
564         $headerrow = new html_table_row();
565         $headerrow->attributes['class'] = 'heading';
567         $studentheader = new html_table_cell();
568         $studentheader->attributes['class'] = 'header';
569         $studentheader->scope = 'col';
570         $studentheader->header = true;
571         $studentheader->id = 'studentheader';
572         if (has_capability('gradereport/'.$CFG->grade_profilereport.':view', $this->context)) {
573             $studentheader->colspan = 2;
574         }
575         $studentheader->text = $arrows['studentname'];
577         $headerrow->cells[] = $studentheader;
579         if ($showuseridnumber) {
580             // TODO: weird, this is not used anywhere
581             $sortidnumberlink = html_writer::link(new moodle_url($this->baseurl, array('sortitemid'=>'idnumber')), get_string('idnumber'));
583             $idnumberheader = new html_table_cell();
584             $idnumberheader->attributes['class'] = 'header useridnumber';
585             $idnumberheader->scope = 'col';
586             $idnumberheader->header = true;
587             $idnumberheader->text = $arrows['idnumber'];
589             $headerrow->cells[] = $idnumberheader;
590         }
592         $rows[] = $headerrow;
594         $rows = $this->get_left_icons_row($rows, $colspan);
596         $rowclasses = array('even', 'odd');
598         foreach ($this->users as $userid => $user) {
599             $userrow = new html_table_row();
600             $userrow->id = 'fixed_user_'.$userid;
601             $userrow->attributes['class'] = 'r'.$this->rowcount++.' '.$rowclasses[$this->rowcount % 2];
603             $usercell = new html_table_cell();
604             $usercell->attributes['class'] = 'user';
605             $usercell->header = true;
606             $usercell->scope = 'row';
608             if ($showuserimage) {
609                 $usercell->text = $OUTPUT->container($OUTPUT->user_picture($user), 'userpic');
610             }
612             $usercell->text .= html_writer::link(new moodle_url('/user/view.php', array('id' => $user->id, 'course' => $this->course->id)), fullname($user));
614             $userrow->cells[] = $usercell;
616             if (has_capability('gradereport/'.$CFG->grade_profilereport.':view', $this->context)) {
617                 $userreportcell = new html_table_cell();
618                 $userreportcell->attributes['class'] = 'userreport';
619                 $userreportcell->header = true;
620                 $a->user = fullname($user);
621                 $strgradesforuser = get_string('gradesforuser', 'grades', $a);
622                 $url = new moodle_url('/grade/report/'.$CFG->grade_profilereport.'/index.php', array('userid' => $user->id, 'id' => $this->course->id));
623                 $userreportcell->text = $OUTPUT->action_icon($url, new pix_icon('t/grades', $strgradesforuser));
624                 $userrow->cells[] = $userreportcell;
625             }
627             if ($showuseridnumber) {
628                 $idnumbercell = new html_table_cell();
629                 $idnumbercell->attributes['class'] = 'header useridnumber';
630                 $idnumbercell->header = true;
631                 $idnumbercell->scope = 'row';
632                 $userrow->cells[] = $idnumbercell;
633             }
635             $rows[] = $userrow;
636         }
638         $rows = $this->get_left_range_row($rows, $colspan);
639         $rows = $this->get_left_avg_row($rows, $colspan, true);
640         $rows = $this->get_left_avg_row($rows, $colspan);
642         return $rows;
643     }
645     /**
646      * Builds and returns the rows that will make up the right part of the grader report
647      * @return array Array of html_table_row objects
648      */
649     public function get_right_rows() {
650         global $CFG, $USER, $OUTPUT, $DB, $PAGE;
652         $rows = array();
653         $this->rowcount = 0;
654         $numrows = count($this->gtree->get_levels());
655         $numusers = count($this->users);
656         $gradetabindex = 1;
657         $columnstounset = array();
658         $strgrade = $this->get_lang_string('grade');
659         $strfeedback  = $this->get_lang_string("feedback");
660         $arrows = $this->get_sort_arrows();
662         $jsarguments = array(
663             'id'        => '#fixed_column',
664             'cfg'       => array('ajaxenabled'=>false),
665             'items'     => array(),
666             'users'     => array(),
667             'feedback'  => array()
668         );
669         $jsscales = array();
671         foreach ($this->gtree->get_levels() as $key=>$row) {
672             if ($key == 0) {
673                 // do not display course grade category
674                 // continue;
675             }
677             $headingrow = new html_table_row();
678             $headingrow->attributes['class'] = 'heading_name_row';
680             foreach ($row as $columnkey => $element) {
681                 $sortlink = clone($this->baseurl);
682                 if (isset($element['object']->id)) {
683                     $sortlink->param('sortitemid', $element['object']->id);
684                 }
686                 $eid    = $element['eid'];
687                 $object = $element['object'];
688                 $type   = $element['type'];
689                 $categorystate = @$element['categorystate'];
690                 $itemmodule = null;
691                 $iteminstance = null;
693                 if (!empty($element['colspan'])) {
694                     $colspan = $element['colspan'];
695                 } else {
696                     $colspan = 1;
697                 }
699                 if (!empty($element['depth'])) {
700                     $catlevel = 'catlevel'.$element['depth'];
701                 } else {
702                     $catlevel = '';
703                 }
705 // Element is a filler
706                 if ($type == 'filler' or $type == 'fillerfirst' or $type == 'fillerlast') {
707                     $fillercell = new html_table_cell();
708                     $fillercell->attributes['class'] = $type . ' ' . $catlevel;
709                     $fillercell->colspan = $colspan;
710                     $fillercell->text = '&nbsp;';
711                     $fillercell->header = true;
712                     $fillercell->scope = 'col';
713                     $headingrow->cells[] = $fillercell;
714                 }
715 // Element is a category
716                 else if ($type == 'category') {
717                     $categorycell = new html_table_cell();
718                     $categorycell->attributes['class'] = 'category ' . $catlevel;
719                     $categorycell->colspan = $colspan;
720                     $categorycell->text = shorten_text($element['object']->get_name());
721                     $categorycell->text .= $this->get_collapsing_icon($element);
722                     $categorycell->header = true;
723                     $categorycell->scope = 'col';
725                     // Print icons
726                     if ($USER->gradeediting[$this->courseid]) {
727                         $categorycell->text .= $this->get_icons($element);
728                     }
730                     $headingrow->cells[] = $categorycell;
731                 }
732 // Element is a grade_item
733                 else {
734                     $itemmodule = $element['object']->itemmodule;
735                     $iteminstance = $element['object']->iteminstance;
737                     if ($element['object']->id == $this->sortitemid) {
738                         if ($this->sortorder == 'ASC') {
739                             $arrow = $this->get_sort_arrow('up', $sortlink);
740                         } else {
741                             $arrow = $this->get_sort_arrow('down', $sortlink);
742                         }
743                     } else {
744                         $arrow = $this->get_sort_arrow('move', $sortlink);
745                     }
747                     $headerlink = $this->gtree->get_element_header($element, true, $this->get_pref('showactivityicons'), false);
749                     $itemcell = new html_table_cell();
750                     $itemcell->attributes['class'] = $type . ' ' . $catlevel . 'highlightable';
752                     if ($element['object']->is_hidden()) {
753                         $itemcell->attributes['class'] .= ' hidden';
754                     }
756                     $itemcell->colspan = $colspan;
757                     $itemcell->text = shorten_text($headerlink) . $arrow;
758                     $itemcell->header = true;
759                     $itemcell->scope = 'col';
761                     $headingrow->cells[] = $itemcell;
762                 }
763             }
764             $rows[] = $headingrow;
765         }
767         $rows = $this->get_right_icons_row($rows);
769         // Preload scale objects for items with a scaleid
770         $scaleslist = array();
771         $tabindices = array();
773         foreach ($this->gtree->get_items() as $itemid=>$item) {
774             $scale = null;
775             if (!empty($item->scaleid)) {
776                 $scaleslist[] = $item->scaleid;
777                 $jsarguments['items'][$itemid] = array('id'=>$itemid, 'name'=>$item->get_name(true), 'type'=>'scale', 'scale'=>$item->scaleid, 'decimals'=>$item->get_decimals());
778             } else {
779                 $jsarguments['items'][$itemid] = array('id'=>$itemid, 'name'=>$item->get_name(true), 'type'=>'value', 'scale'=>false, 'decimals'=>$item->get_decimals());
780             }
781             $tabindices[$item->id]['grade'] = $gradetabindex;
782             $tabindices[$item->id]['feedback'] = $gradetabindex + $numusers;
783             $gradetabindex += $numusers * 2;
784         }
785         $scalesarray = array();
787         if (!empty($scaleslist)) {
788             $scalesarray = $DB->get_records_list('scale', 'id', $scaleslist);
789         }
790         $jsscales = $scalesarray;
792         $rowclasses = array('even', 'odd');
794         foreach ($this->users as $userid => $user) {
796             if ($this->canviewhidden) {
797                 $altered = array();
798                 $unknown = array();
799             } else {
800                 $hidingaffected = grade_grade::get_hiding_affected($this->grades[$userid], $this->gtree->get_items());
801                 $altered = $hidingaffected['altered'];
802                 $unknown = $hidingaffected['unknown'];
803                 unset($hidingaffected);
804             }
807             $itemrow = new html_table_row();
808             $itemrow->id = 'user_'.$userid;
809             $itemrow->attributes['class'] = $rowclasses[$this->rowcount % 2];
811             $jsarguments['users'][$userid] = fullname($user);
813             foreach ($this->gtree->items as $itemid=>$unused) {
814                 $item =& $this->gtree->items[$itemid];
815                 $grade = $this->grades[$userid][$item->id];
817                 $itemcell = new html_table_cell();
819                 $itemcell->id = 'u'.$userid.'i'.$itemid;
821                 // Get the decimal points preference for this item
822                 $decimalpoints = $item->get_decimals();
824                 if (in_array($itemid, $unknown)) {
825                     $gradeval = null;
826                 } else if (array_key_exists($itemid, $altered)) {
827                     $gradeval = $altered[$itemid];
828                 } else {
829                     $gradeval = $grade->finalgrade;
830                 }
832                 // MDL-11274
833                 // Hide grades in the grader report if the current grader doesn't have 'moodle/grade:viewhidden'
834                 if (!$this->canviewhidden and $grade->is_hidden()) {
835                     if (!empty($CFG->grade_hiddenasdate) and $grade->get_datesubmitted() and !$item->is_category_item() and !$item->is_course_item()) {
836                         // 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
837                         $itemcell->text = html_writer::tag('span', userdate($grade->get_datesubmitted(),get_string('strftimedatetimeshort')), array('class'=>'datesubmitted'));
838                     } else {
839                         $itemcell->text = '-';
840                     }
841                     $itemrow->cells[] = $itemcell;
842                     continue;
843                 }
845                 // emulate grade element
846                 $eid = $this->gtree->get_grade_eid($grade);
847                 $element = array('eid'=>$eid, 'object'=>$grade, 'type'=>'grade');
849                 $itemcell->attributes['class'] .= ' grade';
850                 if ($item->is_category_item()) {
851                     $itemcell->attributes['class'] .= ' cat';
852                 }
853                 if ($item->is_course_item()) {
854                     $itemcell->attributes['class'] .= ' course';
855                 }
856                 if ($grade->is_overridden()) {
857                     $itemcell->attributes['class'] .= ' overridden';
858                 }
860                 if ($grade->is_excluded()) {
861                     // $itemcell->attributes['class'] .= ' excluded';
862                 }
864                 if (!empty($grade->feedback)) {
865                     //should we be truncating feedback? ie $short_feedback = shorten_text($feedback, $this->feedback_trunc_length);
866                     $jsarguments['feedback'][] = array('user'=>$userid, 'item'=>$itemid, 'content'=>wordwrap(trim(format_string($grade->feedback, $grade->feedbackformat)), 34, '<br/ >'));
867                 }
869                 if ($grade->is_excluded()) {
870                     $itemcell->text .= html_writer::tag('span', get_string('excluded', 'grades'), array('class'=>'excludedfloater'));
871                 }
873                 // Do not show any icons if no grade (no record in DB to match)
874                 if (!$item->needsupdate and $USER->gradeediting[$this->courseid]) {
875                     $itemcell->text .= $this->get_icons($element);
876                 }
878                 $hidden = '';
879                 if ($grade->is_hidden()) {
880                     $hidden = ' hidden ';
881                 }
883                 $gradepass = ' gradefail ';
884                 if ($grade->is_passed($item)) {
885                     $gradepass = ' gradepass ';
886                 } elseif (is_null($grade->is_passed($item))) {
887                     $gradepass = '';
888                 }
890                 // if in editting mode, we need to print either a text box
891                 // or a drop down (for scales)
892                 // grades in item of type grade category or course are not directly editable
893                 if ($item->needsupdate) {
894                     $itemcell->text .= html_writer::tag('span', get_string('error'), array('class'=>"gradingerror$hidden"));
896                 } else if ($USER->gradeediting[$this->courseid]) {
898                     if ($item->scaleid && !empty($scalesarray[$item->scaleid])) {
899                         $scale = $scalesarray[$item->scaleid];
900                         $gradeval = (int)$gradeval; // scales use only integers
901                         $scales = explode(",", $scale->scale);
902                         // reindex because scale is off 1
904                         // MDL-12104 some previous scales might have taken up part of the array
905                         // so this needs to be reset
906                         $scaleopt = array();
907                         $i = 0;
908                         foreach ($scales as $scaleoption) {
909                             $i++;
910                             $scaleopt[$i] = $scaleoption;
911                         }
913                         if ($this->get_pref('quickgrading') and $grade->is_editable()) {
914                             $oldval = empty($gradeval) ? -1 : $gradeval;
915                             if (empty($item->outcomeid)) {
916                                 $nogradestr = $this->get_lang_string('nograde');
917                             } else {
918                                 $nogradestr = $this->get_lang_string('nooutcome', 'grades');
919                             }
920                             $itemcell->text .= '<input type="hidden" id="oldgrade_'.$userid.'_'.$item->id.'" name="oldgrade_'.$userid.'_'.$item->id.'" value="'.$oldval.'"/>';
921                             $attributes = array('tabindex' => $tabindices[$item->id]['grade'], 'id'=>'grade_'.$userid.'_'.$item->id);
922                             $itemcell->text .= html_writer::select($scaleopt, 'grade_'.$userid.'_'.$item->id, $gradeval, array(-1=>$nogradestr), $attributes);;
923                         } elseif(!empty($scale)) {
924                             $scales = explode(",", $scale->scale);
926                             // invalid grade if gradeval < 1
927                             if ($gradeval < 1) {
928                                 $itemcell->text .= html_writer::tag('span', '-', array('class'=>"gradevalue$hidden$gradepass"));
929                             } else {
930                                 $gradeval = $grade->grade_item->bounded_grade($gradeval); //just in case somebody changes scale
931                                 $itemcell->text .= html_writer::tag('span', $scales[$gradeval-1], array('class'=>"gradevalue$hidden$gradepass"));
932                             }
933                         } else {
934                             // no such scale, throw error?
935                         }
937                     } else if ($item->gradetype != GRADE_TYPE_TEXT) { // Value type
938                         if ($this->get_pref('quickgrading') and $grade->is_editable()) {
939                             $value = format_float($gradeval, $decimalpoints);
940                             $itemcell->text .= '<input type="hidden" id="oldgrade_'.$userid.'_'.$item->id.'" name="oldgrade_'.$userid.'_'.$item->id.'" value="'.$value.'" />';
941                             $itemcell->text .= '<input size="6" tabindex="' . $tabindices[$item->id]['grade']
942                                           . '" type="text" class="text" title="'. $strgrade .'" name="grade_'
943                                           .$userid.'_' .$item->id.'" id="grade_'.$userid.'_'.$item->id.'" value="'.$value.'" />';
944                         } else {
945                             $itemcell->text .= html_writer::tag('span', format_float($gradeval, $decimalpoints), array('class'=>"gradevalue$hidden$gradepass"));
946                         }
947                     }
950                     // If quickfeedback is on, print an input element
951                     if ($this->get_pref('showquickfeedback') and $grade->is_editable()) {
953                         $itemcell->text .= '<input type="hidden" id="oldfeedback_'.$userid.'_'.$item->id.'" name="oldfeedback_'.$userid.'_'.$item->id.'" value="' . s($grade->feedback) . '" />';
954                         $itemcell->text .= '<input class="quickfeedback" tabindex="' . $tabindices[$item->id]['feedback'].'" id="feedback_'.$userid.'_'.$item->id
955                                       . '" size="6" title="' . $strfeedback . '" type="text" name="feedback_'.$userid.'_'.$item->id.'" value="' . s($grade->feedback) . '" />';
956                     }
958                 } else { // Not editing
959                     $gradedisplaytype = $item->get_displaytype();
961                     if ($item->scaleid && !empty($scalesarray[$item->scaleid])) {
962                         $itemcell->attributes['class'] .= ' grade_type_scale';
963                     } else if ($item->gradetype != GRADE_TYPE_TEXT) {
964                         $itemcell->attributes['class'] .= ' grade_type_text';
965                     }
967                     if ($this->get_pref('enableajax')) {
968                         $itemcell->attributes['class'] .= ' clickable';
969                     }
971                     if ($item->needsupdate) {
972                         $itemcell->text .= html_writer::tag('span', get_string('error'), array('class'=>"gradingerror$hidden$gradepass"));
973                     } else {
974                         $itemcell->text .= html_writer::tag('span', grade_format_gradevalue($gradeval, $item, true, $gradedisplaytype, null), array('class'=>"gradevalue$hidden$gradepass"));
975                     }
976                 }
978                 if (!empty($this->gradeserror[$item->id][$userid])) {
979                     $itemcell->text .= $this->gradeserror[$item->id][$userid];
980                 }
982                 $itemrow->cells[] = $itemcell;
983             }
984             $rows[] = $itemrow;
985         }
987         if ($this->get_pref('enableajax')) {
988             $jsarguments['cfg']['ajaxenabled'] = true;
989             $jsarguments['cfg']['scales'] = array();
990             foreach ($jsscales as $scale) {
991                 $jsarguments['cfg']['scales'][$scale->id] = explode(',',$scale->scale);
992             }
993             $jsarguments['cfg']['feedbacktrunclength'] =  $this->feedback_trunc_length;
995             //feedbacks are now being stored in $jsarguments['feedback'] in get_right_rows()
996             //$jsarguments['cfg']['feedback'] =  $this->feedbacks;
997         }
998         $jsarguments['cfg']['isediting'] = (bool)$USER->gradeediting[$this->courseid];
999         $jsarguments['cfg']['courseid'] =  $this->courseid;
1000         $jsarguments['cfg']['studentsperpage'] =  $this->get_pref('studentsperpage');
1001         $jsarguments['cfg']['showquickfeedback'] =  (bool)$this->get_pref('showquickfeedback');
1003         $module = array(
1004             'name'      => 'gradereport_grader',
1005             'fullpath'  => '/grade/report/grader/module.js',
1006             'requires'  => array('base', 'dom', 'event', 'event-mouseenter', 'event-key', 'io', 'json-parse', 'overlay')
1007         );
1008         $PAGE->requires->js_init_call('M.gradereport_grader.init_report', $jsarguments, false, $module);
1009         $PAGE->requires->strings_for_js(array('addfeedback','feedback', 'grade'), 'grades');
1010         $PAGE->requires->strings_for_js(array('ajaxchoosescale','ajaxclicktoclose','ajaxerror','ajaxfailedupdate', 'ajaxfieldchanged'), 'gradereport_grader');
1012         $rows = $this->get_right_range_row($rows);
1013         $rows = $this->get_right_avg_row($rows, true);
1014         $rows = $this->get_right_avg_row($rows);
1016         return $rows;
1017     }
1019     /**
1020      * Depending on the style of report (fixedstudents vs traditional one-table),
1021      * arranges the rows of data in one or two tables, and returns the output of
1022      * these tables in HTML
1023      * @return string HTML
1024      */
1025     public function get_grade_table() {
1026         global $OUTPUT;
1027         $fixedstudents = $this->is_fixed_students();
1029         $leftrows = $this->get_left_rows();
1030         $rightrows = $this->get_right_rows();
1032         $html = '';
1035         if ($fixedstudents) {
1036             $fixedcolumntable = new html_table();
1037             $fixedcolumntable->id = 'fixed_column';
1038             $fixedcolumntable->data = $leftrows;
1039             $html .= $OUTPUT->container(html_writer::table($fixedcolumntable), 'left_scroller');
1041             $righttable = new html_table();
1042             $righttable->id = 'user-grades';
1043             $righttable->data = $rightrows;
1045             $html .= $OUTPUT->container(html_writer::table($righttable), 'right_scroller');
1046         } else {
1047             $fulltable = new html_table();
1048             $fulltable->attributes['class'] = 'gradestable flexible boxaligncenter generaltable';
1049             $fulltable->id = 'user-grades';
1051             // Extract rows from each side (left and right) and collate them into one row each
1052             foreach ($leftrows as $key => $row) {
1053                 $row->cells = array_merge($row->cells, $rightrows[$key]->cells);
1054                 $fulltable->data[] = $row;
1055             }
1056             $html .= html_writer::table($fulltable);
1057         }
1058         return $OUTPUT->container($html, 'gradeparent');
1059     }
1061     /**
1062      * Builds and return the row of icons for the left side of the report.
1063      * It only has one cell that says "Controls"
1064      * @param array $rows The Array of rows for the left part of the report
1065      * @param int $colspan The number of columns this cell has to span
1066      * @return array Array of rows for the left part of the report
1067      */
1068     public function get_left_icons_row($rows=array(), $colspan=1) {
1069         global $USER;
1071         if ($USER->gradeediting[$this->courseid]) {
1072             $controlsrow = new html_table_row();
1073             $controlsrow->attributes['class'] = 'controls';
1074             $controlscell = new html_table_cell();
1075             $controlscell->attributes['class'] = 'header controls';
1076             $controlscell->colspan = $colspan;
1077             $controlscell->text = $this->get_lang_string('controls','grades');
1079             $controlsrow->cells[] = $controlscell;
1080             $rows[] = $controlsrow;
1081         }
1082         return $rows;
1083     }
1085     /**
1086      * Builds and return the header for the row of ranges, for the left part of the grader report.
1087      * @param array $rows The Array of rows for the left part of the report
1088      * @param int $colspan The number of columns this cell has to span
1089      * @return array Array of rows for the left part of the report
1090      */
1091     public function get_left_range_row($rows=array(), $colspan=1) {
1092         global $CFG, $USER;
1094         if ($this->get_pref('showranges')) {
1095             $rangerow = new html_table_row();
1096             $rangerow->attributes['class'] = 'range r'.$this->rowcount++;
1097             $rangecell = new html_table_cell();
1098             $rangecell->attributes['class'] = 'header range';
1099             $rangecell->colspan = $colspan;
1100             $rangecell->header = true;
1101             $rangecell->scope = 'row';
1102             $rangecell->text = $this->get_lang_string('range','grades');
1103             $rangerow->cells[] = $rangecell;
1104             $rows[] = $rangerow;
1105         }
1107         return $rows;
1108     }
1110     /**
1111      * Builds and return the headers for the rows of averages, for the left part of the grader report.
1112      * @param array $rows The Array of rows for the left part of the report
1113      * @param int $colspan The number of columns this cell has to span
1114      * @param bool $groupavg If true, returns the row for group averages, otherwise for overall averages
1115      * @return array Array of rows for the left part of the report
1116      */
1117     public function get_left_avg_row($rows=array(), $colspan=1, $groupavg=false) {
1118         if (!$this->canviewhidden) {
1119             // totals might be affected by hiding, if user can not see hidden grades the aggregations might be altered
1120             // better not show them at all if user can not see all hideen grades
1121             return $rows;
1122         }
1124         $showaverages = $this->get_pref('showaverages');
1125         $showaveragesgroup = $this->currentgroup && $showaverages;
1126         $straveragegroup = get_string('groupavg', 'grades');
1128         if ($groupavg) {
1129             if ($showaveragesgroup) {
1130                 $groupavgrow = new html_table_row();
1131                 $groupavgrow->attributes['class'] = 'groupavg r'.$this->rowcount++;
1132                 $groupavgcell = new html_table_cell();
1133                 $groupavgcell->attributes['class'] = 'header range';
1134                 $groupavgcell->colspan = $colspan;
1135                 $groupavgcell->header = true;
1136                 $groupavgcell->scope = 'row';
1137                 $groupavgcell->text = $straveragegroup;
1138                 $groupavgrow->cells[] = $groupavgcell;
1139                 $rows[] = $groupavgrow;
1140             }
1141         } else {
1142             $straverage = get_string('overallaverage', 'grades');
1144             if ($showaverages) {
1145                 $avgrow = new html_table_row();
1146                 $avgrow->attributes['class'] = 'avg r'.$this->rowcount++;
1147                 $avgcell = new html_table_cell();
1148                 $avgcell->attributes['class'] = 'header range';
1149                 $avgcell->colspan = $colspan;
1150                 $avgcell->header = true;
1151                 $avgcell->scope = 'row';
1152                 $avgcell->text = $straverage;
1153                 $avgrow->cells[] = $avgcell;
1154                 $rows[] = $avgrow;
1155             }
1156         }
1158         return $rows;
1159     }
1161     /**
1162      * Builds and return the row of icons when editing is on, for the right part of the grader report.
1163      * @param array $rows The Array of rows for the right part of the report
1164      * @return array Array of rows for the right part of the report
1165      */
1166     public function get_right_icons_row($rows=array()) {
1167         global $USER;
1168         if ($USER->gradeediting[$this->courseid]) {
1169             $iconsrow = new html_table_row();
1170             $iconsrow->attributes['class'] = 'controls';
1172             $showuseridnumber = $this->get_pref('showuseridnumber');
1174             foreach ($this->gtree->items as $itemid=>$unused) {
1175                 // emulate grade element
1176                 $item =& $this->gtree->get_item($itemid);
1178                 $eid = $this->gtree->get_item_eid($item);
1179                 $element = $this->gtree->locate_element($eid);
1180                 $itemcell = new html_table_cell();
1181                 $itemcell->attributes['class'] = 'controls icons';
1182                 $itemcell->text = $this->get_icons($element);
1183                 $iconsrow->cells[] = $itemcell;
1184             }
1185             $rows[] = $iconsrow;
1186         }
1187         return $rows;
1188     }
1190     /**
1191      * Builds and return the row of ranges for the right part of the grader report.
1192      * @param array $rows The Array of rows for the right part of the report
1193      * @return array Array of rows for the right part of the report
1194      */
1195     public function get_right_range_row($rows=array()) {
1196         global $OUTPUT;
1198         if ($this->get_pref('showranges')) {
1199             $rangesdisplaytype   = $this->get_pref('rangesdisplaytype');
1200             $rangesdecimalpoints = $this->get_pref('rangesdecimalpoints');
1201             $rangerow = new html_table_row();
1202             $rangerow->attributes['class'] = 'heading range';
1204             foreach ($this->gtree->items as $itemid=>$unused) {
1205                 $item =& $this->gtree->items[$itemid];
1206                 $itemcell = new html_table_cell();
1207                 $itemcell->header = true;
1208                 $itemcell->attributes['class'] .= ' header range';
1210                 $hidden = '';
1211                 if ($item->is_hidden()) {
1212                     $hidden = ' hidden ';
1213                 }
1215                 $formattedrange = $item->get_formatted_range($rangesdisplaytype, $rangesdecimalpoints);
1217                 $itemcell->text = $OUTPUT->container($formattedrange, 'rangevalues'.$hidden);
1218                 $rangerow->cells[] = $itemcell;
1219             }
1220             $rows[] = $rangerow;
1221         }
1222         return $rows;
1223     }
1225     /**
1226      * Builds and return the row of averages for the right part of the grader report.
1227      * @param array $rows Whether to return only group averages or all averages.
1228      * @param bool $grouponly Whether to return only group averages or all averages.
1229      * @return array Array of rows for the right part of the report
1230      */
1231     public function get_right_avg_row($rows=array(), $grouponly=false) {
1232         global $CFG, $USER, $DB, $OUTPUT;
1234         if (!$this->canviewhidden) {
1235             // totals might be affected by hiding, if user can not see hidden grades the aggregations might be altered
1236             // better not show them at all if user can not see all hideen grades
1237             return $rows;
1238         }
1240         $showaverages = $this->get_pref('showaverages');
1241         $showaveragesgroup = $this->currentgroup && $showaverages;
1243         $averagesdisplaytype   = $this->get_pref('averagesdisplaytype');
1244         $averagesdecimalpoints = $this->get_pref('averagesdecimalpoints');
1245         $meanselection         = $this->get_pref('meanselection');
1246         $shownumberofgrades    = $this->get_pref('shownumberofgrades');
1248         $avghtml = '';
1249         $avgcssclass = 'avg';
1251         if ($grouponly) {
1252             $straverage = get_string('groupavg', 'grades');
1253             $showaverages = $this->currentgroup && $this->get_pref('showaverages');
1254             $groupsql = $this->groupsql;
1255             $groupwheresql = $this->groupwheresql;
1256             $groupwheresqlparams = $this->groupwheresql_params;
1257             $avgcssclass = 'groupavg';
1258         } else {
1259             $straverage = get_string('overallaverage', 'grades');
1260             $showaverages = $this->get_pref('showaverages');
1261             $groupsql = "";
1262             $groupwheresql = "";
1263             $groupwheresqlparams = array();
1264         }
1266         if ($shownumberofgrades) {
1267             $straverage .= ' (' . get_string('submissions', 'grades') . ') ';
1268         }
1270         $totalcount = $this->get_numusers($grouponly);
1272         list($usql, $rolesparams) = $DB->get_in_or_equal(explode(',', $this->gradebookroles), SQL_PARAMS_NAMED, 'grbr0');
1274         if ($showaverages) {
1275             $params = array_merge(array('courseid'=>$this->courseid), $rolesparams, $groupwheresqlparams);
1277             // find sums of all grade items in course
1278             $SQL = "SELECT g.itemid, SUM(g.finalgrade) AS sum
1279                       FROM {grade_items} gi
1280                            JOIN {grade_grades} g      ON g.itemid = gi.id
1281                            JOIN {user} u              ON u.id = g.userid
1282                            JOIN {role_assignments} ra ON ra.userid = u.id
1283                            $groupsql
1284                      WHERE gi.courseid = :courseid
1285                            AND ra.roleid $usql
1286                            AND ra.contextid ".get_related_contexts_string($this->context)."
1287                            AND g.finalgrade IS NOT NULL
1288                            $groupwheresql
1289                   GROUP BY g.itemid";
1290             $sumarray = array();
1291             if ($sums = $DB->get_records_sql($SQL, $params)) {
1292                 foreach ($sums as $itemid => $csum) {
1293                     $sumarray[$itemid] = $csum->sum;
1294                 }
1295             }
1297             // MDL-10875 Empty grades must be evaluated as grademin, NOT always 0
1298             // This query returns a count of ungraded grades (NULL finalgrade OR no matching record in grade_grades table)
1299             $params = array_merge(array('courseid'=>$this->courseid), $rolesparams, $groupwheresqlparams);
1300             $SQL = "SELECT gi.id, COUNT(u.id) AS count
1301                       FROM {grade_items} gi
1302                            CROSS JOIN {user} u
1303                            JOIN {role_assignments} ra        ON ra.userid = u.id
1304                            LEFT OUTER JOIN  {grade_grades} g ON (g.itemid = gi.id AND g.userid = u.id AND g.finalgrade IS NOT NULL)
1305                            $groupsql
1306                      WHERE gi.courseid = :courseid
1307                            AND ra.roleid $usql
1308                            AND ra.contextid ".get_related_contexts_string($this->context)."
1309                            AND g.id IS NULL
1310                            $groupwheresql
1311                   GROUP BY gi.id";
1313             $ungradedcounts = $DB->get_records_sql($SQL, $params);
1315             $avgrow = new html_table_row();
1316             $avgrow->attributes['class'] = 'avg';
1318             foreach ($this->gtree->items as $itemid=>$unused) {
1319                 $item =& $this->gtree->items[$itemid];
1321                 if ($item->needsupdate) {
1322                     $avgcell = new html_table_cell();
1323                     $avgcell->text = $OUTPUT->container(get_string('error'), 'gradingerror');
1324                     $avgrow->cells[] = $avgcell;
1325                     continue;
1326                 }
1328                 if (!isset($sumarray[$item->id])) {
1329                     $sumarray[$item->id] = 0;
1330                 }
1332                 if (empty($ungradedcounts[$itemid])) {
1333                     $ungradedcount = 0;
1334                 } else {
1335                     $ungradedcount = $ungradedcounts[$itemid]->count;
1336                 }
1338                 if ($meanselection == GRADE_REPORT_MEAN_GRADED) {
1339                     $meancount = $totalcount - $ungradedcount;
1340                 } else { // Bump up the sum by the number of ungraded items * grademin
1341                     $sumarray[$item->id] += $ungradedcount * $item->grademin;
1342                     $meancount = $totalcount;
1343                 }
1345                 $decimalpoints = $item->get_decimals();
1347                 // Determine which display type to use for this average
1348                 if ($USER->gradeediting[$this->courseid]) {
1349                     $displaytype = GRADE_DISPLAY_TYPE_REAL;
1351                 } else if ($averagesdisplaytype == GRADE_REPORT_PREFERENCE_INHERIT) { // no ==0 here, please resave the report and user preferences
1352                     $displaytype = $item->get_displaytype();
1354                 } else {
1355                     $displaytype = $averagesdisplaytype;
1356                 }
1358                 // Override grade_item setting if a display preference (not inherit) was set for the averages
1359                 if ($averagesdecimalpoints == GRADE_REPORT_PREFERENCE_INHERIT) {
1360                     $decimalpoints = $item->get_decimals();
1362                 } else {
1363                     $decimalpoints = $averagesdecimalpoints;
1364                 }
1366                 if (!isset($sumarray[$item->id]) || $meancount == 0) {
1367                     $avgcell = new html_table_cell();
1368                     $avgcell->text = '-';
1369                     $avgrow->cells[] = $avgcell;
1371                 } else {
1372                     $sum = $sumarray[$item->id];
1373                     $avgradeval = $sum/$meancount;
1374                     $gradehtml = grade_format_gradevalue($avgradeval, $item, true, $displaytype, $decimalpoints);
1376                     $numberofgrades = '';
1377                     if ($shownumberofgrades) {
1378                         $numberofgrades = " ($meancount)";
1379                     }
1381                     $avgcell = new html_table_cell();
1382                     $avgcell->text = $gradehtml.$numberofgrades;
1383                     $avgrow->cells[] = $avgcell;
1384                 }
1385             }
1386             $rows[] = $avgrow;
1387         }
1388         return $rows;
1389     }
1391     /**
1392      * Given a grade_category, grade_item or grade_grade, this function
1393      * figures out the state of the object and builds then returns a div
1394      * with the icons needed for the grader report.
1395      *
1396      * @param object $object
1397      * @return string HTML
1398      */
1399     protected function get_icons($element) {
1400         global $CFG, $USER, $OUTPUT;
1402         if (!$USER->gradeediting[$this->courseid]) {
1403             return '<div class="grade_icons" />';
1404         }
1406         // Init all icons
1407         $editicon = '';
1409         if ($element['type'] != 'categoryitem' && $element['type'] != 'courseitem') {
1410             $editicon = $this->gtree->get_edit_icon($element, $this->gpr);
1411         }
1413         $editcalculationicon = '';
1414         $showhideicon        = '';
1415         $lockunlockicon      = '';
1417         if (has_capability('moodle/grade:manage', $this->context)) {
1419             if ($this->get_pref('showcalculations')) {
1420                 $editcalculationicon = $this->gtree->get_calculation_icon($element, $this->gpr);
1421             }
1423             if ($this->get_pref('showeyecons')) {
1424                $showhideicon = $this->gtree->get_hiding_icon($element, $this->gpr);
1425             }
1427             if ($this->get_pref('showlocks')) {
1428                 $lockunlockicon = $this->gtree->get_locking_icon($element, $this->gpr);
1429             }
1430         }
1432         return $OUTPUT->container($editicon.$editcalculationicon.$showhideicon.$lockunlockicon, 'grade_icons');
1433     }
1435     /**
1436      * Given a category element returns collapsing +/- icon if available
1437      * @param object $object
1438      * @return string HTML
1439      */
1440     protected function get_collapsing_icon($element) {
1441         global $OUTPUT;
1443         $icon = '';
1444         // If object is a category, display expand/contract icon
1445         if ($element['type'] == 'category') {
1446             // Load language strings
1447             $strswitchminus = $this->get_lang_string('aggregatesonly', 'grades');
1448             $strswitchplus  = $this->get_lang_string('gradesonly', 'grades');
1449             $strswitchwhole = $this->get_lang_string('fullmode', 'grades');
1451             $url = new moodle_url($this->gpr->get_return_url(null, array('target'=>$element['eid'], 'sesskey'=>sesskey())));
1453             if (in_array($element['object']->id, $this->collapsed['aggregatesonly'])) {
1454                 $url->param('action', 'switch_plus');
1455                 $icon = $OUTPUT->action_icon($url, new pix_icon('t/switch_plus', $strswitchplus));
1457             } else if (in_array($element['object']->id, $this->collapsed['gradesonly'])) {
1458                 $url->param('action', 'switch_whole');
1459                 $icon = $OUTPUT->action_icon($url, new pix_icon('t/switch_whole', $strswitchwhole));
1460                 $contractexpandicon->image->src = $OUTPUT->pix_url('t/switch_whole');
1462             } else {
1463                 $url->param('action', 'switch_minus');
1464                 $icon = $OUTPUT->action_icon($url, new pix_icon('t/switch_minus', $strswitchminus));
1465             }
1466         }
1467         return $icon;
1468     }
1470     /**
1471      * Processes a single action against a category, grade_item or grade.
1472      * @param string $target eid ({type}{id}, e.g. c4 for category4)
1473      * @param string $action Which action to take (edit, delete etc...)
1474      * @return
1475      */
1476     public function process_action($target, $action) {
1477         // TODO: this code should be in some grade_tree static method
1478         $targettype = substr($target, 0, 1);
1479         $targetid = substr($target, 1);
1480         // TODO: end
1482         if ($collapsed = get_user_preferences('grade_report_grader_collapsed_categories')) {
1483             $collapsed = unserialize($collapsed);
1484         } else {
1485             $collapsed = array('aggregatesonly' => array(), 'gradesonly' => array());
1486         }
1488         switch ($action) {
1489             case 'switch_minus': // Add category to array of aggregatesonly
1490                 if (!in_array($targetid, $collapsed['aggregatesonly'])) {
1491                     $collapsed['aggregatesonly'][] = $targetid;
1492                     set_user_preference('grade_report_grader_collapsed_categories', serialize($collapsed));
1493                 }
1494                 break;
1496             case 'switch_plus': // Remove category from array of aggregatesonly, and add it to array of gradesonly
1497                 $key = array_search($targetid, $collapsed['aggregatesonly']);
1498                 if ($key !== false) {
1499                     unset($collapsed['aggregatesonly'][$key]);
1500                 }
1501                 if (!in_array($targetid, $collapsed['gradesonly'])) {
1502                     $collapsed['gradesonly'][] = $targetid;
1503                 }
1504                 set_user_preference('grade_report_grader_collapsed_categories', serialize($collapsed));
1505                 break;
1506             case 'switch_whole': // Remove the category from the array of collapsed cats
1507                 $key = array_search($targetid, $collapsed['gradesonly']);
1508                 if ($key !== false) {
1509                     unset($collapsed['gradesonly'][$key]);
1510                     set_user_preference('grade_report_grader_collapsed_categories', serialize($collapsed));
1511                 }
1513                 break;
1514             default:
1515                 break;
1516         }
1518         return true;
1519     }
1521     /**
1522      * Returns whether or not to display fixed students column.
1523      * Includes a browser check, because IE6 doesn't support the scrollbar.
1524      *
1525      * @return bool
1526      */
1527     public function is_fixed_students() {
1528         global $USER, $CFG;
1529         return empty($USER->screenreader) && $CFG->grade_report_fixedstudents &&
1530             (check_browser_version('MSIE', '7.0') ||
1531              check_browser_version('Firefox', '2.0') ||
1532              check_browser_version('Gecko', '2006010100') ||
1533              check_browser_version('Camino', '1.0') ||
1534              check_browser_version('Opera', '6.0') ||
1535              check_browser_version('Safari', '2.0'));
1536     }
1538     /**
1539      * Refactored function for generating HTML of sorting links with matching arrows.
1540      * Returns an array with 'studentname' and 'idnumber' as keys, with HTML ready
1541      * to inject into a table header cell.
1542      * @return array An associative array of HTML sorting links+arrows
1543      */
1544     public function get_sort_arrows() {
1545         global $OUTPUT;
1546         $arrows = array();
1548         $strsortasc   = $this->get_lang_string('sortasc', 'grades');
1549         $strsortdesc  = $this->get_lang_string('sortdesc', 'grades');
1550         $strfirstname = $this->get_lang_string('firstname');
1551         $strlastname  = $this->get_lang_string('lastname');
1553         $firstlink = html_writer::link(new moodle_url($this->baseurl, array('sortitemid'=>'firstname')), $strfirstname);
1554         $lastlink = html_writer::link(new moodle_url($this->baseurl, array('sortitemid'=>'lastname')), $strlastname);
1555         $idnumberlink = html_writer::link(new moodle_url($this->baseurl, array('sortitemid'=>'idnumber')), get_string('idnumber'));
1557         $arrows['studentname'] = $lastlink;
1559         if ($this->sortitemid === 'lastname') {
1560             if ($this->sortorder == 'ASC') {
1561                 $arrows['studentname'] .= print_arrow('up', $strsortasc, true);
1562             } else {
1563                 $arrows['studentname'] .= print_arrow('down', $strsortdesc, true);
1564             }
1565         }
1567         $arrows['studentname'] .= ' ' . $firstlink;
1569         if ($this->sortitemid === 'firstname') {
1570             if ($this->sortorder == 'ASC') {
1571                 $arrows['studentname'] .= print_arrow('up', $strsortasc, true);
1572             } else {
1573                 $arrows['studentname'] .= print_arrow('down', $strsortdesc, true);
1574             }
1575         }
1577         $arrows['idnumber'] = $idnumberlink;
1579         if ('idnumber' == $this->sortitemid) {
1580             if ($this->sortorder == 'ASC') {
1581                 $arrows['idnumber'] .= print_arrow('up', $strsortasc, true);
1582             } else {
1583                 $arrows['idnumber'] .= print_arrow('down', $strsortdesc, true);
1584             }
1585         }
1587         return $arrows;
1588     }