Merge branch 'MDL-35206-email-links' of git://github.com/mudrd8mz/moodle
[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', context_course::instance($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         $studentsperpage = $this->get_students_per_page();
141         if (!empty($this->page) && !empty($studentsperpage)) {
142             $this->baseurl->params(array('perpage' => $studentsperpage, 'page' => $this->page));
143         }
145         $this->pbarurl = new moodle_url('/grade/report/grader/index.php', array('id' => $this->courseid));
147         $this->setup_groups();
149         $this->setup_sortitemid();
150     }
152     /**
153      * Processes the data sent by the form (grades and feedbacks).
154      * Caller is responsible for all access control checks
155      * @param array $data form submission (with magic quotes)
156      * @return array empty array if success, array of warnings if something fails.
157      */
158     public function process_data($data) {
159         global $DB;
160         $warnings = array();
162         $separategroups = false;
163         $mygroups       = array();
164         if ($this->groupmode == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $this->context)) {
165             $separategroups = true;
166             $mygroups = groups_get_user_groups($this->course->id);
167             $mygroups = $mygroups[0]; // ignore groupings
168             // reorder the groups fro better perf below
169             $current = array_search($this->currentgroup, $mygroups);
170             if ($current !== false) {
171                 unset($mygroups[$current]);
172                 array_unshift($mygroups, $this->currentgroup);
173             }
174         }
176         // always initialize all arrays
177         $queue = array();
178         $this->load_users();
179         $this->load_final_grades();
181         // Were any changes made?
182         $changedgrades = false;
184         foreach ($data as $varname => $students) {
186             $needsupdate = false;
188             // skip, not a grade nor feedback
189             if (strpos($varname, 'grade') === 0) {
190                 $datatype = 'grade';
191             } else if (strpos($varname, 'feedback') === 0) {
192                 $datatype = 'feedback';
193             } else {
194                 continue;
195             }
197             foreach ($students as $userid => $items) {
198                 $userid = clean_param($userid, PARAM_INT);
199                 foreach ($items as $itemid => $postedvalue) {
200                     $itemid = clean_param($itemid, PARAM_INT);
202                     // Was change requested?
203                     $oldvalue = $this->grades[$userid][$itemid];
204                     if ($datatype === 'grade') {
205                         // If there was no grade and there still isn't
206                         if (is_null($oldvalue->finalgrade) && $postedvalue == -1) {
207                             // -1 means no grade
208                             continue;
209                         }
211                         // If the grade item uses a custom scale
212                         if (!empty($oldvalue->grade_item->scaleid)) {
214                             if ((int)$oldvalue->finalgrade === (int)$postedvalue) {
215                                 continue;
216                             }
217                         } else {
218                             // The grade item uses a numeric scale
220                             // Format the finalgrade from the DB so that it matches the grade from the client
221                             if ($postedvalue === format_float($oldvalue->finalgrade, $oldvalue->grade_item->get_decimals())) {
222                                 continue;
223                             }
224                         }
226                         $changedgrades = true;
228                     } else if ($datatype === 'feedback') {
229                         if (($oldvalue->feedback === $postedvalue) or ($oldvalue->feedback === NULL and empty($postedvalue))) {
230                             continue;
231                         }
232                     }
234                     if (!$gradeitem = grade_item::fetch(array('id'=>$itemid, 'courseid'=>$this->courseid))) {
235                         print_error('invalidgradeitemid');
236                     }
238                     // Pre-process grade
239                     if ($datatype == 'grade') {
240                         $feedback = false;
241                         $feedbackformat = false;
242                         if ($gradeitem->gradetype == GRADE_TYPE_SCALE) {
243                             if ($postedvalue == -1) { // -1 means no grade
244                                 $finalgrade = null;
245                             } else {
246                                 $finalgrade = $postedvalue;
247                             }
248                         } else {
249                             $finalgrade = unformat_float($postedvalue);
250                         }
252                         $errorstr = '';
253                         // Warn if the grade is out of bounds.
254                         if (is_null($finalgrade)) {
255                             // ok
256                         } else {
257                             $bounded = $gradeitem->bounded_grade($finalgrade);
258                             if ($bounded > $finalgrade) {
259                                 $errorstr = 'lessthanmin';
260                             } else if ($bounded < $finalgrade) {
261                                 $errorstr = 'morethanmax';
262                             }
263                         }
264                         if ($errorstr) {
265                             $user = $DB->get_record('user', array('id' => $userid), 'id, firstname, lastname');
266                             $gradestr = new stdClass();
267                             $gradestr->username = fullname($user);
268                             $gradestr->itemname = $gradeitem->get_name();
269                             $warnings[] = get_string($errorstr, 'grades', $gradestr);
270                         }
272                     } else if ($datatype == 'feedback') {
273                         $finalgrade = false;
274                         $trimmed = trim($postedvalue);
275                         if (empty($trimmed)) {
276                              $feedback = NULL;
277                         } else {
278                              $feedback = $postedvalue;
279                         }
280                     }
282                     // group access control
283                     if ($separategroups) {
284                         // note: we can not use $this->currentgroup because it would fail badly
285                         //       when having two browser windows each with different group
286                         $sharinggroup = false;
287                         foreach($mygroups as $groupid) {
288                             if (groups_is_member($groupid, $userid)) {
289                                 $sharinggroup = true;
290                                 break;
291                             }
292                         }
293                         if (!$sharinggroup) {
294                             // either group membership changed or somebody is hacking grades of other group
295                             $warnings[] = get_string('errorsavegrade', 'grades');
296                             continue;
297                         }
298                     }
300                     $url = '/report/grader/index.php?id=' . $this->course->id;
301                     $fullname = fullname($this->users[$userid]);
303                     $info = "{$gradeitem->itemname}: $fullname";
304                     add_to_log($this->course->id, 'grade', 'update', $url, $info);
306                     $gradeitem->update_final_grade($userid, $finalgrade, 'gradebook', $feedback, FORMAT_MOODLE);
308                     // We can update feedback without reloading the grade item as it doesn't affect grade calculations
309                     if ($datatype === 'feedback') {
310                         $this->grades[$userid][$itemid]->feedback = $feedback;
311                     }
312                 }
313             }
314         }
316         if ($changedgrades) {
317             // If a final grade was overriden reload grades so dependent grades like course total will be correct
318             $this->grades = null;
319         }
321         return $warnings;
322     }
325     /**
326      * Setting the sort order, this depends on last state
327      * all this should be in the new table class that we might need to use
328      * for displaying grades.
329      */
330     private function setup_sortitemid() {
332         global $SESSION;
334         if (!isset($SESSION->gradeuserreport)) {
335             $SESSION->gradeuserreport = new stdClass();
336         }
338         if ($this->sortitemid) {
339             if (!isset($SESSION->gradeuserreport->sort)) {
340                 if ($this->sortitemid == 'firstname' || $this->sortitemid == 'lastname') {
341                     $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC';
342                 } else {
343                     $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC';
344                 }
345             } else {
346                 // this is the first sort, i.e. by last name
347                 if (!isset($SESSION->gradeuserreport->sortitemid)) {
348                     if ($this->sortitemid == 'firstname' || $this->sortitemid == 'lastname') {
349                         $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC';
350                     } else {
351                         $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC';
352                     }
353                 } else if ($SESSION->gradeuserreport->sortitemid == $this->sortitemid) {
354                     // same as last sort
355                     if ($SESSION->gradeuserreport->sort == 'ASC') {
356                         $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC';
357                     } else {
358                         $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC';
359                     }
360                 } else {
361                     if ($this->sortitemid == 'firstname' || $this->sortitemid == 'lastname') {
362                         $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC';
363                     } else {
364                         $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC';
365                     }
366                 }
367             }
368             $SESSION->gradeuserreport->sortitemid = $this->sortitemid;
369         } else {
370             // not requesting sort, use last setting (for paging)
372             if (isset($SESSION->gradeuserreport->sortitemid)) {
373                 $this->sortitemid = $SESSION->gradeuserreport->sortitemid;
374             }else{
375                 $this->sortitemid = 'lastname';
376             }
378             if (isset($SESSION->gradeuserreport->sort)) {
379                 $this->sortorder = $SESSION->gradeuserreport->sort;
380             } else {
381                 $this->sortorder = 'ASC';
382             }
383         }
384     }
386     /**
387      * pulls out the userids of the users to be display, and sorts them
388      */
389     public function load_users() {
390         global $CFG, $DB;
392         if (!empty($this->users)) {
393             return;
394         }
396         //limit to users with a gradeable role
397         list($gradebookrolessql, $gradebookrolesparams) = $DB->get_in_or_equal(explode(',', $this->gradebookroles), SQL_PARAMS_NAMED, 'grbr0');
399         //limit to users with an active enrollment
400         list($enrolledsql, $enrolledparams) = get_enrolled_sql($this->context);
402         //fields we need from the user table
403         $userfields = user_picture::fields('u', get_extra_user_fields($this->context));
405         $sortjoin = $sort = $params = null;
407         //if the user has clicked one of the sort asc/desc arrows
408         if (is_numeric($this->sortitemid)) {
409             $params = array_merge(array('gitemid'=>$this->sortitemid), $gradebookrolesparams, $this->groupwheresql_params, $enrolledparams);
411             $sortjoin = "LEFT JOIN {grade_grades} g ON g.userid = u.id AND g.itemid = $this->sortitemid";
412             $sort = "g.finalgrade $this->sortorder";
414         } else {
415             $sortjoin = '';
416             switch($this->sortitemid) {
417                 case 'lastname':
418                     $sort = "u.lastname $this->sortorder, u.firstname $this->sortorder";
419                     break;
420                 case 'firstname':
421                     $sort = "u.firstname $this->sortorder, u.lastname $this->sortorder";
422                     break;
423                 case 'email':
424                     $sort = "u.email $this->sortorder";
425                     break;
426                 case 'idnumber':
427                 default:
428                     $sort = "u.idnumber $this->sortorder";
429                     break;
430             }
432             $params = array_merge($gradebookrolesparams, $this->groupwheresql_params, $enrolledparams);
433         }
435         $sql = "SELECT $userfields
436                   FROM {user} u
437                   JOIN ($enrolledsql) je ON je.id = u.id
438                        $this->groupsql
439                        $sortjoin
440                   JOIN (
441                            SELECT DISTINCT ra.userid
442                              FROM {role_assignments} ra
443                             WHERE ra.roleid IN ($this->gradebookroles)
444                               AND ra.contextid " . get_related_contexts_string($this->context) . "
445                        ) rainner ON rainner.userid = u.id
446                    AND u.deleted = 0
447                    $this->groupwheresql
448               ORDER BY $sort";
450         $studentsperpage = $this->get_students_per_page();
451         $this->users = $DB->get_records_sql($sql, $params, $studentsperpage * $this->page, $studentsperpage);
453         if (empty($this->users)) {
454             $this->userselect = '';
455             $this->users = array();
456             $this->userselect_params = array();
457         } else {
458             list($usql, $uparams) = $DB->get_in_or_equal(array_keys($this->users), SQL_PARAMS_NAMED, 'usid0');
459             $this->userselect = "AND g.userid $usql";
460             $this->userselect_params = $uparams;
462             // Add a flag to each user indicating whether their enrolment is active.
463             $sql = "SELECT ue.userid
464                       FROM {user_enrolments} ue
465                       JOIN {enrol} e ON e.id = ue.enrolid
466                      WHERE ue.userid $usql
467                            AND ue.status = :uestatus
468                            AND e.status = :estatus
469                            AND e.courseid = :courseid
470                   GROUP BY ue.userid";
471             $coursecontext = get_course_context($this->context);
472             $params = array_merge($uparams, array('estatus'=>ENROL_INSTANCE_ENABLED, 'uestatus'=>ENROL_USER_ACTIVE, 'courseid'=>$coursecontext->instanceid));
473             $useractiveenrolments = $DB->get_records_sql($sql, $params);
475             $defaultgradeshowactiveenrol = !empty($CFG->grade_report_showonlyactiveenrol);
476             $showonlyactiveenrol = get_user_preferences('grade_report_showonlyactiveenrol', $defaultgradeshowactiveenrol);
477             $showonlyactiveenrol = $showonlyactiveenrol || !has_capability('moodle/course:viewsuspendedusers', $coursecontext);
478             foreach ($this->users as $user) {
479                 // If we are showing only active enrolments, then remove suspended users from list.
480                 if ($showonlyactiveenrol && !array_key_exists($user->id, $useractiveenrolments)) {
481                     unset($this->users[$user->id]);
482                 } else {
483                     $this->users[$user->id]->suspendedenrolment = !array_key_exists($user->id, $useractiveenrolments);
484                 }
485             }
486         }
488         return $this->users;
489     }
491     /**
492      * we supply the userids in this query, and get all the grades
493      * pulls out all the grades, this does not need to worry about paging
494      */
495     public function load_final_grades() {
496         global $CFG, $DB;
498         if (!empty($this->grades)) {
499             return;
500         }
502         // please note that we must fetch all grade_grades fields if we want to construct grade_grade object from it!
503         $params = array_merge(array('courseid'=>$this->courseid), $this->userselect_params);
504         $sql = "SELECT g.*
505                   FROM {grade_items} gi,
506                        {grade_grades} g
507                  WHERE g.itemid = gi.id AND gi.courseid = :courseid {$this->userselect}";
509         $userids = array_keys($this->users);
512         if ($grades = $DB->get_records_sql($sql, $params)) {
513             foreach ($grades as $graderec) {
514                 if (in_array($graderec->userid, $userids) and array_key_exists($graderec->itemid, $this->gtree->get_items())) { // some items may not be present!!
515                     $this->grades[$graderec->userid][$graderec->itemid] = new grade_grade($graderec, false);
516                     $this->grades[$graderec->userid][$graderec->itemid]->grade_item = $this->gtree->get_item($graderec->itemid); // db caching
517                 }
518             }
519         }
521         // prefil grades that do not exist yet
522         foreach ($userids as $userid) {
523             foreach ($this->gtree->get_items() as $itemid=>$unused) {
524                 if (!isset($this->grades[$userid][$itemid])) {
525                     $this->grades[$userid][$itemid] = new grade_grade();
526                     $this->grades[$userid][$itemid]->itemid = $itemid;
527                     $this->grades[$userid][$itemid]->userid = $userid;
528                     $this->grades[$userid][$itemid]->grade_item = $this->gtree->get_item($itemid); // db caching
529                 }
530             }
531         }
532     }
534     /**
535      * Builds and returns a div with on/off toggles.
536      * @return string HTML code
537      * @deprecated since 2.4 as it appears not to be used any more.
538      */
539     public function get_toggles_html() {
540         global $CFG, $USER, $COURSE, $OUTPUT;
541         debugging('Call to deprecated function grade_report_grader::get_toggles_html().', DEBUG_DEVELOPER);
542         $html = '';
543         if ($USER->gradeediting[$this->courseid]) {
544             if (has_capability('moodle/grade:manage', $this->context) or has_capability('moodle/grade:hide', $this->context)) {
545                 $html .= $this->print_toggle('eyecons');
546             }
547             if (has_capability('moodle/grade:manage', $this->context)
548              or has_capability('moodle/grade:lock', $this->context)
549              or has_capability('moodle/grade:unlock', $this->context)) {
550                 $html .= $this->print_toggle('locks');
551             }
552             if (has_capability('moodle/grade:manage', $this->context)) {
553                 $html .= $this->print_toggle('quickfeedback');
554             }
556             if (has_capability('moodle/grade:manage', $this->context)) {
557                 $html .= $this->print_toggle('calculations');
558             }
559         }
561         if ($this->canviewhidden) {
562             $html .= $this->print_toggle('averages');
563         }
565         $html .= $this->print_toggle('ranges');
566         if (!empty($CFG->enableoutcomes)) {
567             $html .= $this->print_toggle('nooutcomes');
568         }
570         return $OUTPUT->container($html, 'grade-report-toggles');
571     }
573     /**
574     * Shortcut function for printing the grader report toggles.
575     * @param string $type The type of toggle
576     * @param bool $return Whether to return the HTML string rather than printing it
577     * @return void
578     * @deprecated since 2.4 as it appears not to be used any more.
579     */
580     public function print_toggle($type) {
581         global $CFG, $OUTPUT;
582         debugging('Call to deprecated function grade_report_grader::print_toggle().', DEBUG_DEVELOPER);
583         $icons = array('eyecons' => 't/hide',
584                        'calculations' => 't/calc',
585                        'locks' => 't/lock',
586                        'averages' => 't/mean',
587                        'quickfeedback' => 't/feedback',
588                        'nooutcomes' => 't/outcomes');
590         $prefname = 'grade_report_show' . $type;
592         if (array_key_exists($prefname, $CFG)) {
593             $showpref = get_user_preferences($prefname, $CFG->$prefname);
594         } else {
595             $showpref = get_user_preferences($prefname);
596         }
598         $strshow = $this->get_lang_string('show' . $type, 'grades');
599         $strhide = $this->get_lang_string('hide' . $type, 'grades');
601         $showhide = 'show';
602         $toggleaction = 1;
604         if ($showpref) {
605             $showhide = 'hide';
606             $toggleaction = 0;
607         }
609         if (array_key_exists($type, $icons)) {
610             $imagename = $icons[$type];
611         } else {
612             $imagename = "t/$type";
613         }
615         $string = ${'str' . $showhide};
617         $url = new moodle_url($this->baseurl, array('toggle' => $toggleaction, 'toggle_type' => $type));
619         $retval = $OUTPUT->container($OUTPUT->action_icon($url, new pix_icon($imagename, $string))); // TODO: this container looks wrong here
621         return $retval;
622     }
624     /**
625      * Builds and returns the rows that will make up the left part of the grader report
626      * This consists of student names and icons, links to user reports and id numbers, as well
627      * as header cells for these columns. It also includes the fillers required for the
628      * categories displayed on the right side of the report.
629      * @return array Array of html_table_row objects
630      */
631     public function get_left_rows() {
632         global $CFG, $USER, $OUTPUT;
634         $rows = array();
636         $showuserimage = $this->get_pref('showuserimage');
638         $strfeedback  = $this->get_lang_string("feedback");
639         $strgrade     = $this->get_lang_string('grade');
641         $extrafields = get_extra_user_fields($this->context);
643         $arrows = $this->get_sort_arrows($extrafields);
645         $colspan = 1;
646         if (has_capability('gradereport/'.$CFG->grade_profilereport.':view', $this->context)) {
647             $colspan++;
648         }
649         $colspan += count($extrafields);
651         $levels = count($this->gtree->levels) - 1;
653         for ($i = 0; $i < $levels; $i++) {
654             $fillercell = new html_table_cell();
655             $fillercell->attributes['class'] = 'fixedcolumn cell topleft';
656             $fillercell->text = ' ';
657             $fillercell->colspan = $colspan;
658             $row = new html_table_row(array($fillercell));
659             $rows[] = $row;
660         }
662         $headerrow = new html_table_row();
663         $headerrow->attributes['class'] = 'heading';
665         $studentheader = new html_table_cell();
666         $studentheader->attributes['class'] = 'header';
667         $studentheader->scope = 'col';
668         $studentheader->header = true;
669         $studentheader->id = 'studentheader';
670         if (has_capability('gradereport/'.$CFG->grade_profilereport.':view', $this->context)) {
671             $studentheader->colspan = 2;
672         }
673         $studentheader->text = $arrows['studentname'];
675         $headerrow->cells[] = $studentheader;
677         foreach ($extrafields as $field) {
678             $fieldheader = new html_table_cell();
679             $fieldheader->attributes['class'] = 'header userfield user' . $field;
680             $fieldheader->scope = 'col';
681             $fieldheader->header = true;
682             $fieldheader->text = $arrows[$field];
684             $headerrow->cells[] = $fieldheader;
685         }
687         $rows[] = $headerrow;
689         $rows = $this->get_left_icons_row($rows, $colspan);
691         $rowclasses = array('even', 'odd');
693         $suspendedstring = null;
694         foreach ($this->users as $userid => $user) {
695             $userrow = new html_table_row();
696             $userrow->id = 'fixed_user_'.$userid;
697             $userrow->attributes['class'] = 'r'.$this->rowcount++.' '.$rowclasses[$this->rowcount % 2];
699             $usercell = new html_table_cell();
700             $usercell->attributes['class'] = 'user';
702             $usercell->header = true;
703             $usercell->scope = 'row';
705             if ($showuserimage) {
706                 $usercell->text = $OUTPUT->user_picture($user);
707             }
709             $usercell->text .= html_writer::link(new moodle_url('/user/view.php', array('id' => $user->id, 'course' => $this->course->id)), fullname($user));
711             if (!empty($user->suspendedenrolment)) {
712                 $usercell->attributes['class'] .= ' usersuspended';
714                 //may be lots of suspended users so only get the string once
715                 if (empty($suspendedstring)) {
716                     $suspendedstring = get_string('userenrolmentsuspended', 'grades');
717                 }
718                 $usercell->text .= html_writer::empty_tag('img', array('src'=>$OUTPUT->pix_url('i/enrolmentsuspended'), 'title'=>$suspendedstring, 'alt'=>$suspendedstring, 'class'=>'usersuspendedicon'));
719             }
721             $userrow->cells[] = $usercell;
723             if (has_capability('gradereport/'.$CFG->grade_profilereport.':view', $this->context)) {
724                 $userreportcell = new html_table_cell();
725                 $userreportcell->attributes['class'] = 'userreport';
726                 $userreportcell->header = true;
727                 $a = new stdClass();
728                 $a->user = fullname($user);
729                 $strgradesforuser = get_string('gradesforuser', 'grades', $a);
730                 $url = new moodle_url('/grade/report/'.$CFG->grade_profilereport.'/index.php', array('userid' => $user->id, 'id' => $this->course->id));
731                 $userreportcell->text = $OUTPUT->action_icon($url, new pix_icon('t/grades', $strgradesforuser));
732                 $userrow->cells[] = $userreportcell;
733             }
735             foreach ($extrafields as $field) {
736                 $fieldcell = new html_table_cell();
737                 $fieldcell->attributes['class'] = 'header userfield user' . $field;
738                 $fieldcell->header = true;
739                 $fieldcell->scope = 'row';
740                 $fieldcell->text = $user->{$field};
741                 $userrow->cells[] = $fieldcell;
742             }
744             $rows[] = $userrow;
745         }
747         $rows = $this->get_left_range_row($rows, $colspan);
748         $rows = $this->get_left_avg_row($rows, $colspan, true);
749         $rows = $this->get_left_avg_row($rows, $colspan);
751         return $rows;
752     }
754     /**
755      * Builds and returns the rows that will make up the right part of the grader report
756      * @return array Array of html_table_row objects
757      */
758     public function get_right_rows() {
759         global $CFG, $USER, $OUTPUT, $DB, $PAGE;
761         $rows = array();
762         $this->rowcount = 0;
763         $numrows = count($this->gtree->get_levels());
764         $numusers = count($this->users);
765         $gradetabindex = 1;
766         $columnstounset = array();
767         $strgrade = $this->get_lang_string('grade');
768         $strfeedback  = $this->get_lang_string("feedback");
769         $arrows = $this->get_sort_arrows();
771         $jsarguments = array(
772             'id'        => '#fixed_column',
773             'cfg'       => array('ajaxenabled'=>false),
774             'items'     => array(),
775             'users'     => array(),
776             'feedback'  => array()
777         );
778         $jsscales = array();
780         foreach ($this->gtree->get_levels() as $key=>$row) {
781             if ($key == 0) {
782                 // do not display course grade category
783                 // continue;
784             }
786             $headingrow = new html_table_row();
787             $headingrow->attributes['class'] = 'heading_name_row';
789             foreach ($row as $columnkey => $element) {
790                 $sortlink = clone($this->baseurl);
791                 if (isset($element['object']->id)) {
792                     $sortlink->param('sortitemid', $element['object']->id);
793                 }
795                 $eid    = $element['eid'];
796                 $object = $element['object'];
797                 $type   = $element['type'];
798                 $categorystate = @$element['categorystate'];
800                 if (!empty($element['colspan'])) {
801                     $colspan = $element['colspan'];
802                 } else {
803                     $colspan = 1;
804                 }
806                 if (!empty($element['depth'])) {
807                     $catlevel = 'catlevel'.$element['depth'];
808                 } else {
809                     $catlevel = '';
810                 }
812 // Element is a filler
813                 if ($type == 'filler' or $type == 'fillerfirst' or $type == 'fillerlast') {
814                     $fillercell = new html_table_cell();
815                     $fillercell->attributes['class'] = $type . ' ' . $catlevel;
816                     $fillercell->colspan = $colspan;
817                     $fillercell->text = '&nbsp;';
818                     $fillercell->header = true;
819                     $fillercell->scope = 'col';
820                     $headingrow->cells[] = $fillercell;
821                 }
822 // Element is a category
823                 else if ($type == 'category') {
824                     $categorycell = new html_table_cell();
825                     $categorycell->attributes['class'] = 'category ' . $catlevel;
826                     $categorycell->colspan = $colspan;
827                     $categorycell->text = shorten_text($element['object']->get_name());
828                     $categorycell->text .= $this->get_collapsing_icon($element);
829                     $categorycell->header = true;
830                     $categorycell->scope = 'col';
832                     // Print icons
833                     if ($USER->gradeediting[$this->courseid]) {
834                         $categorycell->text .= $this->get_icons($element);
835                     }
837                     $headingrow->cells[] = $categorycell;
838                 }
839 // Element is a grade_item
840                 else {
841                     //$itemmodule = $element['object']->itemmodule;
842                     //$iteminstance = $element['object']->iteminstance;
844                     if ($element['object']->id == $this->sortitemid) {
845                         if ($this->sortorder == 'ASC') {
846                             $arrow = $this->get_sort_arrow('up', $sortlink);
847                         } else {
848                             $arrow = $this->get_sort_arrow('down', $sortlink);
849                         }
850                     } else {
851                         $arrow = $this->get_sort_arrow('move', $sortlink);
852                     }
854                     $headerlink = $this->gtree->get_element_header($element, true, $this->get_pref('showactivityicons'), false);
856                     $itemcell = new html_table_cell();
857                     $itemcell->attributes['class'] = $type . ' ' . $catlevel . ' highlightable';
859                     if ($element['object']->is_hidden()) {
860                         $itemcell->attributes['class'] .= ' hidden';
861                     }
863                     $itemcell->colspan = $colspan;
864                     $itemcell->text = shorten_text($headerlink) . $arrow;
865                     $itemcell->header = true;
866                     $itemcell->scope = 'col';
868                     $headingrow->cells[] = $itemcell;
869                 }
870             }
871             $rows[] = $headingrow;
872         }
874         $rows = $this->get_right_icons_row($rows);
876         // Preload scale objects for items with a scaleid and initialize tab indices
877         $scaleslist = array();
878         $tabindices = array();
880         foreach ($this->gtree->get_items() as $itemid=>$item) {
881             $scale = null;
882             if (!empty($item->scaleid)) {
883                 $scaleslist[] = $item->scaleid;
884                 $jsarguments['items'][$itemid] = array('id'=>$itemid, 'name'=>$item->get_name(true), 'type'=>'scale', 'scale'=>$item->scaleid, 'decimals'=>$item->get_decimals());
885             } else {
886                 $jsarguments['items'][$itemid] = array('id'=>$itemid, 'name'=>$item->get_name(true), 'type'=>'value', 'scale'=>false, 'decimals'=>$item->get_decimals());
887             }
888             $tabindices[$item->id]['grade'] = $gradetabindex;
889             $tabindices[$item->id]['feedback'] = $gradetabindex + $numusers;
890             $gradetabindex += $numusers * 2;
891         }
892         $scalesarray = array();
894         if (!empty($scaleslist)) {
895             $scalesarray = $DB->get_records_list('scale', 'id', $scaleslist);
896         }
897         $jsscales = $scalesarray;
899         $rowclasses = array('even', 'odd');
901         foreach ($this->users as $userid => $user) {
903             if ($this->canviewhidden) {
904                 $altered = array();
905                 $unknown = array();
906             } else {
907                 $hidingaffected = grade_grade::get_hiding_affected($this->grades[$userid], $this->gtree->get_items());
908                 $altered = $hidingaffected['altered'];
909                 $unknown = $hidingaffected['unknown'];
910                 unset($hidingaffected);
911             }
914             $itemrow = new html_table_row();
915             $itemrow->id = 'user_'.$userid;
916             $itemrow->attributes['class'] = $rowclasses[$this->rowcount % 2];
918             $jsarguments['users'][$userid] = fullname($user);
920             foreach ($this->gtree->items as $itemid=>$unused) {
921                 $item =& $this->gtree->items[$itemid];
922                 $grade = $this->grades[$userid][$item->id];
924                 $itemcell = new html_table_cell();
926                 $itemcell->id = 'u'.$userid.'i'.$itemid;
928                 // Get the decimal points preference for this item
929                 $decimalpoints = $item->get_decimals();
931                 if (in_array($itemid, $unknown)) {
932                     $gradeval = null;
933                 } else if (array_key_exists($itemid, $altered)) {
934                     $gradeval = $altered[$itemid];
935                 } else {
936                     $gradeval = $grade->finalgrade;
937                 }
938                 if (!empty($grade->finalgrade)) {
939                     $gradevalforJS = null;
940                     if ($item->scaleid && !empty($scalesarray[$item->scaleid])) {
941                         $gradevalforJS = (int)$gradeval;
942                     } else {
943                         $gradevalforJS = format_float($gradeval, $decimalpoints);
944                     }
945                     $jsarguments['grades'][] = array('user'=>$userid, 'item'=>$itemid, 'grade'=>$gradevalforJS);
946                 }
948                 // MDL-11274
949                 // Hide grades in the grader report if the current grader doesn't have 'moodle/grade:viewhidden'
950                 if (!$this->canviewhidden and $grade->is_hidden()) {
951                     if (!empty($CFG->grade_hiddenasdate) and $grade->get_datesubmitted() and !$item->is_category_item() and !$item->is_course_item()) {
952                         // 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
953                         $itemcell->text = html_writer::tag('span', userdate($grade->get_datesubmitted(),get_string('strftimedatetimeshort')), array('class'=>'datesubmitted'));
954                     } else {
955                         $itemcell->text = '-';
956                     }
957                     $itemrow->cells[] = $itemcell;
958                     continue;
959                 }
961                 // emulate grade element
962                 $eid = $this->gtree->get_grade_eid($grade);
963                 $element = array('eid'=>$eid, 'object'=>$grade, 'type'=>'grade');
965                 $itemcell->attributes['class'] .= ' grade';
966                 if ($item->is_category_item()) {
967                     $itemcell->attributes['class'] .= ' cat';
968                 }
969                 if ($item->is_course_item()) {
970                     $itemcell->attributes['class'] .= ' course';
971                 }
972                 if ($grade->is_overridden()) {
973                     $itemcell->attributes['class'] .= ' overridden';
974                 }
976                 if ($grade->is_excluded()) {
977                     // $itemcell->attributes['class'] .= ' excluded';
978                 }
980                 if (!empty($grade->feedback)) {
981                     //should we be truncating feedback? ie $short_feedback = shorten_text($feedback, $this->feedback_trunc_length);
982                     $jsarguments['feedback'][] = array('user'=>$userid, 'item'=>$itemid, 'content'=>wordwrap(trim(format_string($grade->feedback, $grade->feedbackformat)), 34, '<br/ >'));
983                 }
985                 if ($grade->is_excluded()) {
986                     $itemcell->text .= html_writer::tag('span', get_string('excluded', 'grades'), array('class'=>'excludedfloater'));
987                 }
989                 // Do not show any icons if no grade (no record in DB to match)
990                 if (!$item->needsupdate and $USER->gradeediting[$this->courseid]) {
991                     $itemcell->text .= $this->get_icons($element);
992                 }
994                 $hidden = '';
995                 if ($grade->is_hidden()) {
996                     $hidden = ' hidden ';
997                 }
999                 $gradepass = ' gradefail ';
1000                 if ($grade->is_passed($item)) {
1001                     $gradepass = ' gradepass ';
1002                 } elseif (is_null($grade->is_passed($item))) {
1003                     $gradepass = '';
1004                 }
1006                 // if in editing mode, we need to print either a text box
1007                 // or a drop down (for scales)
1008                 // grades in item of type grade category or course are not directly editable
1009                 if ($item->needsupdate) {
1010                     $itemcell->text .= html_writer::tag('span', get_string('error'), array('class'=>"gradingerror$hidden"));
1012                 } else if ($USER->gradeediting[$this->courseid]) {
1014                     if ($item->scaleid && !empty($scalesarray[$item->scaleid])) {
1015                         $scale = $scalesarray[$item->scaleid];
1016                         $gradeval = (int)$gradeval; // scales use only integers
1017                         $scales = explode(",", $scale->scale);
1018                         // reindex because scale is off 1
1020                         // MDL-12104 some previous scales might have taken up part of the array
1021                         // so this needs to be reset
1022                         $scaleopt = array();
1023                         $i = 0;
1024                         foreach ($scales as $scaleoption) {
1025                             $i++;
1026                             $scaleopt[$i] = $scaleoption;
1027                         }
1029                         if ($this->get_pref('quickgrading') and $grade->is_editable()) {
1030                             $oldval = empty($gradeval) ? -1 : $gradeval;
1031                             if (empty($item->outcomeid)) {
1032                                 $nogradestr = $this->get_lang_string('nograde');
1033                             } else {
1034                                 $nogradestr = $this->get_lang_string('nooutcome', 'grades');
1035                             }
1036                             $attributes = array('tabindex' => $tabindices[$item->id]['grade'], 'id'=>'grade_'.$userid.'_'.$item->id);
1037                             $itemcell->text .= html_writer::label(get_string('typescale', 'grades'), $attributes['id'], false, array('class' => 'accesshide'));
1038                             $itemcell->text .= html_writer::select($scaleopt, 'grade['.$userid.']['.$item->id.']', $gradeval, array(-1=>$nogradestr), $attributes);
1039                         } elseif(!empty($scale)) {
1040                             $scales = explode(",", $scale->scale);
1042                             // invalid grade if gradeval < 1
1043                             if ($gradeval < 1) {
1044                                 $itemcell->text .= html_writer::tag('span', '-', array('class'=>"gradevalue$hidden$gradepass"));
1045                             } else {
1046                                 $gradeval = $grade->grade_item->bounded_grade($gradeval); //just in case somebody changes scale
1047                                 $itemcell->text .= html_writer::tag('span', $scales[$gradeval-1], array('class'=>"gradevalue$hidden$gradepass"));
1048                             }
1049                         } else {
1050                             // no such scale, throw error?
1051                         }
1053                     } else if ($item->gradetype != GRADE_TYPE_TEXT) { // Value type
1054                         if ($this->get_pref('quickgrading') and $grade->is_editable()) {
1055                             $value = format_float($gradeval, $decimalpoints);
1056                             $gradelabel = fullname($user) . ' ' . $item->itemname;
1057                             $itemcell->text .= '<label class="accesshide" for="grade_'.$userid.'_'.$item->id.'">'
1058                                           .get_string('useractivitygrade', 'gradereport_grader', $gradelabel).'</label>';
1059                             $itemcell->text .= '<input size="6" tabindex="' . $tabindices[$item->id]['grade']
1060                                           . '" type="text" class="text" title="'. $strgrade .'" name="grade['
1061                                           .$userid.'][' .$item->id.']" id="grade_'.$userid.'_'.$item->id.'" value="'.$value.'" />';
1062                         } else {
1063                             $itemcell->text .= html_writer::tag('span', format_float($gradeval, $decimalpoints), array('class'=>"gradevalue$hidden$gradepass"));
1064                         }
1065                     }
1068                     // If quickfeedback is on, print an input element
1069                     if ($this->get_pref('showquickfeedback') and $grade->is_editable()) {
1070                         $feedbacklabel = fullname($user) . ' ' . $item->itemname;
1071                         $itemcell->text .= '<label class="accesshide" for="feedback_'.$userid.'_'.$item->id.'">'
1072                                       .get_string('useractivityfeedback', 'gradereport_grader', $feedbacklabel).'</label>';
1073                         $itemcell->text .= '<input class="quickfeedback" tabindex="' . $tabindices[$item->id]['feedback'].'" id="feedback_'.$userid.'_'.$item->id
1074                                       . '" size="6" title="' . $strfeedback . '" type="text" name="feedback['.$userid.']['.$item->id.']" value="' . s($grade->feedback) . '" />';
1075                     }
1077                 } else { // Not editing
1078                     $gradedisplaytype = $item->get_displaytype();
1080                     if ($item->scaleid && !empty($scalesarray[$item->scaleid])) {
1081                         $itemcell->attributes['class'] .= ' grade_type_scale';
1082                     } else if ($item->gradetype != GRADE_TYPE_TEXT) {
1083                         $itemcell->attributes['class'] .= ' grade_type_text';
1084                     }
1086                     if ($this->get_pref('enableajax')) {
1087                         $itemcell->attributes['class'] .= ' clickable';
1088                     }
1090                     if ($item->needsupdate) {
1091                         $itemcell->text .= html_writer::tag('span', get_string('error'), array('class'=>"gradingerror$hidden$gradepass"));
1092                     } else {
1093                         $itemcell->text .= html_writer::tag('span', grade_format_gradevalue($gradeval, $item, true, $gradedisplaytype, null), array('class'=>"gradevalue$hidden$gradepass"));
1094                         if ($this->get_pref('showanalysisicon')) {
1095                             $itemcell->text .= $this->gtree->get_grade_analysis_icon($grade);
1096                         }
1097                     }
1098                 }
1100                 if (!empty($this->gradeserror[$item->id][$userid])) {
1101                     $itemcell->text .= $this->gradeserror[$item->id][$userid];
1102                 }
1104                 $itemrow->cells[] = $itemcell;
1105             }
1106             $rows[] = $itemrow;
1107         }
1109         if ($this->get_pref('enableajax')) {
1110             $jsarguments['cfg']['ajaxenabled'] = true;
1111             $jsarguments['cfg']['scales'] = array();
1112             foreach ($jsscales as $scale) {
1113                 $jsarguments['cfg']['scales'][$scale->id] = explode(',',$scale->scale);
1114             }
1115             $jsarguments['cfg']['feedbacktrunclength'] =  $this->feedback_trunc_length;
1117             // Student grades and feedback are already at $jsarguments['feedback'] and $jsarguments['grades']
1118         }
1119         $jsarguments['cfg']['isediting'] = (bool)$USER->gradeediting[$this->courseid];
1120         $jsarguments['cfg']['courseid'] =  $this->courseid;
1121         $jsarguments['cfg']['studentsperpage'] =  $this->get_students_per_page();
1122         $jsarguments['cfg']['showquickfeedback'] =  (bool)$this->get_pref('showquickfeedback');
1124         $module = array(
1125             'name'      => 'gradereport_grader',
1126             'fullpath'  => '/grade/report/grader/module.js',
1127             'requires'  => array('base', 'dom', 'event', 'event-mouseenter', 'event-key', 'io-queue', 'json-parse', 'overlay')
1128         );
1129         $PAGE->requires->js_init_call('M.gradereport_grader.init_report', $jsarguments, false, $module);
1130         $PAGE->requires->strings_for_js(array('addfeedback','feedback', 'grade'), 'grades');
1131         $PAGE->requires->strings_for_js(array('ajaxchoosescale','ajaxclicktoclose','ajaxerror','ajaxfailedupdate', 'ajaxfieldchanged'), 'gradereport_grader');
1133         $rows = $this->get_right_range_row($rows);
1134         $rows = $this->get_right_avg_row($rows, true);
1135         $rows = $this->get_right_avg_row($rows);
1137         return $rows;
1138     }
1140     /**
1141      * Depending on the style of report (fixedstudents vs traditional one-table),
1142      * arranges the rows of data in one or two tables, and returns the output of
1143      * these tables in HTML
1144      * @return string HTML
1145      */
1146     public function get_grade_table() {
1147         global $OUTPUT;
1148         $fixedstudents = $this->is_fixed_students();
1150         $leftrows = $this->get_left_rows();
1151         $rightrows = $this->get_right_rows();
1153         $html = '';
1156         if ($fixedstudents) {
1157             $fixedcolumntable = new html_table();
1158             $fixedcolumntable->id = 'fixed_column';
1159             $fixedcolumntable->data = $leftrows;
1160             $html .= $OUTPUT->container(html_writer::table($fixedcolumntable), 'left_scroller');
1162             $righttable = new html_table();
1163             $righttable->id = 'user-grades';
1164             $righttable->data = $rightrows;
1166             $html .= $OUTPUT->container(html_writer::table($righttable), 'right_scroller');
1167         } else {
1168             $fulltable = new html_table();
1169             $fulltable->attributes['class'] = 'gradestable flexible boxaligncenter generaltable';
1170             $fulltable->id = 'user-grades';
1172             // Extract rows from each side (left and right) and collate them into one row each
1173             foreach ($leftrows as $key => $row) {
1174                 $row->cells = array_merge($row->cells, $rightrows[$key]->cells);
1175                 $fulltable->data[] = $row;
1176             }
1177             $html .= html_writer::table($fulltable);
1178         }
1179         return $OUTPUT->container($html, 'gradeparent');
1180     }
1182     /**
1183      * Builds and return the row of icons for the left side of the report.
1184      * It only has one cell that says "Controls"
1185      * @param array $rows The Array of rows for the left part of the report
1186      * @param int $colspan The number of columns this cell has to span
1187      * @return array Array of rows for the left part of the report
1188      */
1189     public function get_left_icons_row($rows=array(), $colspan=1) {
1190         global $USER;
1192         if ($USER->gradeediting[$this->courseid]) {
1193             $controlsrow = new html_table_row();
1194             $controlsrow->attributes['class'] = 'controls';
1195             $controlscell = new html_table_cell();
1196             $controlscell->attributes['class'] = 'header controls';
1197             $controlscell->colspan = $colspan;
1198             $controlscell->text = $this->get_lang_string('controls','grades');
1200             $controlsrow->cells[] = $controlscell;
1201             $rows[] = $controlsrow;
1202         }
1203         return $rows;
1204     }
1206     /**
1207      * Builds and return the header for the row of ranges, for the left part of the grader report.
1208      * @param array $rows The Array of rows for the left part of the report
1209      * @param int $colspan The number of columns this cell has to span
1210      * @return array Array of rows for the left part of the report
1211      */
1212     public function get_left_range_row($rows=array(), $colspan=1) {
1213         global $CFG, $USER;
1215         if ($this->get_pref('showranges')) {
1216             $rangerow = new html_table_row();
1217             $rangerow->attributes['class'] = 'range r'.$this->rowcount++;
1218             $rangecell = new html_table_cell();
1219             $rangecell->attributes['class'] = 'header range';
1220             $rangecell->colspan = $colspan;
1221             $rangecell->header = true;
1222             $rangecell->scope = 'row';
1223             $rangecell->text = $this->get_lang_string('range','grades');
1224             $rangerow->cells[] = $rangecell;
1225             $rows[] = $rangerow;
1226         }
1228         return $rows;
1229     }
1231     /**
1232      * Builds and return the headers for the rows of averages, for the left part of the grader report.
1233      * @param array $rows The Array of rows for the left part of the report
1234      * @param int $colspan The number of columns this cell has to span
1235      * @param bool $groupavg If true, returns the row for group averages, otherwise for overall averages
1236      * @return array Array of rows for the left part of the report
1237      */
1238     public function get_left_avg_row($rows=array(), $colspan=1, $groupavg=false) {
1239         if (!$this->canviewhidden) {
1240             // totals might be affected by hiding, if user can not see hidden grades the aggregations might be altered
1241             // better not show them at all if user can not see all hideen grades
1242             return $rows;
1243         }
1245         $showaverages = $this->get_pref('showaverages');
1246         $showaveragesgroup = $this->currentgroup && $showaverages;
1247         $straveragegroup = get_string('groupavg', 'grades');
1249         if ($groupavg) {
1250             if ($showaveragesgroup) {
1251                 $groupavgrow = new html_table_row();
1252                 $groupavgrow->attributes['class'] = 'groupavg r'.$this->rowcount++;
1253                 $groupavgcell = new html_table_cell();
1254                 $groupavgcell->attributes['class'] = 'header range';
1255                 $groupavgcell->colspan = $colspan;
1256                 $groupavgcell->header = true;
1257                 $groupavgcell->scope = 'row';
1258                 $groupavgcell->text = $straveragegroup;
1259                 $groupavgrow->cells[] = $groupavgcell;
1260                 $rows[] = $groupavgrow;
1261             }
1262         } else {
1263             $straverage = get_string('overallaverage', 'grades');
1265             if ($showaverages) {
1266                 $avgrow = new html_table_row();
1267                 $avgrow->attributes['class'] = 'avg r'.$this->rowcount++;
1268                 $avgcell = new html_table_cell();
1269                 $avgcell->attributes['class'] = 'header range';
1270                 $avgcell->colspan = $colspan;
1271                 $avgcell->header = true;
1272                 $avgcell->scope = 'row';
1273                 $avgcell->text = $straverage;
1274                 $avgrow->cells[] = $avgcell;
1275                 $rows[] = $avgrow;
1276             }
1277         }
1279         return $rows;
1280     }
1282     /**
1283      * Builds and return the row of icons when editing is on, for the right part of the grader report.
1284      * @param array $rows The Array of rows for the right part of the report
1285      * @return array Array of rows for the right part of the report
1286      */
1287     public function get_right_icons_row($rows=array()) {
1288         global $USER;
1289         if ($USER->gradeediting[$this->courseid]) {
1290             $iconsrow = new html_table_row();
1291             $iconsrow->attributes['class'] = 'controls';
1293             foreach ($this->gtree->items as $itemid=>$unused) {
1294                 // emulate grade element
1295                 $item = $this->gtree->get_item($itemid);
1297                 $eid = $this->gtree->get_item_eid($item);
1298                 $element = $this->gtree->locate_element($eid);
1299                 $itemcell = new html_table_cell();
1300                 $itemcell->attributes['class'] = 'controls icons';
1301                 $itemcell->text = $this->get_icons($element);
1302                 $iconsrow->cells[] = $itemcell;
1303             }
1304             $rows[] = $iconsrow;
1305         }
1306         return $rows;
1307     }
1309     /**
1310      * Builds and return the row of ranges for the right part of the grader report.
1311      * @param array $rows The Array of rows for the right part of the report
1312      * @return array Array of rows for the right part of the report
1313      */
1314     public function get_right_range_row($rows=array()) {
1315         global $OUTPUT;
1317         if ($this->get_pref('showranges')) {
1318             $rangesdisplaytype   = $this->get_pref('rangesdisplaytype');
1319             $rangesdecimalpoints = $this->get_pref('rangesdecimalpoints');
1320             $rangerow = new html_table_row();
1321             $rangerow->attributes['class'] = 'heading range';
1323             foreach ($this->gtree->items as $itemid=>$unused) {
1324                 $item =& $this->gtree->items[$itemid];
1325                 $itemcell = new html_table_cell();
1326                 $itemcell->header = true;
1327                 $itemcell->attributes['class'] .= ' header range';
1329                 $hidden = '';
1330                 if ($item->is_hidden()) {
1331                     $hidden = ' hidden ';
1332                 }
1334                 $formattedrange = $item->get_formatted_range($rangesdisplaytype, $rangesdecimalpoints);
1336                 $itemcell->text = $OUTPUT->container($formattedrange, 'rangevalues'.$hidden);
1337                 $rangerow->cells[] = $itemcell;
1338             }
1339             $rows[] = $rangerow;
1340         }
1341         return $rows;
1342     }
1344     /**
1345      * Builds and return the row of averages for the right part of the grader report.
1346      * @param array $rows Whether to return only group averages or all averages.
1347      * @param bool $grouponly Whether to return only group averages or all averages.
1348      * @return array Array of rows for the right part of the report
1349      */
1350     public function get_right_avg_row($rows=array(), $grouponly=false) {
1351         global $CFG, $USER, $DB, $OUTPUT;
1353         if (!$this->canviewhidden) {
1354             // totals might be affected by hiding, if user can not see hidden grades the aggregations might be altered
1355             // better not show them at all if user can not see all hidden grades
1356             return $rows;
1357         }
1359         $showaverages = $this->get_pref('showaverages');
1360         $showaveragesgroup = $this->currentgroup && $showaverages;
1362         $averagesdisplaytype   = $this->get_pref('averagesdisplaytype');
1363         $averagesdecimalpoints = $this->get_pref('averagesdecimalpoints');
1364         $meanselection         = $this->get_pref('meanselection');
1365         $shownumberofgrades    = $this->get_pref('shownumberofgrades');
1367         $avghtml = '';
1368         $avgcssclass = 'avg';
1370         if ($grouponly) {
1371             $straverage = get_string('groupavg', 'grades');
1372             $showaverages = $this->currentgroup && $this->get_pref('showaverages');
1373             $groupsql = $this->groupsql;
1374             $groupwheresql = $this->groupwheresql;
1375             $groupwheresqlparams = $this->groupwheresql_params;
1376             $avgcssclass = 'groupavg';
1377         } else {
1378             $straverage = get_string('overallaverage', 'grades');
1379             $showaverages = $this->get_pref('showaverages');
1380             $groupsql = "";
1381             $groupwheresql = "";
1382             $groupwheresqlparams = array();
1383         }
1385         if ($shownumberofgrades) {
1386             $straverage .= ' (' . get_string('submissions', 'grades') . ') ';
1387         }
1389         $totalcount = $this->get_numusers($grouponly);
1391         //limit to users with a gradeable role
1392         list($gradebookrolessql, $gradebookrolesparams) = $DB->get_in_or_equal(explode(',', $this->gradebookroles), SQL_PARAMS_NAMED, 'grbr0');
1394         //limit to users with an active enrollment
1395         list($enrolledsql, $enrolledparams) = get_enrolled_sql($this->context);
1397         if ($showaverages) {
1398             $params = array_merge(array('courseid'=>$this->courseid), $gradebookrolesparams, $enrolledparams, $groupwheresqlparams);
1400             // find sums of all grade items in course
1401             $sql = "SELECT g.itemid, SUM(g.finalgrade) AS sum
1402                       FROM {grade_items} gi
1403                       JOIN {grade_grades} g ON g.itemid = gi.id
1404                       JOIN {user} u ON u.id = g.userid
1405                       JOIN ($enrolledsql) je ON je.id = u.id
1406                       JOIN (
1407                                SELECT DISTINCT ra.userid
1408                                  FROM {role_assignments} ra
1409                                 WHERE ra.roleid $gradebookrolessql
1410                                   AND ra.contextid " . get_related_contexts_string($this->context) . "
1411                            ) rainner ON rainner.userid = u.id
1412                       $groupsql
1413                      WHERE gi.courseid = :courseid
1414                        AND u.deleted = 0
1415                        AND g.finalgrade IS NOT NULL
1416                        $groupwheresql
1417                      GROUP BY g.itemid";
1418             $sumarray = array();
1419             if ($sums = $DB->get_records_sql($sql, $params)) {
1420                 foreach ($sums as $itemid => $csum) {
1421                     $sumarray[$itemid] = $csum->sum;
1422                 }
1423             }
1425             // MDL-10875 Empty grades must be evaluated as grademin, NOT always 0
1426             // This query returns a count of ungraded grades (NULL finalgrade OR no matching record in grade_grades table)
1427             $sql = "SELECT gi.id, COUNT(DISTINCT u.id) AS count
1428                       FROM {grade_items} gi
1429                       CROSS JOIN {user} u
1430                       JOIN ($enrolledsql) je
1431                            ON je.id = u.id
1432                       JOIN {role_assignments} ra
1433                            ON ra.userid = u.id
1434                       LEFT OUTER JOIN {grade_grades} g
1435                            ON (g.itemid = gi.id AND g.userid = u.id AND g.finalgrade IS NOT NULL)
1436                       $groupsql
1437                      WHERE gi.courseid = :courseid
1438                            AND ra.roleid $gradebookrolessql
1439                            AND ra.contextid ".get_related_contexts_string($this->context)."
1440                            AND u.deleted = 0
1441                            AND g.id IS NULL
1442                            $groupwheresql
1443                   GROUP BY gi.id";
1445             $ungradedcounts = $DB->get_records_sql($sql, $params);
1447             $avgrow = new html_table_row();
1448             $avgrow->attributes['class'] = 'avg';
1450             foreach ($this->gtree->items as $itemid=>$unused) {
1451                 $item =& $this->gtree->items[$itemid];
1453                 if ($item->needsupdate) {
1454                     $avgcell = new html_table_cell();
1455                     $avgcell->text = $OUTPUT->container(get_string('error'), 'gradingerror');
1456                     $avgrow->cells[] = $avgcell;
1457                     continue;
1458                 }
1460                 if (!isset($sumarray[$item->id])) {
1461                     $sumarray[$item->id] = 0;
1462                 }
1464                 if (empty($ungradedcounts[$itemid])) {
1465                     $ungradedcount = 0;
1466                 } else {
1467                     $ungradedcount = $ungradedcounts[$itemid]->count;
1468                 }
1470                 if ($meanselection == GRADE_REPORT_MEAN_GRADED) {
1471                     $meancount = $totalcount - $ungradedcount;
1472                 } else { // Bump up the sum by the number of ungraded items * grademin
1473                     $sumarray[$item->id] += $ungradedcount * $item->grademin;
1474                     $meancount = $totalcount;
1475                 }
1477                 $decimalpoints = $item->get_decimals();
1479                 // Determine which display type to use for this average
1480                 if ($USER->gradeediting[$this->courseid]) {
1481                     $displaytype = GRADE_DISPLAY_TYPE_REAL;
1483                 } else if ($averagesdisplaytype == GRADE_REPORT_PREFERENCE_INHERIT) { // no ==0 here, please resave the report and user preferences
1484                     $displaytype = $item->get_displaytype();
1486                 } else {
1487                     $displaytype = $averagesdisplaytype;
1488                 }
1490                 // Override grade_item setting if a display preference (not inherit) was set for the averages
1491                 if ($averagesdecimalpoints == GRADE_REPORT_PREFERENCE_INHERIT) {
1492                     $decimalpoints = $item->get_decimals();
1494                 } else {
1495                     $decimalpoints = $averagesdecimalpoints;
1496                 }
1498                 if (!isset($sumarray[$item->id]) || $meancount == 0) {
1499                     $avgcell = new html_table_cell();
1500                     $avgcell->text = '-';
1501                     $avgrow->cells[] = $avgcell;
1503                 } else {
1504                     $sum = $sumarray[$item->id];
1505                     $avgradeval = $sum/$meancount;
1506                     $gradehtml = grade_format_gradevalue($avgradeval, $item, true, $displaytype, $decimalpoints);
1508                     $numberofgrades = '';
1509                     if ($shownumberofgrades) {
1510                         $numberofgrades = " ($meancount)";
1511                     }
1513                     $avgcell = new html_table_cell();
1514                     $avgcell->text = $gradehtml.$numberofgrades;
1515                     $avgrow->cells[] = $avgcell;
1516                 }
1517             }
1518             $rows[] = $avgrow;
1519         }
1520         return $rows;
1521     }
1523     /**
1524      * Given a grade_category, grade_item or grade_grade, this function
1525      * figures out the state of the object and builds then returns a div
1526      * with the icons needed for the grader report.
1527      *
1528      * @param array $object
1529      * @return string HTML
1530      */
1531     protected function get_icons($element) {
1532         global $CFG, $USER, $OUTPUT;
1534         if (!$USER->gradeediting[$this->courseid]) {
1535             return '<div class="grade_icons" />';
1536         }
1538         // Init all icons
1539         $editicon = '';
1541         if ($element['type'] != 'categoryitem' && $element['type'] != 'courseitem') {
1542             $editicon = $this->gtree->get_edit_icon($element, $this->gpr);
1543         }
1545         $editcalculationicon = '';
1546         $showhideicon        = '';
1547         $lockunlockicon      = '';
1549         if (has_capability('moodle/grade:manage', $this->context)) {
1550             if ($this->get_pref('showcalculations')) {
1551                 $editcalculationicon = $this->gtree->get_calculation_icon($element, $this->gpr);
1552             }
1554             if ($this->get_pref('showeyecons')) {
1555                $showhideicon = $this->gtree->get_hiding_icon($element, $this->gpr);
1556             }
1558             if ($this->get_pref('showlocks')) {
1559                 $lockunlockicon = $this->gtree->get_locking_icon($element, $this->gpr);
1560             }
1562         }
1564         $gradeanalysisicon   = '';
1565         if ($this->get_pref('showanalysisicon') && $element['type'] == 'grade') {
1566             $gradeanalysisicon .= $this->gtree->get_grade_analysis_icon($element['object']);
1567         }
1569         return $OUTPUT->container($editicon.$editcalculationicon.$showhideicon.$lockunlockicon.$gradeanalysisicon, 'grade_icons');
1570     }
1572     /**
1573      * Given a category element returns collapsing +/- icon if available
1574      * @param object $object
1575      * @return string HTML
1576      */
1577     protected function get_collapsing_icon($element) {
1578         global $OUTPUT;
1580         $icon = '';
1581         // If object is a category, display expand/contract icon
1582         if ($element['type'] == 'category') {
1583             // Load language strings
1584             $strswitchminus = $this->get_lang_string('aggregatesonly', 'grades');
1585             $strswitchplus  = $this->get_lang_string('gradesonly', 'grades');
1586             $strswitchwhole = $this->get_lang_string('fullmode', 'grades');
1588             $url = new moodle_url($this->gpr->get_return_url(null, array('target'=>$element['eid'], 'sesskey'=>sesskey())));
1590             if (in_array($element['object']->id, $this->collapsed['aggregatesonly'])) {
1591                 $url->param('action', 'switch_plus');
1592                 $icon = $OUTPUT->action_icon($url, new pix_icon('t/switch_plus', $strswitchplus));
1594             } else if (in_array($element['object']->id, $this->collapsed['gradesonly'])) {
1595                 $url->param('action', 'switch_whole');
1596                 $icon = $OUTPUT->action_icon($url, new pix_icon('t/switch_whole', $strswitchwhole));
1598             } else {
1599                 $url->param('action', 'switch_minus');
1600                 $icon = $OUTPUT->action_icon($url, new pix_icon('t/switch_minus', $strswitchminus));
1601             }
1602         }
1603         return $icon;
1604     }
1606     public function process_action($target, $action) {
1607         return self::do_process_action($target, $action);
1608     }
1610     /**
1611      * Processes a single action against a category, grade_item or grade.
1612      * @param string $target eid ({type}{id}, e.g. c4 for category4)
1613      * @param string $action Which action to take (edit, delete etc...)
1614      * @return
1615      */
1616     public static function do_process_action($target, $action) {
1617         // TODO: this code should be in some grade_tree static method
1618         $targettype = substr($target, 0, 1);
1619         $targetid = substr($target, 1);
1620         // TODO: end
1622         if ($collapsed = get_user_preferences('grade_report_grader_collapsed_categories')) {
1623             $collapsed = unserialize($collapsed);
1624         } else {
1625             $collapsed = array('aggregatesonly' => array(), 'gradesonly' => array());
1626         }
1628         switch ($action) {
1629             case 'switch_minus': // Add category to array of aggregatesonly
1630                 if (!in_array($targetid, $collapsed['aggregatesonly'])) {
1631                     $collapsed['aggregatesonly'][] = $targetid;
1632                     set_user_preference('grade_report_grader_collapsed_categories', serialize($collapsed));
1633                 }
1634                 break;
1636             case 'switch_plus': // Remove category from array of aggregatesonly, and add it to array of gradesonly
1637                 $key = array_search($targetid, $collapsed['aggregatesonly']);
1638                 if ($key !== false) {
1639                     unset($collapsed['aggregatesonly'][$key]);
1640                 }
1641                 if (!in_array($targetid, $collapsed['gradesonly'])) {
1642                     $collapsed['gradesonly'][] = $targetid;
1643                 }
1644                 set_user_preference('grade_report_grader_collapsed_categories', serialize($collapsed));
1645                 break;
1646             case 'switch_whole': // Remove the category from the array of collapsed cats
1647                 $key = array_search($targetid, $collapsed['gradesonly']);
1648                 if ($key !== false) {
1649                     unset($collapsed['gradesonly'][$key]);
1650                     set_user_preference('grade_report_grader_collapsed_categories', serialize($collapsed));
1651                 }
1653                 break;
1654             default:
1655                 break;
1656         }
1658         return true;
1659     }
1661     /**
1662      * Returns whether or not to display fixed students column.
1663      * Includes a browser check, because IE6 doesn't support the scrollbar.
1664      *
1665      * @return bool
1666      */
1667     public function is_fixed_students() {
1668         global $USER, $CFG;
1669         return $CFG->grade_report_fixedstudents &&
1670             (check_browser_version('MSIE', '7.0') ||
1671              check_browser_version('Firefox', '2.0') ||
1672              check_browser_version('Gecko', '2006010100') ||
1673              check_browser_version('Camino', '1.0') ||
1674              check_browser_version('Opera', '6.0') ||
1675              check_browser_version('Chrome', '6') ||
1676              check_browser_version('Safari', '300'));
1677     }
1679     /**
1680      * Refactored function for generating HTML of sorting links with matching arrows.
1681      * Returns an array with 'studentname' and 'idnumber' as keys, with HTML ready
1682      * to inject into a table header cell.
1683      * @param array $extrafields Array of extra fields being displayed, such as
1684      *   user idnumber
1685      * @return array An associative array of HTML sorting links+arrows
1686      */
1687     public function get_sort_arrows(array $extrafields = array()) {
1688         global $OUTPUT;
1689         $arrows = array();
1691         $strsortasc   = $this->get_lang_string('sortasc', 'grades');
1692         $strsortdesc  = $this->get_lang_string('sortdesc', 'grades');
1693         $strfirstname = $this->get_lang_string('firstname');
1694         $strlastname  = $this->get_lang_string('lastname');
1695         $iconasc = $OUTPUT->pix_icon('t/sort_asc', $strsortasc, '', array('class' => 'iconsmall sorticon'));
1696         $icondesc = $OUTPUT->pix_icon('t/sort_desc', $strsortdesc, '', array('class' => 'iconsmall sorticon'));
1698         $firstlink = html_writer::link(new moodle_url($this->baseurl, array('sortitemid'=>'firstname')), $strfirstname);
1699         $lastlink = html_writer::link(new moodle_url($this->baseurl, array('sortitemid'=>'lastname')), $strlastname);
1701         $arrows['studentname'] = $lastlink;
1703         if ($this->sortitemid === 'lastname') {
1704             if ($this->sortorder == 'ASC') {
1705                 $arrows['studentname'] .= $iconasc;
1706             } else {
1707                 $arrows['studentname'] .= $icondesc;
1708             }
1709         }
1711         $arrows['studentname'] .= ' ' . $firstlink;
1713         if ($this->sortitemid === 'firstname') {
1714             if ($this->sortorder == 'ASC') {
1715                 $arrows['studentname'] .= $iconasc;
1716             } else {
1717                 $arrows['studentname'] .= $icondesc;
1718             }
1719         }
1721         foreach ($extrafields as $field) {
1722             $fieldlink = html_writer::link(new moodle_url($this->baseurl,
1723                     array('sortitemid'=>$field)), get_user_field_name($field));
1724             $arrows[$field] = $fieldlink;
1726             if ($field == $this->sortitemid) {
1727                 if ($this->sortorder == 'ASC') {
1728                     $arrows[$field] .= $iconasc;
1729                 } else {
1730                     $arrows[$field] .= $icondesc;
1731                 }
1732             }
1733         }
1735         return $arrows;
1736     }
1738     /**
1739      * Returns the maximum number of students to be displayed on each page
1740      *
1741      * Takes into account the 'studentsperpage' user preference and the 'max_input_vars'
1742      * PHP setting. Too many fields is only a problem when submitting grades but
1743      * we respect 'max_input_vars' even when viewing grades to prevent students disappearing
1744      * when toggling editing on and off.
1745      *
1746      * @return int The maximum number of students to display per page
1747      */
1748     public function get_students_per_page() {
1749         global $USER;
1750         static $studentsperpage = null;
1752         if ($studentsperpage === null) {
1753             $originalstudentsperpage = $studentsperpage = $this->get_pref('studentsperpage');
1755             // Will this number of students result in more fields that we are allowed?
1756             $maxinputvars = ini_get('max_input_vars');
1757             if ($maxinputvars !== false) {
1758                 // We can't do anything about there being more grade items than max_input_vars,
1759                 // but we can decrease number of students per page if there are >= max_input_vars
1760                 $fieldsperstudent = 0; // The number of fields output per student
1762                 if ($this->get_pref('quickgrading') || $this->get_pref('showquickfeedback')) {
1763                     // Each array (grade, feedback) will gain one element
1764                     $fieldsperstudent ++;
1765                 }
1767                 $fieldsrequired = $studentsperpage * $fieldsperstudent;
1768                 if ($fieldsrequired >= $maxinputvars) {
1769                     $studentsperpage = $maxinputvars - 1; // Subtract one to be on the safe side
1770                     if ($studentsperpage<1) {
1771                         // Make sure students per page doesn't fall below 1, though if your
1772                         // max_input_vars is only 1 you've got bigger problems!
1773                         $studentsperpage = 1;
1774                     }
1776                     $a = new stdClass();
1777                     $a->originalstudentsperpage = $originalstudentsperpage;
1778                     $a->studentsperpage = $studentsperpage;
1779                     $a->maxinputvars = $maxinputvars;
1780                     debugging(get_string('studentsperpagereduced', 'grades', $a));
1781                 }
1782             }
1783         }
1785         return $studentsperpage;
1786     }