gradebook MDL-25769 Fixed SQL syntax formatting
[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 responsible 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 stdClass();
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 = $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 somebody 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         //limit to users with a gradeable role
337         list($gradebookrolessql, $gradebookrolesparams) = $DB->get_in_or_equal(explode(',', $this->gradebookroles), SQL_PARAMS_NAMED, 'grbr0');
339         //limit to users with an active enrollment
340         list($enrolledsql, $enrolledparams) = get_enrolled_sql($this->context);
342         //fields we need from the user table
343         $userfields = user_picture::fields('u', array('idnumber'));
345         //if the user has clicked one of the sort asc/desc arrows
346         if (is_numeric($this->sortitemid)) {
347             $params = array_merge(array('gitemid'=>$this->sortitemid), $gradebookrolesparams, $this->groupwheresql_params, $enrolledparams);
348             // the MAX() magic is required in order to please PG
349             $sort = "MAX(g.finalgrade) $this->sortorder";
351             $sql = "SELECT $userfields
352                       FROM {user} u
353                       JOIN ($enrolledsql) je
354                            ON je.id = u.id
355                       JOIN {role_assignments} ra
356                            ON ra.userid = u.id
357                       $this->groupsql
358                       LEFT JOIN {grade_grades} g
359                                 ON (g.userid = u.id AND g.itemid = :gitemid)
360                      WHERE ra.roleid $gradebookrolessql
361                            AND u.deleted = 0
362                            AND ra.contextid ".get_related_contexts_string($this->context)."
363                            $this->groupwheresql
364                   GROUP BY $userfields
365                   ORDER BY $sort";
367         } else {
368             switch($this->sortitemid) {
369                 case 'lastname':
370                     $sort = "u.lastname $this->sortorder, u.firstname $this->sortorder"; break;
371                 case 'firstname':
372                     $sort = "u.firstname $this->sortorder, u.lastname $this->sortorder"; break;
373                 case 'idnumber':
374                 default:
375                     $sort = "u.idnumber $this->sortorder"; break;
376             }
378             $params = array_merge($gradebookrolesparams, $this->groupwheresql_params, $enrolledparams);
380             $sql = "SELECT DISTINCT $userfields
381                       FROM {user} u
382                       JOIN ($enrolledsql) je
383                            ON je.id = u.id
384                       JOIN {role_assignments} ra
385                            ON u.id = ra.userid
386                            $this->groupsql
387                      WHERE ra.roleid $gradebookrolessql
388                            AND u.deleted = 0
389                            AND ra.contextid ".get_related_contexts_string($this->context)."
390                            $this->groupwheresql
391                   ORDER BY $sort";
392         }
395         $this->users = $DB->get_records_sql($sql, $params, $this->get_pref('studentsperpage') * $this->page, $this->get_pref('studentsperpage'));
397         if (empty($this->users)) {
398             $this->userselect = '';
399             $this->users = array();
400             $this->userselect_params = array();
401         } else {
402             list($usql, $params) = $DB->get_in_or_equal(array_keys($this->users), SQL_PARAMS_NAMED, 'usid0');
403             $this->userselect = "AND g.userid $usql";
404             $this->userselect_params = $params;
405         }
407         return $this->users;
408     }
410     /**
411      * we supply the userids in this query, and get all the grades
412      * pulls out all the grades, this does not need to worry about paging
413      */
414     public function load_final_grades() {
415         global $CFG, $DB;
417         // please note that we must fetch all grade_grades fields if we want to construct grade_grade object from it!
418         $params = array_merge(array('courseid'=>$this->courseid), $this->userselect_params);
419         $sql = "SELECT g.*
420                   FROM {grade_items} gi,
421                        {grade_grades} g
422                  WHERE g.itemid = gi.id AND gi.courseid = :courseid {$this->userselect}";
424         $userids = array_keys($this->users);
427         if ($grades = $DB->get_records_sql($sql, $params)) {
428             foreach ($grades as $graderec) {
429                 if (in_array($graderec->userid, $userids) and array_key_exists($graderec->itemid, $this->gtree->get_items())) { // some items may not be present!!
430                     $this->grades[$graderec->userid][$graderec->itemid] = new grade_grade($graderec, false);
431                     $this->grades[$graderec->userid][$graderec->itemid]->grade_item =& $this->gtree->get_item($graderec->itemid); // db caching
432                 }
433             }
434         }
436         // prefil grades that do not exist yet
437         foreach ($userids as $userid) {
438             foreach ($this->gtree->get_items() as $itemid=>$unused) {
439                 if (!isset($this->grades[$userid][$itemid])) {
440                     $this->grades[$userid][$itemid] = new grade_grade();
441                     $this->grades[$userid][$itemid]->itemid = $itemid;
442                     $this->grades[$userid][$itemid]->userid = $userid;
443                     $this->grades[$userid][$itemid]->grade_item =& $this->gtree->get_item($itemid); // db caching
444                 }
445             }
446         }
447     }
449     /**
450      * Builds and returns a div with on/off toggles.
451      * @return string HTML code
452      */
453     public function get_toggles_html() {
454         global $CFG, $USER, $COURSE, $OUTPUT;
456         $html = '';
457         if ($USER->gradeediting[$this->courseid]) {
458             if (has_capability('moodle/grade:manage', $this->context) or has_capability('moodle/grade:hide', $this->context)) {
459                 $html .= $this->print_toggle('eyecons');
460             }
461             if (has_capability('moodle/grade:manage', $this->context)
462              or has_capability('moodle/grade:lock', $this->context)
463              or has_capability('moodle/grade:unlock', $this->context)) {
464                 $html .= $this->print_toggle('locks');
465             }
466             if (has_capability('moodle/grade:manage', $this->context)) {
467                 $html .= $this->print_toggle('quickfeedback');
468             }
470             if (has_capability('moodle/grade:manage', $this->context)) {
471                 $html .= $this->print_toggle('calculations');
472             }
473         }
475         if ($this->canviewhidden) {
476             $html .= $this->print_toggle('averages');
477         }
479         $html .= $this->print_toggle('ranges');
480         if (!empty($CFG->enableoutcomes)) {
481             $html .= $this->print_toggle('nooutcomes');
482         }
484         return $OUTPUT->container($html, 'grade-report-toggles');
485     }
487     /**
488     * Shortcut function for printing the grader report toggles.
489     * @param string $type The type of toggle
490     * @param bool $return Whether to return the HTML string rather than printing it
491     * @return void
492     */
493     public function print_toggle($type) {
494         global $CFG, $OUTPUT;
496         $icons = array('eyecons' => 't/hide',
497                        'calculations' => 't/calc',
498                        'locks' => 't/lock',
499                        'averages' => 't/mean',
500                        'quickfeedback' => 't/feedback',
501                        'nooutcomes' => 't/outcomes');
503         $prefname = 'grade_report_show' . $type;
505         if (array_key_exists($prefname, $CFG)) {
506             $showpref = get_user_preferences($prefname, $CFG->$prefname);
507         } else {
508             $showpref = get_user_preferences($prefname);
509         }
511         $strshow = $this->get_lang_string('show' . $type, 'grades');
512         $strhide = $this->get_lang_string('hide' . $type, 'grades');
514         $showhide = 'show';
515         $toggleaction = 1;
517         if ($showpref) {
518             $showhide = 'hide';
519             $toggleaction = 0;
520         }
522         if (array_key_exists($type, $icons)) {
523             $imagename = $icons[$type];
524         } else {
525             $imagename = "t/$type";
526         }
528         $string = ${'str' . $showhide};
530         $url = new moodle_url($this->baseurl, array('toggle' => $toggleaction, 'toggle_type' => $type));
532         $retval = $OUTPUT->container($OUTPUT->action_icon($url, new pix_icon($imagename, $string))); // TODO: this container looks wrong here
534         return $retval;
535     }
537     /**
538      * Builds and returns the rows that will make up the left part of the grader report
539      * This consists of student names and icons, links to user reports and id numbers, as well
540      * as header cells for these columns. It also includes the fillers required for the
541      * categories displayed on the right side of the report.
542      * @return array Array of html_table_row objects
543      */
544     public function get_left_rows() {
545         global $CFG, $USER, $OUTPUT;
547         $rows = array();
549         $showuserimage = $this->get_pref('showuserimage');
550         $showuseridnumber = $this->get_pref('showuseridnumber');
551         $fixedstudents = $this->is_fixed_students();
553         $strfeedback  = $this->get_lang_string("feedback");
554         $strgrade     = $this->get_lang_string('grade');
556         $arrows = $this->get_sort_arrows();
558         $colspan = 1;
560         if (has_capability('gradereport/'.$CFG->grade_profilereport.':view', $this->context)) {
561             $colspan++;
562         }
564         if ($showuseridnumber) {
565             $colspan++;
566         }
568         $levels = count($this->gtree->levels) - 1;
570         for ($i = 0; $i < $levels; $i++) {
571             $fillercell = new html_table_cell();
572             $fillercell->attributes['class'] = 'fixedcolumn cell topleft';
573             $fillercell->text = ' ';
574             $fillercell->colspan = $colspan;
575             $row = new html_table_row(array($fillercell));
576             $rows[] = $row;
577         }
579         $headerrow = new html_table_row();
580         $headerrow->attributes['class'] = 'heading';
582         $studentheader = new html_table_cell();
583         $studentheader->attributes['class'] = 'header';
584         $studentheader->scope = 'col';
585         $studentheader->header = true;
586         $studentheader->id = 'studentheader';
587         if (has_capability('gradereport/'.$CFG->grade_profilereport.':view', $this->context)) {
588             $studentheader->colspan = 2;
589         }
590         $studentheader->text = $arrows['studentname'];
592         $headerrow->cells[] = $studentheader;
594         if ($showuseridnumber) {
595             // TODO: weird, this is not used anywhere
596             $sortidnumberlink = html_writer::link(new moodle_url($this->baseurl, array('sortitemid'=>'idnumber')), get_string('idnumber'));
598             $idnumberheader = new html_table_cell();
599             $idnumberheader->attributes['class'] = 'header useridnumber';
600             $idnumberheader->scope = 'col';
601             $idnumberheader->header = true;
602             $idnumberheader->text = $arrows['idnumber'];
604             $headerrow->cells[] = $idnumberheader;
605         }
607         $rows[] = $headerrow;
609         $rows = $this->get_left_icons_row($rows, $colspan);
611         $rowclasses = array('even', 'odd');
613         foreach ($this->users as $userid => $user) {
614             $userrow = new html_table_row();
615             $userrow->id = 'fixed_user_'.$userid;
616             $userrow->attributes['class'] = 'r'.$this->rowcount++.' '.$rowclasses[$this->rowcount % 2];
618             $usercell = new html_table_cell();
619             $usercell->attributes['class'] = 'user';
620             $usercell->header = true;
621             $usercell->scope = 'row';
623             if ($showuserimage) {
624                 $usercell->text = $OUTPUT->container($OUTPUT->user_picture($user), 'userpic');
625             }
627             $usercell->text .= html_writer::link(new moodle_url('/user/view.php', array('id' => $user->id, 'course' => $this->course->id)), fullname($user));
629             $userrow->cells[] = $usercell;
631             if (has_capability('gradereport/'.$CFG->grade_profilereport.':view', $this->context)) {
632                 $userreportcell = new html_table_cell();
633                 $userreportcell->attributes['class'] = 'userreport';
634                 $userreportcell->header = true;
635                 $a = new stdClass();
636                 $a->user = fullname($user);
637                 $strgradesforuser = get_string('gradesforuser', 'grades', $a);
638                 $url = new moodle_url('/grade/report/'.$CFG->grade_profilereport.'/index.php', array('userid' => $user->id, 'id' => $this->course->id));
639                 $userreportcell->text = $OUTPUT->action_icon($url, new pix_icon('t/grades', $strgradesforuser));
640                 $userrow->cells[] = $userreportcell;
641             }
643             if ($showuseridnumber) {
644                 $idnumbercell = new html_table_cell();
645                 $idnumbercell->attributes['class'] = 'header useridnumber';
646                 $idnumbercell->header = true;
647                 $idnumbercell->scope = 'row';
648                 $idnumbercell->text = $user->idnumber;
649                 $userrow->cells[] = $idnumbercell;
650             }
652             $rows[] = $userrow;
653         }
655         $rows = $this->get_left_range_row($rows, $colspan);
656         $rows = $this->get_left_avg_row($rows, $colspan, true);
657         $rows = $this->get_left_avg_row($rows, $colspan);
659         return $rows;
660     }
662     /**
663      * Builds and returns the rows that will make up the right part of the grader report
664      * @return array Array of html_table_row objects
665      */
666     public function get_right_rows() {
667         global $CFG, $USER, $OUTPUT, $DB, $PAGE;
669         $rows = array();
670         $this->rowcount = 0;
671         $numrows = count($this->gtree->get_levels());
672         $numusers = count($this->users);
673         $gradetabindex = 1;
674         $columnstounset = array();
675         $strgrade = $this->get_lang_string('grade');
676         $strfeedback  = $this->get_lang_string("feedback");
677         $arrows = $this->get_sort_arrows();
679         $jsarguments = array(
680             'id'        => '#fixed_column',
681             'cfg'       => array('ajaxenabled'=>false),
682             'items'     => array(),
683             'users'     => array(),
684             'feedback'  => array()
685         );
686         $jsscales = array();
688         foreach ($this->gtree->get_levels() as $key=>$row) {
689             if ($key == 0) {
690                 // do not display course grade category
691                 // continue;
692             }
694             $headingrow = new html_table_row();
695             $headingrow->attributes['class'] = 'heading_name_row';
697             foreach ($row as $columnkey => $element) {
698                 $sortlink = clone($this->baseurl);
699                 if (isset($element['object']->id)) {
700                     $sortlink->param('sortitemid', $element['object']->id);
701                 }
703                 $eid    = $element['eid'];
704                 $object = $element['object'];
705                 $type   = $element['type'];
706                 $categorystate = @$element['categorystate'];
708                 if (!empty($element['colspan'])) {
709                     $colspan = $element['colspan'];
710                 } else {
711                     $colspan = 1;
712                 }
714                 if (!empty($element['depth'])) {
715                     $catlevel = 'catlevel'.$element['depth'];
716                 } else {
717                     $catlevel = '';
718                 }
720 // Element is a filler
721                 if ($type == 'filler' or $type == 'fillerfirst' or $type == 'fillerlast') {
722                     $fillercell = new html_table_cell();
723                     $fillercell->attributes['class'] = $type . ' ' . $catlevel;
724                     $fillercell->colspan = $colspan;
725                     $fillercell->text = '&nbsp;';
726                     $fillercell->header = true;
727                     $fillercell->scope = 'col';
728                     $headingrow->cells[] = $fillercell;
729                 }
730 // Element is a category
731                 else if ($type == 'category') {
732                     $categorycell = new html_table_cell();
733                     $categorycell->attributes['class'] = 'category ' . $catlevel;
734                     $categorycell->colspan = $colspan;
735                     $categorycell->text = shorten_text($element['object']->get_name());
736                     $categorycell->text .= $this->get_collapsing_icon($element);
737                     $categorycell->header = true;
738                     $categorycell->scope = 'col';
740                     // Print icons
741                     if ($USER->gradeediting[$this->courseid]) {
742                         $categorycell->text .= $this->get_icons($element);
743                     }
745                     $headingrow->cells[] = $categorycell;
746                 }
747 // Element is a grade_item
748                 else {
749                     //$itemmodule = $element['object']->itemmodule;
750                     //$iteminstance = $element['object']->iteminstance;
752                     if ($element['object']->id == $this->sortitemid) {
753                         if ($this->sortorder == 'ASC') {
754                             $arrow = $this->get_sort_arrow('up', $sortlink);
755                         } else {
756                             $arrow = $this->get_sort_arrow('down', $sortlink);
757                         }
758                     } else {
759                         $arrow = $this->get_sort_arrow('move', $sortlink);
760                     }
762                     $headerlink = $this->gtree->get_element_header($element, true, $this->get_pref('showactivityicons'), false);
764                     $itemcell = new html_table_cell();
765                     $itemcell->attributes['class'] = $type . ' ' . $catlevel . 'highlightable';
767                     if ($element['object']->is_hidden()) {
768                         $itemcell->attributes['class'] .= ' hidden';
769                     }
771                     $itemcell->colspan = $colspan;
772                     $itemcell->text = shorten_text($headerlink) . $arrow;
773                     $itemcell->header = true;
774                     $itemcell->scope = 'col';
776                     $headingrow->cells[] = $itemcell;
777                 }
778             }
779             $rows[] = $headingrow;
780         }
782         $rows = $this->get_right_icons_row($rows);
784         // Preload scale objects for items with a scaleid
785         $scaleslist = array();
786         $tabindices = array();
788         foreach ($this->gtree->get_items() as $itemid=>$item) {
789             $scale = null;
790             if (!empty($item->scaleid)) {
791                 $scaleslist[] = $item->scaleid;
792                 $jsarguments['items'][$itemid] = array('id'=>$itemid, 'name'=>$item->get_name(true), 'type'=>'scale', 'scale'=>$item->scaleid, 'decimals'=>$item->get_decimals());
793             } else {
794                 $jsarguments['items'][$itemid] = array('id'=>$itemid, 'name'=>$item->get_name(true), 'type'=>'value', 'scale'=>false, 'decimals'=>$item->get_decimals());
795             }
796             $tabindices[$item->id]['grade'] = $gradetabindex;
797             $tabindices[$item->id]['feedback'] = $gradetabindex + $numusers;
798             $gradetabindex += $numusers * 2;
799         }
800         $scalesarray = array();
802         if (!empty($scaleslist)) {
803             $scalesarray = $DB->get_records_list('scale', 'id', $scaleslist);
804         }
805         $jsscales = $scalesarray;
807         $rowclasses = array('even', 'odd');
809         foreach ($this->users as $userid => $user) {
811             if ($this->canviewhidden) {
812                 $altered = array();
813                 $unknown = array();
814             } else {
815                 $hidingaffected = grade_grade::get_hiding_affected($this->grades[$userid], $this->gtree->get_items());
816                 $altered = $hidingaffected['altered'];
817                 $unknown = $hidingaffected['unknown'];
818                 unset($hidingaffected);
819             }
822             $itemrow = new html_table_row();
823             $itemrow->id = 'user_'.$userid;
824             $itemrow->attributes['class'] = $rowclasses[$this->rowcount % 2];
826             $jsarguments['users'][$userid] = fullname($user);
828             foreach ($this->gtree->items as $itemid=>$unused) {
829                 $item =& $this->gtree->items[$itemid];
830                 $grade = $this->grades[$userid][$item->id];
832                 $itemcell = new html_table_cell();
834                 $itemcell->id = 'u'.$userid.'i'.$itemid;
836                 // Get the decimal points preference for this item
837                 $decimalpoints = $item->get_decimals();
839                 if (in_array($itemid, $unknown)) {
840                     $gradeval = null;
841                 } else if (array_key_exists($itemid, $altered)) {
842                     $gradeval = $altered[$itemid];
843                 } else {
844                     $gradeval = $grade->finalgrade;
845                 }
847                 // MDL-11274
848                 // Hide grades in the grader report if the current grader doesn't have 'moodle/grade:viewhidden'
849                 if (!$this->canviewhidden and $grade->is_hidden()) {
850                     if (!empty($CFG->grade_hiddenasdate) and $grade->get_datesubmitted() and !$item->is_category_item() and !$item->is_course_item()) {
851                         // 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
852                         $itemcell->text = html_writer::tag('span', userdate($grade->get_datesubmitted(),get_string('strftimedatetimeshort')), array('class'=>'datesubmitted'));
853                     } else {
854                         $itemcell->text = '-';
855                     }
856                     $itemrow->cells[] = $itemcell;
857                     continue;
858                 }
860                 // emulate grade element
861                 $eid = $this->gtree->get_grade_eid($grade);
862                 $element = array('eid'=>$eid, 'object'=>$grade, 'type'=>'grade');
864                 $itemcell->attributes['class'] .= ' grade';
865                 if ($item->is_category_item()) {
866                     $itemcell->attributes['class'] .= ' cat';
867                 }
868                 if ($item->is_course_item()) {
869                     $itemcell->attributes['class'] .= ' course';
870                 }
871                 if ($grade->is_overridden()) {
872                     $itemcell->attributes['class'] .= ' overridden';
873                 }
875                 if ($grade->is_excluded()) {
876                     // $itemcell->attributes['class'] .= ' excluded';
877                 }
879                 if (!empty($grade->feedback)) {
880                     //should we be truncating feedback? ie $short_feedback = shorten_text($feedback, $this->feedback_trunc_length);
881                     $jsarguments['feedback'][] = array('user'=>$userid, 'item'=>$itemid, 'content'=>wordwrap(trim(format_string($grade->feedback, $grade->feedbackformat)), 34, '<br/ >'));
882                 }
884                 if ($grade->is_excluded()) {
885                     $itemcell->text .= html_writer::tag('span', get_string('excluded', 'grades'), array('class'=>'excludedfloater'));
886                 }
888                 // Do not show any icons if no grade (no record in DB to match)
889                 if (!$item->needsupdate and $USER->gradeediting[$this->courseid]) {
890                     $itemcell->text .= $this->get_icons($element);
891                 }
893                 $hidden = '';
894                 if ($grade->is_hidden()) {
895                     $hidden = ' hidden ';
896                 }
898                 $gradepass = ' gradefail ';
899                 if ($grade->is_passed($item)) {
900                     $gradepass = ' gradepass ';
901                 } elseif (is_null($grade->is_passed($item))) {
902                     $gradepass = '';
903                 }
905                 // if in editing mode, we need to print either a text box
906                 // or a drop down (for scales)
907                 // grades in item of type grade category or course are not directly editable
908                 if ($item->needsupdate) {
909                     $itemcell->text .= html_writer::tag('span', get_string('error'), array('class'=>"gradingerror$hidden"));
911                 } else if ($USER->gradeediting[$this->courseid]) {
913                     if ($item->scaleid && !empty($scalesarray[$item->scaleid])) {
914                         $scale = $scalesarray[$item->scaleid];
915                         $gradeval = (int)$gradeval; // scales use only integers
916                         $scales = explode(",", $scale->scale);
917                         // reindex because scale is off 1
919                         // MDL-12104 some previous scales might have taken up part of the array
920                         // so this needs to be reset
921                         $scaleopt = array();
922                         $i = 0;
923                         foreach ($scales as $scaleoption) {
924                             $i++;
925                             $scaleopt[$i] = $scaleoption;
926                         }
928                         if ($this->get_pref('quickgrading') and $grade->is_editable()) {
929                             $oldval = empty($gradeval) ? -1 : $gradeval;
930                             if (empty($item->outcomeid)) {
931                                 $nogradestr = $this->get_lang_string('nograde');
932                             } else {
933                                 $nogradestr = $this->get_lang_string('nooutcome', 'grades');
934                             }
935                             $itemcell->text .= '<input type="hidden" id="oldgrade_'.$userid.'_'.$item->id.'" name="oldgrade_'.$userid.'_'.$item->id.'" value="'.$oldval.'"/>';
936                             $attributes = array('tabindex' => $tabindices[$item->id]['grade'], 'id'=>'grade_'.$userid.'_'.$item->id);
937                             $itemcell->text .= html_writer::select($scaleopt, 'grade_'.$userid.'_'.$item->id, $gradeval, array(-1=>$nogradestr), $attributes);;
938                         } elseif(!empty($scale)) {
939                             $scales = explode(",", $scale->scale);
941                             // invalid grade if gradeval < 1
942                             if ($gradeval < 1) {
943                                 $itemcell->text .= html_writer::tag('span', '-', array('class'=>"gradevalue$hidden$gradepass"));
944                             } else {
945                                 $gradeval = $grade->grade_item->bounded_grade($gradeval); //just in case somebody changes scale
946                                 $itemcell->text .= html_writer::tag('span', $scales[$gradeval-1], array('class'=>"gradevalue$hidden$gradepass"));
947                             }
948                         } else {
949                             // no such scale, throw error?
950                         }
952                     } else if ($item->gradetype != GRADE_TYPE_TEXT) { // Value type
953                         if ($this->get_pref('quickgrading') and $grade->is_editable()) {
954                             $value = format_float($gradeval, $decimalpoints);
955                             $itemcell->text .= '<input type="hidden" id="oldgrade_'.$userid.'_'.$item->id.'" name="oldgrade_'.$userid.'_'.$item->id.'" value="'.$value.'" />';
956                             $itemcell->text .= '<input size="6" tabindex="' . $tabindices[$item->id]['grade']
957                                           . '" type="text" class="text" title="'. $strgrade .'" name="grade_'
958                                           .$userid.'_' .$item->id.'" id="grade_'.$userid.'_'.$item->id.'" value="'.$value.'" />';
959                         } else {
960                             $itemcell->text .= html_writer::tag('span', format_float($gradeval, $decimalpoints), array('class'=>"gradevalue$hidden$gradepass"));
961                         }
962                     }
965                     // If quickfeedback is on, print an input element
966                     if ($this->get_pref('showquickfeedback') and $grade->is_editable()) {
968                         $itemcell->text .= '<input type="hidden" id="oldfeedback_'.$userid.'_'.$item->id.'" name="oldfeedback_'.$userid.'_'.$item->id.'" value="' . s($grade->feedback) . '" />';
969                         $itemcell->text .= '<input class="quickfeedback" tabindex="' . $tabindices[$item->id]['feedback'].'" id="feedback_'.$userid.'_'.$item->id
970                                       . '" size="6" title="' . $strfeedback . '" type="text" name="feedback_'.$userid.'_'.$item->id.'" value="' . s($grade->feedback) . '" />';
971                     }
973                 } else { // Not editing
974                     $gradedisplaytype = $item->get_displaytype();
976                     if ($item->scaleid && !empty($scalesarray[$item->scaleid])) {
977                         $itemcell->attributes['class'] .= ' grade_type_scale';
978                     } else if ($item->gradetype != GRADE_TYPE_TEXT) {
979                         $itemcell->attributes['class'] .= ' grade_type_text';
980                     }
982                     if ($this->get_pref('enableajax')) {
983                         $itemcell->attributes['class'] .= ' clickable';
984                     }
986                     if ($item->needsupdate) {
987                         $itemcell->text .= html_writer::tag('span', get_string('error'), array('class'=>"gradingerror$hidden$gradepass"));
988                     } else {
989                         $itemcell->text .= html_writer::tag('span', grade_format_gradevalue($gradeval, $item, true, $gradedisplaytype, null), array('class'=>"gradevalue$hidden$gradepass"));
990                     }
991                 }
993                 if (!empty($this->gradeserror[$item->id][$userid])) {
994                     $itemcell->text .= $this->gradeserror[$item->id][$userid];
995                 }
997                 $itemrow->cells[] = $itemcell;
998             }
999             $rows[] = $itemrow;
1000         }
1002         if ($this->get_pref('enableajax')) {
1003             $jsarguments['cfg']['ajaxenabled'] = true;
1004             $jsarguments['cfg']['scales'] = array();
1005             foreach ($jsscales as $scale) {
1006                 $jsarguments['cfg']['scales'][$scale->id] = explode(',',$scale->scale);
1007             }
1008             $jsarguments['cfg']['feedbacktrunclength'] =  $this->feedback_trunc_length;
1010             //feedbacks are now being stored in $jsarguments['feedback'] in get_right_rows()
1011             //$jsarguments['cfg']['feedback'] =  $this->feedbacks;
1012         }
1013         $jsarguments['cfg']['isediting'] = (bool)$USER->gradeediting[$this->courseid];
1014         $jsarguments['cfg']['courseid'] =  $this->courseid;
1015         $jsarguments['cfg']['studentsperpage'] =  $this->get_pref('studentsperpage');
1016         $jsarguments['cfg']['showquickfeedback'] =  (bool)$this->get_pref('showquickfeedback');
1018         $module = array(
1019             'name'      => 'gradereport_grader',
1020             'fullpath'  => '/grade/report/grader/module.js',
1021             'requires'  => array('base', 'dom', 'event', 'event-mouseenter', 'event-key', 'io', 'json-parse', 'overlay')
1022         );
1023         $PAGE->requires->js_init_call('M.gradereport_grader.init_report', $jsarguments, false, $module);
1024         $PAGE->requires->strings_for_js(array('addfeedback','feedback', 'grade'), 'grades');
1025         $PAGE->requires->strings_for_js(array('ajaxchoosescale','ajaxclicktoclose','ajaxerror','ajaxfailedupdate', 'ajaxfieldchanged'), 'gradereport_grader');
1027         $rows = $this->get_right_range_row($rows);
1028         $rows = $this->get_right_avg_row($rows, true);
1029         $rows = $this->get_right_avg_row($rows);
1031         return $rows;
1032     }
1034     /**
1035      * Depending on the style of report (fixedstudents vs traditional one-table),
1036      * arranges the rows of data in one or two tables, and returns the output of
1037      * these tables in HTML
1038      * @return string HTML
1039      */
1040     public function get_grade_table() {
1041         global $OUTPUT;
1042         $fixedstudents = $this->is_fixed_students();
1044         $leftrows = $this->get_left_rows();
1045         $rightrows = $this->get_right_rows();
1047         $html = '';
1050         if ($fixedstudents) {
1051             $fixedcolumntable = new html_table();
1052             $fixedcolumntable->id = 'fixed_column';
1053             $fixedcolumntable->data = $leftrows;
1054             $html .= $OUTPUT->container(html_writer::table($fixedcolumntable), 'left_scroller');
1056             $righttable = new html_table();
1057             $righttable->id = 'user-grades';
1058             $righttable->data = $rightrows;
1060             $html .= $OUTPUT->container(html_writer::table($righttable), 'right_scroller');
1061         } else {
1062             $fulltable = new html_table();
1063             $fulltable->attributes['class'] = 'gradestable flexible boxaligncenter generaltable';
1064             $fulltable->id = 'user-grades';
1066             // Extract rows from each side (left and right) and collate them into one row each
1067             foreach ($leftrows as $key => $row) {
1068                 $row->cells = array_merge($row->cells, $rightrows[$key]->cells);
1069                 $fulltable->data[] = $row;
1070             }
1071             $html .= html_writer::table($fulltable);
1072         }
1073         return $OUTPUT->container($html, 'gradeparent');
1074     }
1076     /**
1077      * Builds and return the row of icons for the left side of the report.
1078      * It only has one cell that says "Controls"
1079      * @param array $rows The Array of rows for the left part of the report
1080      * @param int $colspan The number of columns this cell has to span
1081      * @return array Array of rows for the left part of the report
1082      */
1083     public function get_left_icons_row($rows=array(), $colspan=1) {
1084         global $USER;
1086         if ($USER->gradeediting[$this->courseid]) {
1087             $controlsrow = new html_table_row();
1088             $controlsrow->attributes['class'] = 'controls';
1089             $controlscell = new html_table_cell();
1090             $controlscell->attributes['class'] = 'header controls';
1091             $controlscell->colspan = $colspan;
1092             $controlscell->text = $this->get_lang_string('controls','grades');
1094             $controlsrow->cells[] = $controlscell;
1095             $rows[] = $controlsrow;
1096         }
1097         return $rows;
1098     }
1100     /**
1101      * Builds and return the header for the row of ranges, for the left part of the grader report.
1102      * @param array $rows The Array of rows for the left part of the report
1103      * @param int $colspan The number of columns this cell has to span
1104      * @return array Array of rows for the left part of the report
1105      */
1106     public function get_left_range_row($rows=array(), $colspan=1) {
1107         global $CFG, $USER;
1109         if ($this->get_pref('showranges')) {
1110             $rangerow = new html_table_row();
1111             $rangerow->attributes['class'] = 'range r'.$this->rowcount++;
1112             $rangecell = new html_table_cell();
1113             $rangecell->attributes['class'] = 'header range';
1114             $rangecell->colspan = $colspan;
1115             $rangecell->header = true;
1116             $rangecell->scope = 'row';
1117             $rangecell->text = $this->get_lang_string('range','grades');
1118             $rangerow->cells[] = $rangecell;
1119             $rows[] = $rangerow;
1120         }
1122         return $rows;
1123     }
1125     /**
1126      * Builds and return the headers for the rows of averages, for the left part of the grader report.
1127      * @param array $rows The Array of rows for the left part of the report
1128      * @param int $colspan The number of columns this cell has to span
1129      * @param bool $groupavg If true, returns the row for group averages, otherwise for overall averages
1130      * @return array Array of rows for the left part of the report
1131      */
1132     public function get_left_avg_row($rows=array(), $colspan=1, $groupavg=false) {
1133         if (!$this->canviewhidden) {
1134             // totals might be affected by hiding, if user can not see hidden grades the aggregations might be altered
1135             // better not show them at all if user can not see all hideen grades
1136             return $rows;
1137         }
1139         $showaverages = $this->get_pref('showaverages');
1140         $showaveragesgroup = $this->currentgroup && $showaverages;
1141         $straveragegroup = get_string('groupavg', 'grades');
1143         if ($groupavg) {
1144             if ($showaveragesgroup) {
1145                 $groupavgrow = new html_table_row();
1146                 $groupavgrow->attributes['class'] = 'groupavg r'.$this->rowcount++;
1147                 $groupavgcell = new html_table_cell();
1148                 $groupavgcell->attributes['class'] = 'header range';
1149                 $groupavgcell->colspan = $colspan;
1150                 $groupavgcell->header = true;
1151                 $groupavgcell->scope = 'row';
1152                 $groupavgcell->text = $straveragegroup;
1153                 $groupavgrow->cells[] = $groupavgcell;
1154                 $rows[] = $groupavgrow;
1155             }
1156         } else {
1157             $straverage = get_string('overallaverage', 'grades');
1159             if ($showaverages) {
1160                 $avgrow = new html_table_row();
1161                 $avgrow->attributes['class'] = 'avg r'.$this->rowcount++;
1162                 $avgcell = new html_table_cell();
1163                 $avgcell->attributes['class'] = 'header range';
1164                 $avgcell->colspan = $colspan;
1165                 $avgcell->header = true;
1166                 $avgcell->scope = 'row';
1167                 $avgcell->text = $straverage;
1168                 $avgrow->cells[] = $avgcell;
1169                 $rows[] = $avgrow;
1170             }
1171         }
1173         return $rows;
1174     }
1176     /**
1177      * Builds and return the row of icons when editing is on, for the right part of the grader report.
1178      * @param array $rows The Array of rows for the right part of the report
1179      * @return array Array of rows for the right part of the report
1180      */
1181     public function get_right_icons_row($rows=array()) {
1182         global $USER;
1183         if ($USER->gradeediting[$this->courseid]) {
1184             $iconsrow = new html_table_row();
1185             $iconsrow->attributes['class'] = 'controls';
1187             $showuseridnumber = $this->get_pref('showuseridnumber');
1189             foreach ($this->gtree->items as $itemid=>$unused) {
1190                 // emulate grade element
1191                 $item =& $this->gtree->get_item($itemid);
1193                 $eid = $this->gtree->get_item_eid($item);
1194                 $element = $this->gtree->locate_element($eid);
1195                 $itemcell = new html_table_cell();
1196                 $itemcell->attributes['class'] = 'controls icons';
1197                 $itemcell->text = $this->get_icons($element);
1198                 $iconsrow->cells[] = $itemcell;
1199             }
1200             $rows[] = $iconsrow;
1201         }
1202         return $rows;
1203     }
1205     /**
1206      * Builds and return the row of ranges for the right part of the grader report.
1207      * @param array $rows The Array of rows for the right part of the report
1208      * @return array Array of rows for the right part of the report
1209      */
1210     public function get_right_range_row($rows=array()) {
1211         global $OUTPUT;
1213         if ($this->get_pref('showranges')) {
1214             $rangesdisplaytype   = $this->get_pref('rangesdisplaytype');
1215             $rangesdecimalpoints = $this->get_pref('rangesdecimalpoints');
1216             $rangerow = new html_table_row();
1217             $rangerow->attributes['class'] = 'heading range';
1219             foreach ($this->gtree->items as $itemid=>$unused) {
1220                 $item =& $this->gtree->items[$itemid];
1221                 $itemcell = new html_table_cell();
1222                 $itemcell->header = true;
1223                 $itemcell->attributes['class'] .= ' header range';
1225                 $hidden = '';
1226                 if ($item->is_hidden()) {
1227                     $hidden = ' hidden ';
1228                 }
1230                 $formattedrange = $item->get_formatted_range($rangesdisplaytype, $rangesdecimalpoints);
1232                 $itemcell->text = $OUTPUT->container($formattedrange, 'rangevalues'.$hidden);
1233                 $rangerow->cells[] = $itemcell;
1234             }
1235             $rows[] = $rangerow;
1236         }
1237         return $rows;
1238     }
1240     /**
1241      * Builds and return the row of averages for the right part of the grader report.
1242      * @param array $rows Whether to return only group averages or all averages.
1243      * @param bool $grouponly Whether to return only group averages or all averages.
1244      * @return array Array of rows for the right part of the report
1245      */
1246     public function get_right_avg_row($rows=array(), $grouponly=false) {
1247         global $CFG, $USER, $DB, $OUTPUT;
1249         if (!$this->canviewhidden) {
1250             // totals might be affected by hiding, if user can not see hidden grades the aggregations might be altered
1251             // better not show them at all if user can not see all hidden grades
1252             return $rows;
1253         }
1255         $showaverages = $this->get_pref('showaverages');
1256         $showaveragesgroup = $this->currentgroup && $showaverages;
1258         $averagesdisplaytype   = $this->get_pref('averagesdisplaytype');
1259         $averagesdecimalpoints = $this->get_pref('averagesdecimalpoints');
1260         $meanselection         = $this->get_pref('meanselection');
1261         $shownumberofgrades    = $this->get_pref('shownumberofgrades');
1263         $avghtml = '';
1264         $avgcssclass = 'avg';
1266         if ($grouponly) {
1267             $straverage = get_string('groupavg', 'grades');
1268             $showaverages = $this->currentgroup && $this->get_pref('showaverages');
1269             $groupsql = $this->groupsql;
1270             $groupwheresql = $this->groupwheresql;
1271             $groupwheresqlparams = $this->groupwheresql_params;
1272             $avgcssclass = 'groupavg';
1273         } else {
1274             $straverage = get_string('overallaverage', 'grades');
1275             $showaverages = $this->get_pref('showaverages');
1276             $groupsql = "";
1277             $groupwheresql = "";
1278             $groupwheresqlparams = array();
1279         }
1281         if ($shownumberofgrades) {
1282             $straverage .= ' (' . get_string('submissions', 'grades') . ') ';
1283         }
1285         $totalcount = $this->get_numusers($grouponly);
1287         //limit to users with a gradeable role
1288         list($gradebookrolessql, $gradebookrolesparams) = $DB->get_in_or_equal(explode(',', $this->gradebookroles), SQL_PARAMS_NAMED, 'grbr0');
1290         //limit to users with an active enrollment
1291         list($enrolledsql, $enrolledparams) = get_enrolled_sql($this->context);
1293         if ($showaverages) {
1294             $params = array_merge(array('courseid'=>$this->courseid), $gradebookrolesparams, $enrolledparams, $groupwheresqlparams);
1296             // find sums of all grade items in course
1297             $SQL = "SELECT g.itemid, SUM(g.finalgrade) AS sum
1298                       FROM {grade_items} gi
1299                       JOIN {grade_grades} g
1300                            ON g.itemid = gi.id
1301                       JOIN {user} u
1302                            ON u.id = g.userid
1303                       JOIN ($enrolledsql) je
1304                            ON je.id = u.id
1305                       JOIN {role_assignments} ra
1306                            ON ra.userid = u.id
1307                       $groupsql
1308                      WHERE gi.courseid = :courseid
1309                            AND ra.roleid $gradebookrolessql
1310                            AND ra.contextid ".get_related_contexts_string($this->context)."
1311                            AND g.finalgrade IS NOT NULL
1312                            $groupwheresql
1313                   GROUP BY g.itemid";
1314             $sumarray = array();
1315             if ($sums = $DB->get_records_sql($SQL, $params)) {
1316                 foreach ($sums as $itemid => $csum) {
1317                     $sumarray[$itemid] = $csum->sum;
1318                 }
1319             }
1321             // MDL-10875 Empty grades must be evaluated as grademin, NOT always 0
1322             // This query returns a count of ungraded grades (NULL finalgrade OR no matching record in grade_grades table)
1323             $SQL = "SELECT gi.id, COUNT(u.id) AS count
1324                       FROM {grade_items} gi
1325                       CROSS JOIN {user} u
1326                       JOIN ($enrolledsql) je
1327                            ON je.id = u.id
1328                       JOIN {role_assignments} ra
1329                            ON ra.userid = u.id
1330                       LEFT OUTER JOIN {grade_grades} g
1331                            ON (g.itemid = gi.id AND g.userid = u.id AND g.finalgrade IS NOT NULL)
1332                       $groupsql
1333                      WHERE gi.courseid = :courseid
1334                            AND ra.roleid $gradebookrolessql
1335                            AND ra.contextid ".get_related_contexts_string($this->context)."
1336                            AND g.id IS NULL
1337                            $groupwheresql
1338                   GROUP BY gi.id";
1340             $ungradedcounts = $DB->get_records_sql($SQL, $params);
1342             $avgrow = new html_table_row();
1343             $avgrow->attributes['class'] = 'avg';
1345             foreach ($this->gtree->items as $itemid=>$unused) {
1346                 $item =& $this->gtree->items[$itemid];
1348                 if ($item->needsupdate) {
1349                     $avgcell = new html_table_cell();
1350                     $avgcell->text = $OUTPUT->container(get_string('error'), 'gradingerror');
1351                     $avgrow->cells[] = $avgcell;
1352                     continue;
1353                 }
1355                 if (!isset($sumarray[$item->id])) {
1356                     $sumarray[$item->id] = 0;
1357                 }
1359                 if (empty($ungradedcounts[$itemid])) {
1360                     $ungradedcount = 0;
1361                 } else {
1362                     $ungradedcount = $ungradedcounts[$itemid]->count;
1363                 }
1365                 if ($meanselection == GRADE_REPORT_MEAN_GRADED) {
1366                     $meancount = $totalcount - $ungradedcount;
1367                 } else { // Bump up the sum by the number of ungraded items * grademin
1368                     $sumarray[$item->id] += $ungradedcount * $item->grademin;
1369                     $meancount = $totalcount;
1370                 }
1372                 $decimalpoints = $item->get_decimals();
1374                 // Determine which display type to use for this average
1375                 if ($USER->gradeediting[$this->courseid]) {
1376                     $displaytype = GRADE_DISPLAY_TYPE_REAL;
1378                 } else if ($averagesdisplaytype == GRADE_REPORT_PREFERENCE_INHERIT) { // no ==0 here, please resave the report and user preferences
1379                     $displaytype = $item->get_displaytype();
1381                 } else {
1382                     $displaytype = $averagesdisplaytype;
1383                 }
1385                 // Override grade_item setting if a display preference (not inherit) was set for the averages
1386                 if ($averagesdecimalpoints == GRADE_REPORT_PREFERENCE_INHERIT) {
1387                     $decimalpoints = $item->get_decimals();
1389                 } else {
1390                     $decimalpoints = $averagesdecimalpoints;
1391                 }
1393                 if (!isset($sumarray[$item->id]) || $meancount == 0) {
1394                     $avgcell = new html_table_cell();
1395                     $avgcell->text = '-';
1396                     $avgrow->cells[] = $avgcell;
1398                 } else {
1399                     $sum = $sumarray[$item->id];
1400                     $avgradeval = $sum/$meancount;
1401                     $gradehtml = grade_format_gradevalue($avgradeval, $item, true, $displaytype, $decimalpoints);
1403                     $numberofgrades = '';
1404                     if ($shownumberofgrades) {
1405                         $numberofgrades = " ($meancount)";
1406                     }
1408                     $avgcell = new html_table_cell();
1409                     $avgcell->text = $gradehtml.$numberofgrades;
1410                     $avgrow->cells[] = $avgcell;
1411                 }
1412             }
1413             $rows[] = $avgrow;
1414         }
1415         return $rows;
1416     }
1418     /**
1419      * Given a grade_category, grade_item or grade_grade, this function
1420      * figures out the state of the object and builds then returns a div
1421      * with the icons needed for the grader report.
1422      *
1423      * @param object $object
1424      * @return string HTML
1425      */
1426     protected function get_icons($element) {
1427         global $CFG, $USER, $OUTPUT;
1429         if (!$USER->gradeediting[$this->courseid]) {
1430             return '<div class="grade_icons" />';
1431         }
1433         // Init all icons
1434         $editicon = '';
1436         if ($element['type'] != 'categoryitem' && $element['type'] != 'courseitem') {
1437             $editicon = $this->gtree->get_edit_icon($element, $this->gpr);
1438         }
1440         $editcalculationicon = '';
1441         $showhideicon        = '';
1442         $lockunlockicon      = '';
1444         if (has_capability('moodle/grade:manage', $this->context)) {
1446             if ($this->get_pref('showcalculations')) {
1447                 $editcalculationicon = $this->gtree->get_calculation_icon($element, $this->gpr);
1448             }
1450             if ($this->get_pref('showeyecons')) {
1451                $showhideicon = $this->gtree->get_hiding_icon($element, $this->gpr);
1452             }
1454             if ($this->get_pref('showlocks')) {
1455                 $lockunlockicon = $this->gtree->get_locking_icon($element, $this->gpr);
1456             }
1457         }
1459         return $OUTPUT->container($editicon.$editcalculationicon.$showhideicon.$lockunlockicon, 'grade_icons');
1460     }
1462     /**
1463      * Given a category element returns collapsing +/- icon if available
1464      * @param object $object
1465      * @return string HTML
1466      */
1467     protected function get_collapsing_icon($element) {
1468         global $OUTPUT;
1470         $icon = '';
1471         // If object is a category, display expand/contract icon
1472         if ($element['type'] == 'category') {
1473             // Load language strings
1474             $strswitchminus = $this->get_lang_string('aggregatesonly', 'grades');
1475             $strswitchplus  = $this->get_lang_string('gradesonly', 'grades');
1476             $strswitchwhole = $this->get_lang_string('fullmode', 'grades');
1478             $url = new moodle_url($this->gpr->get_return_url(null, array('target'=>$element['eid'], 'sesskey'=>sesskey())));
1480             if (in_array($element['object']->id, $this->collapsed['aggregatesonly'])) {
1481                 $url->param('action', 'switch_plus');
1482                 $icon = $OUTPUT->action_icon($url, new pix_icon('t/switch_plus', $strswitchplus));
1484             } else if (in_array($element['object']->id, $this->collapsed['gradesonly'])) {
1485                 $url->param('action', 'switch_whole');
1486                 $icon = $OUTPUT->action_icon($url, new pix_icon('t/switch_whole', $strswitchwhole));
1488             } else {
1489                 $url->param('action', 'switch_minus');
1490                 $icon = $OUTPUT->action_icon($url, new pix_icon('t/switch_minus', $strswitchminus));
1491             }
1492         }
1493         return $icon;
1494     }
1496     /**
1497      * Processes a single action against a category, grade_item or grade.
1498      * @param string $target eid ({type}{id}, e.g. c4 for category4)
1499      * @param string $action Which action to take (edit, delete etc...)
1500      * @return
1501      */
1502     public function process_action($target, $action) {
1503         // TODO: this code should be in some grade_tree static method
1504         $targettype = substr($target, 0, 1);
1505         $targetid = substr($target, 1);
1506         // TODO: end
1508         if ($collapsed = get_user_preferences('grade_report_grader_collapsed_categories')) {
1509             $collapsed = unserialize($collapsed);
1510         } else {
1511             $collapsed = array('aggregatesonly' => array(), 'gradesonly' => array());
1512         }
1514         switch ($action) {
1515             case 'switch_minus': // Add category to array of aggregatesonly
1516                 if (!in_array($targetid, $collapsed['aggregatesonly'])) {
1517                     $collapsed['aggregatesonly'][] = $targetid;
1518                     set_user_preference('grade_report_grader_collapsed_categories', serialize($collapsed));
1519                 }
1520                 break;
1522             case 'switch_plus': // Remove category from array of aggregatesonly, and add it to array of gradesonly
1523                 $key = array_search($targetid, $collapsed['aggregatesonly']);
1524                 if ($key !== false) {
1525                     unset($collapsed['aggregatesonly'][$key]);
1526                 }
1527                 if (!in_array($targetid, $collapsed['gradesonly'])) {
1528                     $collapsed['gradesonly'][] = $targetid;
1529                 }
1530                 set_user_preference('grade_report_grader_collapsed_categories', serialize($collapsed));
1531                 break;
1532             case 'switch_whole': // Remove the category from the array of collapsed cats
1533                 $key = array_search($targetid, $collapsed['gradesonly']);
1534                 if ($key !== false) {
1535                     unset($collapsed['gradesonly'][$key]);
1536                     set_user_preference('grade_report_grader_collapsed_categories', serialize($collapsed));
1537                 }
1539                 break;
1540             default:
1541                 break;
1542         }
1544         return true;
1545     }
1547     /**
1548      * Returns whether or not to display fixed students column.
1549      * Includes a browser check, because IE6 doesn't support the scrollbar.
1550      *
1551      * @return bool
1552      */
1553     public function is_fixed_students() {
1554         global $USER, $CFG;
1555         return empty($USER->screenreader) && $CFG->grade_report_fixedstudents &&
1556             (check_browser_version('MSIE', '7.0') ||
1557              check_browser_version('Firefox', '2.0') ||
1558              check_browser_version('Gecko', '2006010100') ||
1559              check_browser_version('Camino', '1.0') ||
1560              check_browser_version('Opera', '6.0') ||
1561              check_browser_version('Chrome', '6') ||
1562              check_browser_version('Safari', '300'));
1563     }
1565     /**
1566      * Refactored function for generating HTML of sorting links with matching arrows.
1567      * Returns an array with 'studentname' and 'idnumber' as keys, with HTML ready
1568      * to inject into a table header cell.
1569      * @return array An associative array of HTML sorting links+arrows
1570      */
1571     public function get_sort_arrows() {
1572         global $OUTPUT;
1573         $arrows = array();
1575         $strsortasc   = $this->get_lang_string('sortasc', 'grades');
1576         $strsortdesc  = $this->get_lang_string('sortdesc', 'grades');
1577         $strfirstname = $this->get_lang_string('firstname');
1578         $strlastname  = $this->get_lang_string('lastname');
1580         $firstlink = html_writer::link(new moodle_url($this->baseurl, array('sortitemid'=>'firstname')), $strfirstname);
1581         $lastlink = html_writer::link(new moodle_url($this->baseurl, array('sortitemid'=>'lastname')), $strlastname);
1582         $idnumberlink = html_writer::link(new moodle_url($this->baseurl, array('sortitemid'=>'idnumber')), get_string('idnumber'));
1584         $arrows['studentname'] = $lastlink;
1586         if ($this->sortitemid === 'lastname') {
1587             if ($this->sortorder == 'ASC') {
1588                 $arrows['studentname'] .= print_arrow('up', $strsortasc, true);
1589             } else {
1590                 $arrows['studentname'] .= print_arrow('down', $strsortdesc, true);
1591             }
1592         }
1594         $arrows['studentname'] .= ' ' . $firstlink;
1596         if ($this->sortitemid === 'firstname') {
1597             if ($this->sortorder == 'ASC') {
1598                 $arrows['studentname'] .= print_arrow('up', $strsortasc, true);
1599             } else {
1600                 $arrows['studentname'] .= print_arrow('down', $strsortdesc, true);
1601             }
1602         }
1604         $arrows['idnumber'] = $idnumberlink;
1606         if ('idnumber' == $this->sortitemid) {
1607             if ($this->sortorder == 'ASC') {
1608                 $arrows['idnumber'] .= print_arrow('up', $strsortasc, true);
1609             } else {
1610                 $arrows['idnumber'] .= print_arrow('down', $strsortdesc, true);
1611             }
1612         }
1614         return $arrows;
1615     }