MDL-30819 grade: fixed column highlighting on the grader report
[moodle.git] / grade / report / grader / lib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Definition of the grader report class
19  *
20  * @package   gradereport_grader
21  * @copyright 2007 Nicolas Connault
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 require_once($CFG->dirroot . '/grade/report/lib.php');
26 require_once($CFG->libdir.'/tablelib.php');
28 /**
29  * Class providing an API for the grader report building and displaying.
30  * @uses grade_report
31  * @package gradereport_grader
32  */
33 class grade_report_grader extends grade_report {
34     /**
35      * The final grades.
36      * @var array $grades
37      */
38     public $grades;
40     /**
41      * Array of errors for bulk grades updating.
42      * @var array $gradeserror
43      */
44     public $gradeserror = array();
46 //// SQL-RELATED
48     /**
49      * The id of the grade_item by which this report will be sorted.
50      * @var int $sortitemid
51      */
52     public $sortitemid;
54     /**
55      * Sortorder used in the SQL selections.
56      * @var int $sortorder
57      */
58     public $sortorder;
60     /**
61      * An SQL fragment affecting the search for users.
62      * @var string $userselect
63      */
64     public $userselect;
66     /**
67      * The bound params for $userselect
68      * @var array $userselectparams
69      */
70     public $userselectparams = array();
72     /**
73      * List of collapsed categories from user preference
74      * @var array $collapsed
75      */
76     public $collapsed;
78     /**
79      * A count of the rows, used for css classes.
80      * @var int $rowcount
81      */
82     public $rowcount = 0;
84     /**
85      * Capability check caching
86      * */
87     public $canviewhidden;
89     var $preferencespage=false;
91     /**
92      * Length at which feedback will be truncated (to the nearest word) and an ellipsis be added.
93      * TODO replace this by a report preference
94      * @var int $feedback_trunc_length
95      */
96     protected $feedback_trunc_length = 50;
98     /**
99      * Constructor. Sets local copies of user preferences and initialises grade_tree.
100      * @param int $courseid
101      * @param object $gpr grade plugin return tracking object
102      * @param string $context
103      * @param int $page The current page being viewed (when report is paged)
104      * @param int $sortitemid The id of the grade_item by which to sort the table
105      */
106     public function __construct($courseid, $gpr, $context, $page=null, $sortitemid=null) {
107         global $CFG;
108         parent::__construct($courseid, $gpr, $context, $page);
110         $this->canviewhidden = has_capability('moodle/grade:viewhidden', get_context_instance(CONTEXT_COURSE, $this->course->id));
112         // load collapsed settings for this report
113         if ($collapsed = get_user_preferences('grade_report_grader_collapsed_categories')) {
114             $this->collapsed = unserialize($collapsed);
115         } else {
116             $this->collapsed = array('aggregatesonly' => array(), 'gradesonly' => array());
117         }
119         if (empty($CFG->enableoutcomes)) {
120             $nooutcomes = false;
121         } else {
122             $nooutcomes = get_user_preferences('grade_report_shownooutcomes');
123         }
125         // if user report preference set or site report setting set use it, otherwise use course or site setting
126         $switch = $this->get_pref('aggregationposition');
127         if ($switch == '') {
128             $switch = grade_get_setting($this->courseid, 'aggregationposition', $CFG->grade_aggregationposition);
129         }
131         // Grab the grade_tree for this course
132         $this->gtree = new grade_tree($this->courseid, true, $switch, $this->collapsed, $nooutcomes);
134         $this->sortitemid = $sortitemid;
136         // base url for sorting by first/last name
138         $this->baseurl = new moodle_url('index.php', array('id' => $this->courseid));
140         if (!empty($this->page)) {
141             $this->baseurl->params(array('page' => $this->page));
142         }
144         $this->pbarurl = new moodle_url('/grade/report/grader/index.php', array('id' => $this->courseid));
146         $this->setup_groups();
148         $this->setup_sortitemid();
149     }
151     /**
152      * Processes the data sent by the form (grades and feedbacks).
153      * Caller is responsible for all access control checks
154      * @param array $data form submission (with magic quotes)
155      * @return array empty array if success, array of warnings if something fails.
156      */
157     public function process_data($data) {
158         global $DB;
159         $warnings = array();
161         $separategroups = false;
162         $mygroups       = array();
163         if ($this->groupmode == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $this->context)) {
164             $separategroups = true;
165             $mygroups = groups_get_user_groups($this->course->id);
166             $mygroups = $mygroups[0]; // ignore groupings
167             // reorder the groups fro better perf below
168             $current = array_search($this->currentgroup, $mygroups);
169             if ($current !== false) {
170                 unset($mygroups[$current]);
171                 array_unshift($mygroups, $this->currentgroup);
172             }
173         }
175         // always initialize all arrays
176         $queue = array();
177         foreach ($data as $varname => $postedvalue) {
179             $needsupdate = false;
181             // skip, not a grade nor feedback
182             if (strpos($varname, 'grade') === 0) {
183                 $datatype = 'grade';
184             } else if (strpos($varname, 'feedback') === 0) {
185                 $datatype = 'feedback';
186             } else {
187                 continue;
188             }
190             $gradeinfo = explode("_", $varname);
191             $userid = clean_param($gradeinfo[1], PARAM_INT);
192             $itemid = clean_param($gradeinfo[2], PARAM_INT);
194             $oldvalue = $data->{'old'.$varname};
196             // was change requested?
197             if ($oldvalue == $postedvalue) { // string comparison
198                 continue;
199             }
201             if (!$gradeitem = grade_item::fetch(array('id'=>$itemid, 'courseid'=>$this->courseid))) { // we must verify course id here!
202                 print_error('invalidgradeitmeid');
203             }
205             // Pre-process grade
206             if ($datatype == 'grade') {
207                 $feedback = false;
208                 $feedbackformat = false;
209                 if ($gradeitem->gradetype == GRADE_TYPE_SCALE) {
210                     if ($postedvalue == -1) { // -1 means no grade
211                         $finalgrade = null;
212                     } else {
213                         $finalgrade = $postedvalue;
214                     }
215                 } else {
216                     $finalgrade = unformat_float($postedvalue);
217                 }
219                 $errorstr = '';
220                 // Warn if the grade is out of bounds.
221                 if (is_null($finalgrade)) {
222                     // ok
223                 } else {
224                     $bounded = $gradeitem->bounded_grade($finalgrade);
225                     if ($bounded > $finalgrade) {
226                     $errorstr = 'lessthanmin';
227                     } else if ($bounded < $finalgrade) {
228                         $errorstr = 'morethanmax';
229                     }
230                 }
231                 if ($errorstr) {
232                     $user = $DB->get_record('user', array('id' => $userid), 'id, firstname, lastname');
233                     $gradestr = new stdClass();
234                     $gradestr->username = fullname($user);
235                     $gradestr->itemname = $gradeitem->get_name();
236                     $warnings[] = get_string($errorstr, 'grades', $gradestr);
237                 }
239             } else if ($datatype == 'feedback') {
240                 $finalgrade = false;
241                 $trimmed = trim($postedvalue);
242                 if (empty($trimmed)) {
243                      $feedback = NULL;
244                 } else {
245                      $feedback = $postedvalue;
246                 }
247             }
249             // group access control
250             if ($separategroups) {
251                 // note: we can not use $this->currentgroup because it would fail badly
252                 //       when having two browser windows each with different group
253                 $sharinggroup = false;
254                 foreach($mygroups as $groupid) {
255                     if (groups_is_member($groupid, $userid)) {
256                         $sharinggroup = true;
257                         break;
258                     }
259                 }
260                 if (!$sharinggroup) {
261                     // either group membership changed or somebody is hacking grades of other group
262                     $warnings[] = get_string('errorsavegrade', 'grades');
263                     continue;
264                 }
265             }
267             $gradeitem->update_final_grade($userid, $finalgrade, 'gradebook', $feedback, FORMAT_MOODLE);
268         }
270         return $warnings;
271     }
274     /**
275      * Setting the sort order, this depends on last state
276      * all this should be in the new table class that we might need to use
277      * for displaying grades.
278      */
279     private function setup_sortitemid() {
281         global $SESSION;
283         if (!isset($SESSION->gradeuserreport)) {
284             $SESSION->gradeuserreport = new stdClass();
285         }
287         if ($this->sortitemid) {
288             if (!isset($SESSION->gradeuserreport->sort)) {
289                 if ($this->sortitemid == 'firstname' || $this->sortitemid == 'lastname') {
290                     $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC';
291                 } else {
292                     $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC';
293                 }
294             } else {
295                 // this is the first sort, i.e. by last name
296                 if (!isset($SESSION->gradeuserreport->sortitemid)) {
297                     if ($this->sortitemid == 'firstname' || $this->sortitemid == 'lastname') {
298                         $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC';
299                     } else {
300                         $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC';
301                     }
302                 } else if ($SESSION->gradeuserreport->sortitemid == $this->sortitemid) {
303                     // same as last sort
304                     if ($SESSION->gradeuserreport->sort == 'ASC') {
305                         $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC';
306                     } else {
307                         $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC';
308                     }
309                 } else {
310                     if ($this->sortitemid == 'firstname' || $this->sortitemid == 'lastname') {
311                         $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC';
312                     } else {
313                         $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC';
314                     }
315                 }
316             }
317             $SESSION->gradeuserreport->sortitemid = $this->sortitemid;
318         } else {
319             // not requesting sort, use last setting (for paging)
321             if (isset($SESSION->gradeuserreport->sortitemid)) {
322                 $this->sortitemid = $SESSION->gradeuserreport->sortitemid;
323             }else{
324                 $this->sortitemid = 'lastname';
325             }
327             if (isset($SESSION->gradeuserreport->sort)) {
328                 $this->sortorder = $SESSION->gradeuserreport->sort;
329             } else {
330                 $this->sortorder = 'ASC';
331             }
332         }
333     }
335     /**
336      * pulls out the userids of the users to be display, and sorts them
337      */
338     public function load_users() {
339         global $CFG, $DB;
341         //limit to users with a gradeable role
342         list($gradebookrolessql, $gradebookrolesparams) = $DB->get_in_or_equal(explode(',', $this->gradebookroles), SQL_PARAMS_NAMED, 'grbr0');
344         //limit to users with an active enrollment
345         list($enrolledsql, $enrolledparams) = get_enrolled_sql($this->context);
347         //fields we need from the user table
348         $userfields = user_picture::fields('u');
349         $userfields .= get_extra_user_fields_sql($this->context);
351         $sortjoin = $sort = $params = null;
353         //if the user has clicked one of the sort asc/desc arrows
354         if (is_numeric($this->sortitemid)) {
355             $params = array_merge(array('gitemid'=>$this->sortitemid), $gradebookrolesparams, $this->groupwheresql_params, $enrolledparams);
357             $sortjoin = "LEFT JOIN {grade_grades} g ON g.userid = u.id AND g.itemid = $this->sortitemid";
358             $sort = "g.finalgrade $this->sortorder";
360         } else {
361             $sortjoin = '';
362             switch($this->sortitemid) {
363                 case 'lastname':
364                     $sort = "u.lastname $this->sortorder, u.firstname $this->sortorder";
365                     break;
366                 case 'firstname':
367                     $sort = "u.firstname $this->sortorder, u.lastname $this->sortorder";
368                     break;
369                 case 'idnumber':
370                 default:
371                     $sort = "u.idnumber $this->sortorder";
372                     break;
373             }
375             $params = array_merge($gradebookrolesparams, $this->groupwheresql_params, $enrolledparams);
376         }
378         $sql = "SELECT $userfields
379                   FROM {user} u
380                   JOIN ($enrolledsql) je ON je.id = u.id
381                        $this->groupsql
382                        $sortjoin
383                   JOIN (
384                            SELECT DISTINCT ra.userid
385                              FROM {role_assignments} ra
386                             WHERE ra.roleid IN ($this->gradebookroles)
387                               AND ra.contextid " . get_related_contexts_string($this->context) . "
388                        ) rainner ON rainner.userid = u.id
389                    AND u.deleted = 0
390                    $this->groupwheresql
391               ORDER BY $sort";
393         $this->users = $DB->get_records_sql($sql, $params, $this->get_pref('studentsperpage') * $this->page, $this->get_pref('studentsperpage'));
395         if (empty($this->users)) {
396             $this->userselect = '';
397             $this->users = array();
398             $this->userselect_params = array();
399         } else {
400             list($usql, $uparams) = $DB->get_in_or_equal(array_keys($this->users), SQL_PARAMS_NAMED, 'usid0');
401             $this->userselect = "AND g.userid $usql";
402             $this->userselect_params = $uparams;
404             //add a flag to each user indicating whether their enrolment is active
405             $sql = "SELECT ue.userid
406                       FROM {user_enrolments} ue
407                       JOIN {enrol} e ON e.id = ue.enrolid
408                      WHERE ue.userid $usql
409                            AND ue.status = :uestatus
410                            AND e.status = :estatus
411                            AND e.courseid = :courseid
412                   GROUP BY ue.userid";
413             $coursecontext = get_course_context($this->context);
414             $params = array_merge($uparams, array('estatus'=>ENROL_INSTANCE_ENABLED, 'uestatus'=>ENROL_USER_ACTIVE, 'courseid'=>$coursecontext->instanceid));
415             $useractiveenrolments = $DB->get_records_sql($sql, $params);
417             foreach ($this->users as $user) {
418                 $this->users[$user->id]->suspendedenrolment = !array_key_exists($user->id, $useractiveenrolments);
419             }
420         }
422         return $this->users;
423     }
425     /**
426      * we supply the userids in this query, and get all the grades
427      * pulls out all the grades, this does not need to worry about paging
428      */
429     public function load_final_grades() {
430         global $CFG, $DB;
432         // please note that we must fetch all grade_grades fields if we want to construct grade_grade object from it!
433         $params = array_merge(array('courseid'=>$this->courseid), $this->userselect_params);
434         $sql = "SELECT g.*
435                   FROM {grade_items} gi,
436                        {grade_grades} g
437                  WHERE g.itemid = gi.id AND gi.courseid = :courseid {$this->userselect}";
439         $userids = array_keys($this->users);
442         if ($grades = $DB->get_records_sql($sql, $params)) {
443             foreach ($grades as $graderec) {
444                 if (in_array($graderec->userid, $userids) and array_key_exists($graderec->itemid, $this->gtree->get_items())) { // some items may not be present!!
445                     $this->grades[$graderec->userid][$graderec->itemid] = new grade_grade($graderec, false);
446                     $this->grades[$graderec->userid][$graderec->itemid]->grade_item = $this->gtree->get_item($graderec->itemid); // db caching
447                 }
448             }
449         }
451         // prefil grades that do not exist yet
452         foreach ($userids as $userid) {
453             foreach ($this->gtree->get_items() as $itemid=>$unused) {
454                 if (!isset($this->grades[$userid][$itemid])) {
455                     $this->grades[$userid][$itemid] = new grade_grade();
456                     $this->grades[$userid][$itemid]->itemid = $itemid;
457                     $this->grades[$userid][$itemid]->userid = $userid;
458                     $this->grades[$userid][$itemid]->grade_item = $this->gtree->get_item($itemid); // db caching
459                 }
460             }
461         }
462     }
464     /**
465      * Builds and returns a div with on/off toggles.
466      * @return string HTML code
467      */
468     public function get_toggles_html() {
469         global $CFG, $USER, $COURSE, $OUTPUT;
471         $html = '';
472         if ($USER->gradeediting[$this->courseid]) {
473             if (has_capability('moodle/grade:manage', $this->context) or has_capability('moodle/grade:hide', $this->context)) {
474                 $html .= $this->print_toggle('eyecons');
475             }
476             if (has_capability('moodle/grade:manage', $this->context)
477              or has_capability('moodle/grade:lock', $this->context)
478              or has_capability('moodle/grade:unlock', $this->context)) {
479                 $html .= $this->print_toggle('locks');
480             }
481             if (has_capability('moodle/grade:manage', $this->context)) {
482                 $html .= $this->print_toggle('quickfeedback');
483             }
485             if (has_capability('moodle/grade:manage', $this->context)) {
486                 $html .= $this->print_toggle('calculations');
487             }
488         }
490         if ($this->canviewhidden) {
491             $html .= $this->print_toggle('averages');
492         }
494         $html .= $this->print_toggle('ranges');
495         if (!empty($CFG->enableoutcomes)) {
496             $html .= $this->print_toggle('nooutcomes');
497         }
499         return $OUTPUT->container($html, 'grade-report-toggles');
500     }
502     /**
503     * Shortcut function for printing the grader report toggles.
504     * @param string $type The type of toggle
505     * @param bool $return Whether to return the HTML string rather than printing it
506     * @return void
507     */
508     public function print_toggle($type) {
509         global $CFG, $OUTPUT;
511         $icons = array('eyecons' => 't/hide',
512                        'calculations' => 't/calc',
513                        'locks' => 't/lock',
514                        'averages' => 't/mean',
515                        'quickfeedback' => 't/feedback',
516                        'nooutcomes' => 't/outcomes');
518         $prefname = 'grade_report_show' . $type;
520         if (array_key_exists($prefname, $CFG)) {
521             $showpref = get_user_preferences($prefname, $CFG->$prefname);
522         } else {
523             $showpref = get_user_preferences($prefname);
524         }
526         $strshow = $this->get_lang_string('show' . $type, 'grades');
527         $strhide = $this->get_lang_string('hide' . $type, 'grades');
529         $showhide = 'show';
530         $toggleaction = 1;
532         if ($showpref) {
533             $showhide = 'hide';
534             $toggleaction = 0;
535         }
537         if (array_key_exists($type, $icons)) {
538             $imagename = $icons[$type];
539         } else {
540             $imagename = "t/$type";
541         }
543         $string = ${'str' . $showhide};
545         $url = new moodle_url($this->baseurl, array('toggle' => $toggleaction, 'toggle_type' => $type));
547         $retval = $OUTPUT->container($OUTPUT->action_icon($url, new pix_icon($imagename, $string))); // TODO: this container looks wrong here
549         return $retval;
550     }
552     /**
553      * Builds and returns the rows that will make up the left part of the grader report
554      * This consists of student names and icons, links to user reports and id numbers, as well
555      * as header cells for these columns. It also includes the fillers required for the
556      * categories displayed on the right side of the report.
557      * @return array Array of html_table_row objects
558      */
559     public function get_left_rows() {
560         global $CFG, $USER, $OUTPUT;
562         $rows = array();
564         $showuserimage = $this->get_pref('showuserimage');
565         $fixedstudents = $this->is_fixed_students();
567         $strfeedback  = $this->get_lang_string("feedback");
568         $strgrade     = $this->get_lang_string('grade');
570         $extrafields = get_extra_user_fields($this->context);
572         $arrows = $this->get_sort_arrows($extrafields);
574         $colspan = 1;
575         if (has_capability('gradereport/'.$CFG->grade_profilereport.':view', $this->context)) {
576             $colspan++;
577         }
578         $colspan += count($extrafields);
580         $levels = count($this->gtree->levels) - 1;
582         for ($i = 0; $i < $levels; $i++) {
583             $fillercell = new html_table_cell();
584             $fillercell->attributes['class'] = 'fixedcolumn cell topleft';
585             $fillercell->text = ' ';
586             $fillercell->colspan = $colspan;
587             $row = new html_table_row(array($fillercell));
588             $rows[] = $row;
589         }
591         $headerrow = new html_table_row();
592         $headerrow->attributes['class'] = 'heading';
594         $studentheader = new html_table_cell();
595         $studentheader->attributes['class'] = 'header';
596         $studentheader->scope = 'col';
597         $studentheader->header = true;
598         $studentheader->id = 'studentheader';
599         if (has_capability('gradereport/'.$CFG->grade_profilereport.':view', $this->context)) {
600             $studentheader->colspan = 2;
601         }
602         $studentheader->text = $arrows['studentname'];
604         $headerrow->cells[] = $studentheader;
606         foreach ($extrafields as $field) {
607             $fieldheader = new html_table_cell();
608             $fieldheader->attributes['class'] = 'header userfield user' . $field;
609             $fieldheader->scope = 'col';
610             $fieldheader->header = true;
611             $fieldheader->text = $arrows[$field];
613             $headerrow->cells[] = $fieldheader;
614         }
616         $rows[] = $headerrow;
618         $rows = $this->get_left_icons_row($rows, $colspan);
620         $rowclasses = array('even', 'odd');
622         $suspendedstring = null;
623         foreach ($this->users as $userid => $user) {
624             $userrow = new html_table_row();
625             $userrow->id = 'fixed_user_'.$userid;
626             $userrow->attributes['class'] = 'r'.$this->rowcount++.' '.$rowclasses[$this->rowcount % 2];
628             $usercell = new html_table_cell();
629             $usercell->attributes['class'] = 'user';
631             $usercell->header = true;
632             $usercell->scope = 'row';
634             if ($showuserimage) {
635                 $usercell->text = $OUTPUT->user_picture($user);
636             }
638             $usercell->text .= html_writer::link(new moodle_url('/user/view.php', array('id' => $user->id, 'course' => $this->course->id)), fullname($user));
640             if (!empty($user->suspendedenrolment)) {
641                 $usercell->attributes['class'] .= ' usersuspended';
643                 //may be lots of suspended users so only get the string once
644                 if (empty($suspendedstring)) {
645                     $suspendedstring = get_string('userenrolmentsuspended', 'grades');
646                 }
647                 $usercell->text .= html_writer::empty_tag('img', array('src'=>$OUTPUT->pix_url('i/enrolmentsuspended'), 'title'=>$suspendedstring, 'alt'=>$suspendedstring, 'class'=>'usersuspendedicon'));
648             }
650             $userrow->cells[] = $usercell;
652             if (has_capability('gradereport/'.$CFG->grade_profilereport.':view', $this->context)) {
653                 $userreportcell = new html_table_cell();
654                 $userreportcell->attributes['class'] = 'userreport';
655                 $userreportcell->header = true;
656                 $a = new stdClass();
657                 $a->user = fullname($user);
658                 $strgradesforuser = get_string('gradesforuser', 'grades', $a);
659                 $url = new moodle_url('/grade/report/'.$CFG->grade_profilereport.'/index.php', array('userid' => $user->id, 'id' => $this->course->id));
660                 $userreportcell->text = $OUTPUT->action_icon($url, new pix_icon('t/grades', $strgradesforuser));
661                 $userrow->cells[] = $userreportcell;
662             }
664             foreach ($extrafields as $field) {
665                 $fieldcell = new html_table_cell();
666                 $fieldcell->attributes['class'] = 'header userfield user' . $field;
667                 $fieldcell->header = true;
668                 $fieldcell->scope = 'row';
669                 $fieldcell->text = $user->{$field};
670                 $userrow->cells[] = $fieldcell;
671             }
673             $rows[] = $userrow;
674         }
676         $rows = $this->get_left_range_row($rows, $colspan);
677         $rows = $this->get_left_avg_row($rows, $colspan, true);
678         $rows = $this->get_left_avg_row($rows, $colspan);
680         return $rows;
681     }
683     /**
684      * Builds and returns the rows that will make up the right part of the grader report
685      * @return array Array of html_table_row objects
686      */
687     public function get_right_rows() {
688         global $CFG, $USER, $OUTPUT, $DB, $PAGE;
690         $rows = array();
691         $this->rowcount = 0;
692         $numrows = count($this->gtree->get_levels());
693         $numusers = count($this->users);
694         $gradetabindex = 1;
695         $columnstounset = array();
696         $strgrade = $this->get_lang_string('grade');
697         $strfeedback  = $this->get_lang_string("feedback");
698         $arrows = $this->get_sort_arrows();
700         $jsarguments = array(
701             'id'        => '#fixed_column',
702             'cfg'       => array('ajaxenabled'=>false),
703             'items'     => array(),
704             'users'     => array(),
705             'feedback'  => array()
706         );
707         $jsscales = array();
709         foreach ($this->gtree->get_levels() as $key=>$row) {
710             if ($key == 0) {
711                 // do not display course grade category
712                 // continue;
713             }
715             $headingrow = new html_table_row();
716             $headingrow->attributes['class'] = 'heading_name_row';
718             foreach ($row as $columnkey => $element) {
719                 $sortlink = clone($this->baseurl);
720                 if (isset($element['object']->id)) {
721                     $sortlink->param('sortitemid', $element['object']->id);
722                 }
724                 $eid    = $element['eid'];
725                 $object = $element['object'];
726                 $type   = $element['type'];
727                 $categorystate = @$element['categorystate'];
729                 if (!empty($element['colspan'])) {
730                     $colspan = $element['colspan'];
731                 } else {
732                     $colspan = 1;
733                 }
735                 if (!empty($element['depth'])) {
736                     $catlevel = 'catlevel'.$element['depth'];
737                 } else {
738                     $catlevel = '';
739                 }
741 // Element is a filler
742                 if ($type == 'filler' or $type == 'fillerfirst' or $type == 'fillerlast') {
743                     $fillercell = new html_table_cell();
744                     $fillercell->attributes['class'] = $type . ' ' . $catlevel;
745                     $fillercell->colspan = $colspan;
746                     $fillercell->text = '&nbsp;';
747                     $fillercell->header = true;
748                     $fillercell->scope = 'col';
749                     $headingrow->cells[] = $fillercell;
750                 }
751 // Element is a category
752                 else if ($type == 'category') {
753                     $categorycell = new html_table_cell();
754                     $categorycell->attributes['class'] = 'category ' . $catlevel;
755                     $categorycell->colspan = $colspan;
756                     $categorycell->text = shorten_text($element['object']->get_name());
757                     $categorycell->text .= $this->get_collapsing_icon($element);
758                     $categorycell->header = true;
759                     $categorycell->scope = 'col';
761                     // Print icons
762                     if ($USER->gradeediting[$this->courseid]) {
763                         $categorycell->text .= $this->get_icons($element);
764                     }
766                     $headingrow->cells[] = $categorycell;
767                 }
768 // Element is a grade_item
769                 else {
770                     //$itemmodule = $element['object']->itemmodule;
771                     //$iteminstance = $element['object']->iteminstance;
773                     if ($element['object']->id == $this->sortitemid) {
774                         if ($this->sortorder == 'ASC') {
775                             $arrow = $this->get_sort_arrow('up', $sortlink);
776                         } else {
777                             $arrow = $this->get_sort_arrow('down', $sortlink);
778                         }
779                     } else {
780                         $arrow = $this->get_sort_arrow('move', $sortlink);
781                     }
783                     $headerlink = $this->gtree->get_element_header($element, true, $this->get_pref('showactivityicons'), false);
785                     $itemcell = new html_table_cell();
786                     $itemcell->attributes['class'] = $type . ' ' . $catlevel . ' highlightable';
788                     if ($element['object']->is_hidden()) {
789                         $itemcell->attributes['class'] .= ' hidden';
790                     }
792                     $itemcell->colspan = $colspan;
793                     $itemcell->text = shorten_text($headerlink) . $arrow;
794                     $itemcell->header = true;
795                     $itemcell->scope = 'col';
797                     $headingrow->cells[] = $itemcell;
798                 }
799             }
800             $rows[] = $headingrow;
801         }
803         $rows = $this->get_right_icons_row($rows);
805         // Preload scale objects for items with a scaleid and initialize tab indices
806         $scaleslist = array();
807         $tabindices = array();
809         foreach ($this->gtree->get_items() as $itemid=>$item) {
810             $scale = null;
811             if (!empty($item->scaleid)) {
812                 $scaleslist[] = $item->scaleid;
813                 $jsarguments['items'][$itemid] = array('id'=>$itemid, 'name'=>$item->get_name(true), 'type'=>'scale', 'scale'=>$item->scaleid, 'decimals'=>$item->get_decimals());
814             } else {
815                 $jsarguments['items'][$itemid] = array('id'=>$itemid, 'name'=>$item->get_name(true), 'type'=>'value', 'scale'=>false, 'decimals'=>$item->get_decimals());
816             }
817             $tabindices[$item->id]['grade'] = $gradetabindex;
818             $tabindices[$item->id]['feedback'] = $gradetabindex + $numusers;
819             $gradetabindex += $numusers * 2;
820         }
821         $scalesarray = array();
823         if (!empty($scaleslist)) {
824             $scalesarray = $DB->get_records_list('scale', 'id', $scaleslist);
825         }
826         $jsscales = $scalesarray;
828         $rowclasses = array('even', 'odd');
830         foreach ($this->users as $userid => $user) {
832             if ($this->canviewhidden) {
833                 $altered = array();
834                 $unknown = array();
835             } else {
836                 $hidingaffected = grade_grade::get_hiding_affected($this->grades[$userid], $this->gtree->get_items());
837                 $altered = $hidingaffected['altered'];
838                 $unknown = $hidingaffected['unknown'];
839                 unset($hidingaffected);
840             }
843             $itemrow = new html_table_row();
844             $itemrow->id = 'user_'.$userid;
845             $itemrow->attributes['class'] = $rowclasses[$this->rowcount % 2];
847             $jsarguments['users'][$userid] = fullname($user);
849             foreach ($this->gtree->items as $itemid=>$unused) {
850                 $item =& $this->gtree->items[$itemid];
851                 $grade = $this->grades[$userid][$item->id];
853                 $itemcell = new html_table_cell();
855                 $itemcell->id = 'u'.$userid.'i'.$itemid;
857                 // Get the decimal points preference for this item
858                 $decimalpoints = $item->get_decimals();
860                 if (in_array($itemid, $unknown)) {
861                     $gradeval = null;
862                 } else if (array_key_exists($itemid, $altered)) {
863                     $gradeval = $altered[$itemid];
864                 } else {
865                     $gradeval = $grade->finalgrade;
866                 }
868                 // MDL-11274
869                 // Hide grades in the grader report if the current grader doesn't have 'moodle/grade:viewhidden'
870                 if (!$this->canviewhidden and $grade->is_hidden()) {
871                     if (!empty($CFG->grade_hiddenasdate) and $grade->get_datesubmitted() and !$item->is_category_item() and !$item->is_course_item()) {
872                         // 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
873                         $itemcell->text = html_writer::tag('span', userdate($grade->get_datesubmitted(),get_string('strftimedatetimeshort')), array('class'=>'datesubmitted'));
874                     } else {
875                         $itemcell->text = '-';
876                     }
877                     $itemrow->cells[] = $itemcell;
878                     continue;
879                 }
881                 // emulate grade element
882                 $eid = $this->gtree->get_grade_eid($grade);
883                 $element = array('eid'=>$eid, 'object'=>$grade, 'type'=>'grade');
885                 $itemcell->attributes['class'] .= ' grade';
886                 if ($item->is_category_item()) {
887                     $itemcell->attributes['class'] .= ' cat';
888                 }
889                 if ($item->is_course_item()) {
890                     $itemcell->attributes['class'] .= ' course';
891                 }
892                 if ($grade->is_overridden()) {
893                     $itemcell->attributes['class'] .= ' overridden';
894                 }
896                 if ($grade->is_excluded()) {
897                     // $itemcell->attributes['class'] .= ' excluded';
898                 }
900                 if (!empty($grade->feedback)) {
901                     //should we be truncating feedback? ie $short_feedback = shorten_text($feedback, $this->feedback_trunc_length);
902                     $jsarguments['feedback'][] = array('user'=>$userid, 'item'=>$itemid, 'content'=>wordwrap(trim(format_string($grade->feedback, $grade->feedbackformat)), 34, '<br/ >'));
903                 }
905                 if ($grade->is_excluded()) {
906                     $itemcell->text .= html_writer::tag('span', get_string('excluded', 'grades'), array('class'=>'excludedfloater'));
907                 }
909                 // Do not show any icons if no grade (no record in DB to match)
910                 if (!$item->needsupdate and $USER->gradeediting[$this->courseid]) {
911                     $itemcell->text .= $this->get_icons($element);
912                 }
914                 $hidden = '';
915                 if ($grade->is_hidden()) {
916                     $hidden = ' hidden ';
917                 }
919                 $gradepass = ' gradefail ';
920                 if ($grade->is_passed($item)) {
921                     $gradepass = ' gradepass ';
922                 } elseif (is_null($grade->is_passed($item))) {
923                     $gradepass = '';
924                 }
926                 // if in editing mode, we need to print either a text box
927                 // or a drop down (for scales)
928                 // grades in item of type grade category or course are not directly editable
929                 if ($item->needsupdate) {
930                     $itemcell->text .= html_writer::tag('span', get_string('error'), array('class'=>"gradingerror$hidden"));
932                 } else if ($USER->gradeediting[$this->courseid]) {
934                     if ($item->scaleid && !empty($scalesarray[$item->scaleid])) {
935                         $scale = $scalesarray[$item->scaleid];
936                         $gradeval = (int)$gradeval; // scales use only integers
937                         $scales = explode(",", $scale->scale);
938                         // reindex because scale is off 1
940                         // MDL-12104 some previous scales might have taken up part of the array
941                         // so this needs to be reset
942                         $scaleopt = array();
943                         $i = 0;
944                         foreach ($scales as $scaleoption) {
945                             $i++;
946                             $scaleopt[$i] = $scaleoption;
947                         }
949                         if ($this->get_pref('quickgrading') and $grade->is_editable()) {
950                             $oldval = empty($gradeval) ? -1 : $gradeval;
951                             if (empty($item->outcomeid)) {
952                                 $nogradestr = $this->get_lang_string('nograde');
953                             } else {
954                                 $nogradestr = $this->get_lang_string('nooutcome', 'grades');
955                             }
956                             $itemcell->text .= '<input type="hidden" id="oldgrade_'.$userid.'_'.$item->id.'" name="oldgrade_'.$userid.'_'.$item->id.'" value="'.$oldval.'"/>';
957                             $attributes = array('tabindex' => $tabindices[$item->id]['grade'], 'id'=>'grade_'.$userid.'_'.$item->id);
958                             $itemcell->text .= html_writer::select($scaleopt, 'grade_'.$userid.'_'.$item->id, $gradeval, array(-1=>$nogradestr), $attributes);;
959                         } elseif(!empty($scale)) {
960                             $scales = explode(",", $scale->scale);
962                             // invalid grade if gradeval < 1
963                             if ($gradeval < 1) {
964                                 $itemcell->text .= html_writer::tag('span', '-', array('class'=>"gradevalue$hidden$gradepass"));
965                             } else {
966                                 $gradeval = $grade->grade_item->bounded_grade($gradeval); //just in case somebody changes scale
967                                 $itemcell->text .= html_writer::tag('span', $scales[$gradeval-1], array('class'=>"gradevalue$hidden$gradepass"));
968                             }
969                         } else {
970                             // no such scale, throw error?
971                         }
973                     } else if ($item->gradetype != GRADE_TYPE_TEXT) { // Value type
974                         if ($this->get_pref('quickgrading') and $grade->is_editable()) {
975                             $value = format_float($gradeval, $decimalpoints);
976                             $itemcell->text .= '<input type="hidden" id="oldgrade_'.$userid.'_'.$item->id.'" name="oldgrade_'.$userid.'_'.$item->id.'" value="'.$value.'" />';
977                             $itemcell->text .= '<input size="6" tabindex="' . $tabindices[$item->id]['grade']
978                                           . '" type="text" class="text" title="'. $strgrade .'" name="grade_'
979                                           .$userid.'_' .$item->id.'" id="grade_'.$userid.'_'.$item->id.'" value="'.$value.'" />';
980                         } else {
981                             $itemcell->text .= html_writer::tag('span', format_float($gradeval, $decimalpoints), array('class'=>"gradevalue$hidden$gradepass"));
982                         }
983                     }
986                     // If quickfeedback is on, print an input element
987                     if ($this->get_pref('showquickfeedback') and $grade->is_editable()) {
989                         $itemcell->text .= '<input type="hidden" id="oldfeedback_'.$userid.'_'.$item->id.'" name="oldfeedback_'.$userid.'_'.$item->id.'" value="' . s($grade->feedback) . '" />';
990                         $itemcell->text .= '<input class="quickfeedback" tabindex="' . $tabindices[$item->id]['feedback'].'" id="feedback_'.$userid.'_'.$item->id
991                                       . '" size="6" title="' . $strfeedback . '" type="text" name="feedback_'.$userid.'_'.$item->id.'" value="' . s($grade->feedback) . '" />';
992                     }
994                 } else { // Not editing
995                     $gradedisplaytype = $item->get_displaytype();
997                     if ($item->scaleid && !empty($scalesarray[$item->scaleid])) {
998                         $itemcell->attributes['class'] .= ' grade_type_scale';
999                     } else if ($item->gradetype != GRADE_TYPE_TEXT) {
1000                         $itemcell->attributes['class'] .= ' grade_type_text';
1001                     }
1003                     if ($this->get_pref('enableajax')) {
1004                         $itemcell->attributes['class'] .= ' clickable';
1005                     }
1007                     if ($item->needsupdate) {
1008                         $itemcell->text .= html_writer::tag('span', get_string('error'), array('class'=>"gradingerror$hidden$gradepass"));
1009                     } else {
1010                         $itemcell->text .= html_writer::tag('span', grade_format_gradevalue($gradeval, $item, true, $gradedisplaytype, null), array('class'=>"gradevalue$hidden$gradepass"));
1011                         if ($this->get_pref('showanalysisicon')) {
1012                             $itemcell->text .= $this->gtree->get_grade_analysis_icon($grade);
1013                         }
1014                     }
1015                 }
1017                 if (!empty($this->gradeserror[$item->id][$userid])) {
1018                     $itemcell->text .= $this->gradeserror[$item->id][$userid];
1019                 }
1021                 $itemrow->cells[] = $itemcell;
1022             }
1023             $rows[] = $itemrow;
1024         }
1026         if ($this->get_pref('enableajax')) {
1027             $jsarguments['cfg']['ajaxenabled'] = true;
1028             $jsarguments['cfg']['scales'] = array();
1029             foreach ($jsscales as $scale) {
1030                 $jsarguments['cfg']['scales'][$scale->id] = explode(',',$scale->scale);
1031             }
1032             $jsarguments['cfg']['feedbacktrunclength'] =  $this->feedback_trunc_length;
1034             //feedbacks are now being stored in $jsarguments['feedback'] in get_right_rows()
1035             //$jsarguments['cfg']['feedback'] =  $this->feedbacks;
1036         }
1037         $jsarguments['cfg']['isediting'] = (bool)$USER->gradeediting[$this->courseid];
1038         $jsarguments['cfg']['courseid'] =  $this->courseid;
1039         $jsarguments['cfg']['studentsperpage'] =  $this->get_pref('studentsperpage');
1040         $jsarguments['cfg']['showquickfeedback'] =  (bool)$this->get_pref('showquickfeedback');
1042         $module = array(
1043             'name'      => 'gradereport_grader',
1044             'fullpath'  => '/grade/report/grader/module.js',
1045             'requires'  => array('base', 'dom', 'event', 'event-mouseenter', 'event-key', 'io-queue', 'json-parse', 'overlay')
1046         );
1047         $PAGE->requires->js_init_call('M.gradereport_grader.init_report', $jsarguments, false, $module);
1048         $PAGE->requires->strings_for_js(array('addfeedback','feedback', 'grade'), 'grades');
1049         $PAGE->requires->strings_for_js(array('ajaxchoosescale','ajaxclicktoclose','ajaxerror','ajaxfailedupdate', 'ajaxfieldchanged'), 'gradereport_grader');
1051         $rows = $this->get_right_range_row($rows);
1052         $rows = $this->get_right_avg_row($rows, true);
1053         $rows = $this->get_right_avg_row($rows);
1055         return $rows;
1056     }
1058     /**
1059      * Depending on the style of report (fixedstudents vs traditional one-table),
1060      * arranges the rows of data in one or two tables, and returns the output of
1061      * these tables in HTML
1062      * @return string HTML
1063      */
1064     public function get_grade_table() {
1065         global $OUTPUT;
1066         $fixedstudents = $this->is_fixed_students();
1068         $leftrows = $this->get_left_rows();
1069         $rightrows = $this->get_right_rows();
1071         $html = '';
1074         if ($fixedstudents) {
1075             $fixedcolumntable = new html_table();
1076             $fixedcolumntable->id = 'fixed_column';
1077             $fixedcolumntable->data = $leftrows;
1078             $html .= $OUTPUT->container(html_writer::table($fixedcolumntable), 'left_scroller');
1080             $righttable = new html_table();
1081             $righttable->id = 'user-grades';
1082             $righttable->data = $rightrows;
1084             $html .= $OUTPUT->container(html_writer::table($righttable), 'right_scroller');
1085         } else {
1086             $fulltable = new html_table();
1087             $fulltable->attributes['class'] = 'gradestable flexible boxaligncenter generaltable';
1088             $fulltable->id = 'user-grades';
1090             // Extract rows from each side (left and right) and collate them into one row each
1091             foreach ($leftrows as $key => $row) {
1092                 $row->cells = array_merge($row->cells, $rightrows[$key]->cells);
1093                 $fulltable->data[] = $row;
1094             }
1095             $html .= html_writer::table($fulltable);
1096         }
1097         return $OUTPUT->container($html, 'gradeparent');
1098     }
1100     /**
1101      * Builds and return the row of icons for the left side of the report.
1102      * It only has one cell that says "Controls"
1103      * @param array $rows The Array of rows for the left part of the report
1104      * @param int $colspan The number of columns this cell has to span
1105      * @return array Array of rows for the left part of the report
1106      */
1107     public function get_left_icons_row($rows=array(), $colspan=1) {
1108         global $USER;
1110         if ($USER->gradeediting[$this->courseid]) {
1111             $controlsrow = new html_table_row();
1112             $controlsrow->attributes['class'] = 'controls';
1113             $controlscell = new html_table_cell();
1114             $controlscell->attributes['class'] = 'header controls';
1115             $controlscell->colspan = $colspan;
1116             $controlscell->text = $this->get_lang_string('controls','grades');
1118             $controlsrow->cells[] = $controlscell;
1119             $rows[] = $controlsrow;
1120         }
1121         return $rows;
1122     }
1124     /**
1125      * Builds and return the header for the row of ranges, for the left part of the grader report.
1126      * @param array $rows The Array of rows for the left part of the report
1127      * @param int $colspan The number of columns this cell has to span
1128      * @return array Array of rows for the left part of the report
1129      */
1130     public function get_left_range_row($rows=array(), $colspan=1) {
1131         global $CFG, $USER;
1133         if ($this->get_pref('showranges')) {
1134             $rangerow = new html_table_row();
1135             $rangerow->attributes['class'] = 'range r'.$this->rowcount++;
1136             $rangecell = new html_table_cell();
1137             $rangecell->attributes['class'] = 'header range';
1138             $rangecell->colspan = $colspan;
1139             $rangecell->header = true;
1140             $rangecell->scope = 'row';
1141             $rangecell->text = $this->get_lang_string('range','grades');
1142             $rangerow->cells[] = $rangecell;
1143             $rows[] = $rangerow;
1144         }
1146         return $rows;
1147     }
1149     /**
1150      * Builds and return the headers for the rows of averages, for the left part of the grader report.
1151      * @param array $rows The Array of rows for the left part of the report
1152      * @param int $colspan The number of columns this cell has to span
1153      * @param bool $groupavg If true, returns the row for group averages, otherwise for overall averages
1154      * @return array Array of rows for the left part of the report
1155      */
1156     public function get_left_avg_row($rows=array(), $colspan=1, $groupavg=false) {
1157         if (!$this->canviewhidden) {
1158             // totals might be affected by hiding, if user can not see hidden grades the aggregations might be altered
1159             // better not show them at all if user can not see all hideen grades
1160             return $rows;
1161         }
1163         $showaverages = $this->get_pref('showaverages');
1164         $showaveragesgroup = $this->currentgroup && $showaverages;
1165         $straveragegroup = get_string('groupavg', 'grades');
1167         if ($groupavg) {
1168             if ($showaveragesgroup) {
1169                 $groupavgrow = new html_table_row();
1170                 $groupavgrow->attributes['class'] = 'groupavg r'.$this->rowcount++;
1171                 $groupavgcell = new html_table_cell();
1172                 $groupavgcell->attributes['class'] = 'header range';
1173                 $groupavgcell->colspan = $colspan;
1174                 $groupavgcell->header = true;
1175                 $groupavgcell->scope = 'row';
1176                 $groupavgcell->text = $straveragegroup;
1177                 $groupavgrow->cells[] = $groupavgcell;
1178                 $rows[] = $groupavgrow;
1179             }
1180         } else {
1181             $straverage = get_string('overallaverage', 'grades');
1183             if ($showaverages) {
1184                 $avgrow = new html_table_row();
1185                 $avgrow->attributes['class'] = 'avg r'.$this->rowcount++;
1186                 $avgcell = new html_table_cell();
1187                 $avgcell->attributes['class'] = 'header range';
1188                 $avgcell->colspan = $colspan;
1189                 $avgcell->header = true;
1190                 $avgcell->scope = 'row';
1191                 $avgcell->text = $straverage;
1192                 $avgrow->cells[] = $avgcell;
1193                 $rows[] = $avgrow;
1194             }
1195         }
1197         return $rows;
1198     }
1200     /**
1201      * Builds and return the row of icons when editing is on, for the right part of the grader report.
1202      * @param array $rows The Array of rows for the right part of the report
1203      * @return array Array of rows for the right part of the report
1204      */
1205     public function get_right_icons_row($rows=array()) {
1206         global $USER;
1207         if ($USER->gradeediting[$this->courseid]) {
1208             $iconsrow = new html_table_row();
1209             $iconsrow->attributes['class'] = 'controls';
1211             foreach ($this->gtree->items as $itemid=>$unused) {
1212                 // emulate grade element
1213                 $item = $this->gtree->get_item($itemid);
1215                 $eid = $this->gtree->get_item_eid($item);
1216                 $element = $this->gtree->locate_element($eid);
1217                 $itemcell = new html_table_cell();
1218                 $itemcell->attributes['class'] = 'controls icons';
1219                 $itemcell->text = $this->get_icons($element);
1220                 $iconsrow->cells[] = $itemcell;
1221             }
1222             $rows[] = $iconsrow;
1223         }
1224         return $rows;
1225     }
1227     /**
1228      * Builds and return the row of ranges for the right part of the grader report.
1229      * @param array $rows The Array of rows for the right part of the report
1230      * @return array Array of rows for the right part of the report
1231      */
1232     public function get_right_range_row($rows=array()) {
1233         global $OUTPUT;
1235         if ($this->get_pref('showranges')) {
1236             $rangesdisplaytype   = $this->get_pref('rangesdisplaytype');
1237             $rangesdecimalpoints = $this->get_pref('rangesdecimalpoints');
1238             $rangerow = new html_table_row();
1239             $rangerow->attributes['class'] = 'heading range';
1241             foreach ($this->gtree->items as $itemid=>$unused) {
1242                 $item =& $this->gtree->items[$itemid];
1243                 $itemcell = new html_table_cell();
1244                 $itemcell->header = true;
1245                 $itemcell->attributes['class'] .= ' header range';
1247                 $hidden = '';
1248                 if ($item->is_hidden()) {
1249                     $hidden = ' hidden ';
1250                 }
1252                 $formattedrange = $item->get_formatted_range($rangesdisplaytype, $rangesdecimalpoints);
1254                 $itemcell->text = $OUTPUT->container($formattedrange, 'rangevalues'.$hidden);
1255                 $rangerow->cells[] = $itemcell;
1256             }
1257             $rows[] = $rangerow;
1258         }
1259         return $rows;
1260     }
1262     /**
1263      * Builds and return the row of averages for the right part of the grader report.
1264      * @param array $rows Whether to return only group averages or all averages.
1265      * @param bool $grouponly Whether to return only group averages or all averages.
1266      * @return array Array of rows for the right part of the report
1267      */
1268     public function get_right_avg_row($rows=array(), $grouponly=false) {
1269         global $CFG, $USER, $DB, $OUTPUT;
1271         if (!$this->canviewhidden) {
1272             // totals might be affected by hiding, if user can not see hidden grades the aggregations might be altered
1273             // better not show them at all if user can not see all hidden grades
1274             return $rows;
1275         }
1277         $showaverages = $this->get_pref('showaverages');
1278         $showaveragesgroup = $this->currentgroup && $showaverages;
1280         $averagesdisplaytype   = $this->get_pref('averagesdisplaytype');
1281         $averagesdecimalpoints = $this->get_pref('averagesdecimalpoints');
1282         $meanselection         = $this->get_pref('meanselection');
1283         $shownumberofgrades    = $this->get_pref('shownumberofgrades');
1285         $avghtml = '';
1286         $avgcssclass = 'avg';
1288         if ($grouponly) {
1289             $straverage = get_string('groupavg', 'grades');
1290             $showaverages = $this->currentgroup && $this->get_pref('showaverages');
1291             $groupsql = $this->groupsql;
1292             $groupwheresql = $this->groupwheresql;
1293             $groupwheresqlparams = $this->groupwheresql_params;
1294             $avgcssclass = 'groupavg';
1295         } else {
1296             $straverage = get_string('overallaverage', 'grades');
1297             $showaverages = $this->get_pref('showaverages');
1298             $groupsql = "";
1299             $groupwheresql = "";
1300             $groupwheresqlparams = array();
1301         }
1303         if ($shownumberofgrades) {
1304             $straverage .= ' (' . get_string('submissions', 'grades') . ') ';
1305         }
1307         $totalcount = $this->get_numusers($grouponly);
1309         //limit to users with a gradeable role
1310         list($gradebookrolessql, $gradebookrolesparams) = $DB->get_in_or_equal(explode(',', $this->gradebookroles), SQL_PARAMS_NAMED, 'grbr0');
1312         //limit to users with an active enrollment
1313         list($enrolledsql, $enrolledparams) = get_enrolled_sql($this->context);
1315         if ($showaverages) {
1316             $params = array_merge(array('courseid'=>$this->courseid), $gradebookrolesparams, $enrolledparams, $groupwheresqlparams);
1318             // find sums of all grade items in course
1319             $sql = "SELECT g.itemid, SUM(g.finalgrade) AS sum
1320                       FROM {grade_items} gi
1321                       JOIN {grade_grades} g ON g.itemid = gi.id
1322                       JOIN {user} u ON u.id = g.userid
1323                       JOIN ($enrolledsql) je ON je.id = u.id
1324                       JOIN (
1325                                SELECT DISTINCT ra.userid
1326                                  FROM {role_assignments} ra
1327                                 WHERE ra.roleid $gradebookrolessql
1328                                   AND ra.contextid " . get_related_contexts_string($this->context) . "
1329                            ) rainner ON rainner.userid = u.id
1330                       $groupsql
1331                      WHERE gi.courseid = :courseid
1332                        AND u.deleted = 0
1333                        AND g.finalgrade IS NOT NULL
1334                        $groupwheresql
1335                      GROUP BY g.itemid";
1336             $sumarray = array();
1337             if ($sums = $DB->get_records_sql($sql, $params)) {
1338                 foreach ($sums as $itemid => $csum) {
1339                     $sumarray[$itemid] = $csum->sum;
1340                 }
1341             }
1343             // MDL-10875 Empty grades must be evaluated as grademin, NOT always 0
1344             // This query returns a count of ungraded grades (NULL finalgrade OR no matching record in grade_grades table)
1345             $sql = "SELECT gi.id, COUNT(DISTINCT u.id) AS count
1346                       FROM {grade_items} gi
1347                       CROSS JOIN {user} u
1348                       JOIN ($enrolledsql) je
1349                            ON je.id = u.id
1350                       JOIN {role_assignments} ra
1351                            ON ra.userid = u.id
1352                       LEFT OUTER JOIN {grade_grades} g
1353                            ON (g.itemid = gi.id AND g.userid = u.id AND g.finalgrade IS NOT NULL)
1354                       $groupsql
1355                      WHERE gi.courseid = :courseid
1356                            AND ra.roleid $gradebookrolessql
1357                            AND ra.contextid ".get_related_contexts_string($this->context)."
1358                            AND u.deleted = 0
1359                            AND g.id IS NULL
1360                            $groupwheresql
1361                   GROUP BY gi.id";
1363             $ungradedcounts = $DB->get_records_sql($sql, $params);
1365             $avgrow = new html_table_row();
1366             $avgrow->attributes['class'] = 'avg';
1368             foreach ($this->gtree->items as $itemid=>$unused) {
1369                 $item =& $this->gtree->items[$itemid];
1371                 if ($item->needsupdate) {
1372                     $avgcell = new html_table_cell();
1373                     $avgcell->text = $OUTPUT->container(get_string('error'), 'gradingerror');
1374                     $avgrow->cells[] = $avgcell;
1375                     continue;
1376                 }
1378                 if (!isset($sumarray[$item->id])) {
1379                     $sumarray[$item->id] = 0;
1380                 }
1382                 if (empty($ungradedcounts[$itemid])) {
1383                     $ungradedcount = 0;
1384                 } else {
1385                     $ungradedcount = $ungradedcounts[$itemid]->count;
1386                 }
1388                 if ($meanselection == GRADE_REPORT_MEAN_GRADED) {
1389                     $meancount = $totalcount - $ungradedcount;
1390                 } else { // Bump up the sum by the number of ungraded items * grademin
1391                     $sumarray[$item->id] += $ungradedcount * $item->grademin;
1392                     $meancount = $totalcount;
1393                 }
1395                 $decimalpoints = $item->get_decimals();
1397                 // Determine which display type to use for this average
1398                 if ($USER->gradeediting[$this->courseid]) {
1399                     $displaytype = GRADE_DISPLAY_TYPE_REAL;
1401                 } else if ($averagesdisplaytype == GRADE_REPORT_PREFERENCE_INHERIT) { // no ==0 here, please resave the report and user preferences
1402                     $displaytype = $item->get_displaytype();
1404                 } else {
1405                     $displaytype = $averagesdisplaytype;
1406                 }
1408                 // Override grade_item setting if a display preference (not inherit) was set for the averages
1409                 if ($averagesdecimalpoints == GRADE_REPORT_PREFERENCE_INHERIT) {
1410                     $decimalpoints = $item->get_decimals();
1412                 } else {
1413                     $decimalpoints = $averagesdecimalpoints;
1414                 }
1416                 if (!isset($sumarray[$item->id]) || $meancount == 0) {
1417                     $avgcell = new html_table_cell();
1418                     $avgcell->text = '-';
1419                     $avgrow->cells[] = $avgcell;
1421                 } else {
1422                     $sum = $sumarray[$item->id];
1423                     $avgradeval = $sum/$meancount;
1424                     $gradehtml = grade_format_gradevalue($avgradeval, $item, true, $displaytype, $decimalpoints);
1426                     $numberofgrades = '';
1427                     if ($shownumberofgrades) {
1428                         $numberofgrades = " ($meancount)";
1429                     }
1431                     $avgcell = new html_table_cell();
1432                     $avgcell->text = $gradehtml.$numberofgrades;
1433                     $avgrow->cells[] = $avgcell;
1434                 }
1435             }
1436             $rows[] = $avgrow;
1437         }
1438         return $rows;
1439     }
1441     /**
1442      * Given a grade_category, grade_item or grade_grade, this function
1443      * figures out the state of the object and builds then returns a div
1444      * with the icons needed for the grader report.
1445      *
1446      * @param array $object
1447      * @return string HTML
1448      */
1449     protected function get_icons($element) {
1450         global $CFG, $USER, $OUTPUT;
1452         if (!$USER->gradeediting[$this->courseid]) {
1453             return '<div class="grade_icons" />';
1454         }
1456         // Init all icons
1457         $editicon = '';
1459         if ($element['type'] != 'categoryitem' && $element['type'] != 'courseitem') {
1460             $editicon = $this->gtree->get_edit_icon($element, $this->gpr);
1461         }
1463         $editcalculationicon = '';
1464         $showhideicon        = '';
1465         $lockunlockicon      = '';
1467         if (has_capability('moodle/grade:manage', $this->context)) {
1468             if ($this->get_pref('showcalculations')) {
1469                 $editcalculationicon = $this->gtree->get_calculation_icon($element, $this->gpr);
1470             }
1472             if ($this->get_pref('showeyecons')) {
1473                $showhideicon = $this->gtree->get_hiding_icon($element, $this->gpr);
1474             }
1476             if ($this->get_pref('showlocks')) {
1477                 $lockunlockicon = $this->gtree->get_locking_icon($element, $this->gpr);
1478             }
1480         }
1482         $gradeanalysisicon   = '';
1483         if ($this->get_pref('showanalysisicon') && $element['type'] == 'grade') {
1484             $gradeanalysisicon .= $this->gtree->get_grade_analysis_icon($element['object']);
1485         }
1487         return $OUTPUT->container($editicon.$editcalculationicon.$showhideicon.$lockunlockicon.$gradeanalysisicon, 'grade_icons');
1488     }
1490     /**
1491      * Given a category element returns collapsing +/- icon if available
1492      * @param object $object
1493      * @return string HTML
1494      */
1495     protected function get_collapsing_icon($element) {
1496         global $OUTPUT;
1498         $icon = '';
1499         // If object is a category, display expand/contract icon
1500         if ($element['type'] == 'category') {
1501             // Load language strings
1502             $strswitchminus = $this->get_lang_string('aggregatesonly', 'grades');
1503             $strswitchplus  = $this->get_lang_string('gradesonly', 'grades');
1504             $strswitchwhole = $this->get_lang_string('fullmode', 'grades');
1506             $url = new moodle_url($this->gpr->get_return_url(null, array('target'=>$element['eid'], 'sesskey'=>sesskey())));
1508             if (in_array($element['object']->id, $this->collapsed['aggregatesonly'])) {
1509                 $url->param('action', 'switch_plus');
1510                 $icon = $OUTPUT->action_icon($url, new pix_icon('t/switch_plus', $strswitchplus));
1512             } else if (in_array($element['object']->id, $this->collapsed['gradesonly'])) {
1513                 $url->param('action', 'switch_whole');
1514                 $icon = $OUTPUT->action_icon($url, new pix_icon('t/switch_whole', $strswitchwhole));
1516             } else {
1517                 $url->param('action', 'switch_minus');
1518                 $icon = $OUTPUT->action_icon($url, new pix_icon('t/switch_minus', $strswitchminus));
1519             }
1520         }
1521         return $icon;
1522     }
1524     /**
1525      * Processes a single action against a category, grade_item or grade.
1526      * @param string $target eid ({type}{id}, e.g. c4 for category4)
1527      * @param string $action Which action to take (edit, delete etc...)
1528      * @return
1529      */
1530     public function process_action($target, $action) {
1531         // TODO: this code should be in some grade_tree static method
1532         $targettype = substr($target, 0, 1);
1533         $targetid = substr($target, 1);
1534         // TODO: end
1536         if ($collapsed = get_user_preferences('grade_report_grader_collapsed_categories')) {
1537             $collapsed = unserialize($collapsed);
1538         } else {
1539             $collapsed = array('aggregatesonly' => array(), 'gradesonly' => array());
1540         }
1542         switch ($action) {
1543             case 'switch_minus': // Add category to array of aggregatesonly
1544                 if (!in_array($targetid, $collapsed['aggregatesonly'])) {
1545                     $collapsed['aggregatesonly'][] = $targetid;
1546                     set_user_preference('grade_report_grader_collapsed_categories', serialize($collapsed));
1547                 }
1548                 break;
1550             case 'switch_plus': // Remove category from array of aggregatesonly, and add it to array of gradesonly
1551                 $key = array_search($targetid, $collapsed['aggregatesonly']);
1552                 if ($key !== false) {
1553                     unset($collapsed['aggregatesonly'][$key]);
1554                 }
1555                 if (!in_array($targetid, $collapsed['gradesonly'])) {
1556                     $collapsed['gradesonly'][] = $targetid;
1557                 }
1558                 set_user_preference('grade_report_grader_collapsed_categories', serialize($collapsed));
1559                 break;
1560             case 'switch_whole': // Remove the category from the array of collapsed cats
1561                 $key = array_search($targetid, $collapsed['gradesonly']);
1562                 if ($key !== false) {
1563                     unset($collapsed['gradesonly'][$key]);
1564                     set_user_preference('grade_report_grader_collapsed_categories', serialize($collapsed));
1565                 }
1567                 break;
1568             default:
1569                 break;
1570         }
1572         return true;
1573     }
1575     /**
1576      * Returns whether or not to display fixed students column.
1577      * Includes a browser check, because IE6 doesn't support the scrollbar.
1578      *
1579      * @return bool
1580      */
1581     public function is_fixed_students() {
1582         global $USER, $CFG;
1583         return empty($USER->screenreader) && $CFG->grade_report_fixedstudents &&
1584             (check_browser_version('MSIE', '7.0') ||
1585              check_browser_version('Firefox', '2.0') ||
1586              check_browser_version('Gecko', '2006010100') ||
1587              check_browser_version('Camino', '1.0') ||
1588              check_browser_version('Opera', '6.0') ||
1589              check_browser_version('Chrome', '6') ||
1590              check_browser_version('Safari', '300'));
1591     }
1593     /**
1594      * Refactored function for generating HTML of sorting links with matching arrows.
1595      * Returns an array with 'studentname' and 'idnumber' as keys, with HTML ready
1596      * to inject into a table header cell.
1597      * @param array $extrafields Array of extra fields being displayed, such as
1598      *   user idnumber
1599      * @return array An associative array of HTML sorting links+arrows
1600      */
1601     public function get_sort_arrows(array $extrafields = array()) {
1602         global $OUTPUT;
1603         $arrows = array();
1605         $strsortasc   = $this->get_lang_string('sortasc', 'grades');
1606         $strsortdesc  = $this->get_lang_string('sortdesc', 'grades');
1607         $strfirstname = $this->get_lang_string('firstname');
1608         $strlastname  = $this->get_lang_string('lastname');
1610         $firstlink = html_writer::link(new moodle_url($this->baseurl, array('sortitemid'=>'firstname')), $strfirstname);
1611         $lastlink = html_writer::link(new moodle_url($this->baseurl, array('sortitemid'=>'lastname')), $strlastname);
1613         $arrows['studentname'] = $lastlink;
1615         if ($this->sortitemid === 'lastname') {
1616             if ($this->sortorder == 'ASC') {
1617                 $arrows['studentname'] .= print_arrow('up', $strsortasc, true);
1618             } else {
1619                 $arrows['studentname'] .= print_arrow('down', $strsortdesc, true);
1620             }
1621         }
1623         $arrows['studentname'] .= ' ' . $firstlink;
1625         if ($this->sortitemid === 'firstname') {
1626             if ($this->sortorder == 'ASC') {
1627                 $arrows['studentname'] .= print_arrow('up', $strsortasc, true);
1628             } else {
1629                 $arrows['studentname'] .= print_arrow('down', $strsortdesc, true);
1630             }
1631         }
1633         foreach ($extrafields as $field) {
1634             $fieldlink = html_writer::link(new moodle_url($this->baseurl,
1635                     array('sortitemid'=>$field)), get_user_field_name($field));
1636             $arrows[$field] = $fieldlink;
1638             if ($field == $this->sortitemid) {
1639                 if ($this->sortorder == 'ASC') {
1640                     $arrows[$field] .= print_arrow('up', $strsortasc, true);
1641                 } else {
1642                     $arrows[$field] .= print_arrow('down', $strsortdesc, true);
1643                 }
1644             }
1645         }
1647         return $arrows;
1648     }