Merge branch 'MDL-51536-master' of git://github.com/damyon/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  * @copyright 2007 Nicolas Connault
32  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
33  */
34 class grade_report_grader extends grade_report {
35     /**
36      * The final grades.
37      * @var array $grades
38      */
39     public $grades;
41     /**
42      * Array of errors for bulk grades updating.
43      * @var array $gradeserror
44      */
45     public $gradeserror = array();
47     // SQL-RELATED
49     /**
50      * The id of the grade_item by which this report will be sorted.
51      * @var int $sortitemid
52      */
53     public $sortitemid;
55     /**
56      * Sortorder used in the SQL selections.
57      * @var int $sortorder
58      */
59     public $sortorder;
61     /**
62      * An SQL fragment affecting the search for users.
63      * @var string $userselect
64      */
65     public $userselect;
67     /**
68      * The bound params for $userselect
69      * @var array $userselectparams
70      */
71     public $userselectparams = array();
73     /**
74      * List of collapsed categories from user preference
75      * @var array $collapsed
76      */
77     public $collapsed;
79     /**
80      * A count of the rows, used for css classes.
81      * @var int $rowcount
82      */
83     public $rowcount = 0;
85     /**
86      * Capability check caching
87      * @var boolean $canviewhidden
88      */
89     public $canviewhidden;
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      * Allow category grade overriding
100      * @var bool $overridecat
101      */
102     protected $overridecat;
104     /**
105      * Constructor. Sets local copies of user preferences and initialises grade_tree.
106      * @param int $courseid
107      * @param object $gpr grade plugin return tracking object
108      * @param string $context
109      * @param int $page The current page being viewed (when report is paged)
110      * @param int $sortitemid The id of the grade_item by which to sort the table
111      */
112     public function __construct($courseid, $gpr, $context, $page=null, $sortitemid=null) {
113         global $CFG;
114         parent::__construct($courseid, $gpr, $context, $page);
116         $this->canviewhidden = has_capability('moodle/grade:viewhidden', context_course::instance($this->course->id));
118         // load collapsed settings for this report
119         $this->collapsed = static::get_collapsed_preferences($this->course->id);
121         if (empty($CFG->enableoutcomes)) {
122             $nooutcomes = false;
123         } else {
124             $nooutcomes = get_user_preferences('grade_report_shownooutcomes');
125         }
127         // if user report preference set or site report setting set use it, otherwise use course or site setting
128         $switch = $this->get_pref('aggregationposition');
129         if ($switch == '') {
130             $switch = grade_get_setting($this->courseid, 'aggregationposition', $CFG->grade_aggregationposition);
131         }
133         // Grab the grade_tree for this course
134         $this->gtree = new grade_tree($this->courseid, true, $switch, $this->collapsed, $nooutcomes);
136         $this->sortitemid = $sortitemid;
138         // base url for sorting by first/last name
140         $this->baseurl = new moodle_url('index.php', array('id' => $this->courseid));
142         $studentsperpage = $this->get_students_per_page();
143         if (!empty($this->page) && !empty($studentsperpage)) {
144             $this->baseurl->params(array('perpage' => $studentsperpage, 'page' => $this->page));
145         }
147         $this->pbarurl = new moodle_url('/grade/report/grader/index.php', array('id' => $this->courseid));
149         $this->setup_groups();
150         $this->setup_users();
151         $this->setup_sortitemid();
153         $this->overridecat = (bool)get_config('moodle', 'grade_overridecat');
154     }
156     /**
157      * Processes the data sent by the form (grades and feedbacks).
158      * Caller is responsible for all access control checks
159      * @param array $data form submission (with magic quotes)
160      * @return array empty array if success, array of warnings if something fails.
161      */
162     public function process_data($data) {
163         global $DB;
164         $warnings = array();
166         $separategroups = false;
167         $mygroups       = array();
168         if ($this->groupmode == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $this->context)) {
169             $separategroups = true;
170             $mygroups = groups_get_user_groups($this->course->id);
171             $mygroups = $mygroups[0]; // ignore groupings
172             // reorder the groups fro better perf below
173             $current = array_search($this->currentgroup, $mygroups);
174             if ($current !== false) {
175                 unset($mygroups[$current]);
176                 array_unshift($mygroups, $this->currentgroup);
177             }
178         }
180         // always initialize all arrays
181         $queue = array();
183         $this->load_users();
184         $this->load_final_grades();
186         // Were any changes made?
187         $changedgrades = false;
188         $timepageload = clean_param($data->timepageload, PARAM_INT);
190         foreach ($data as $varname => $students) {
192             $needsupdate = false;
194             // skip, not a grade nor feedback
195             if (strpos($varname, 'grade') === 0) {
196                 $datatype = 'grade';
197             } else if (strpos($varname, 'feedback') === 0) {
198                 $datatype = 'feedback';
199             } else {
200                 continue;
201             }
203             foreach ($students as $userid => $items) {
204                 $userid = clean_param($userid, PARAM_INT);
205                 foreach ($items as $itemid => $postedvalue) {
206                     $itemid = clean_param($itemid, PARAM_INT);
208                     // Was change requested?
209                     $oldvalue = $this->grades[$userid][$itemid];
210                     if ($datatype === 'grade') {
211                         // If there was no grade and there still isn't
212                         if (is_null($oldvalue->finalgrade) && $postedvalue == -1) {
213                             // -1 means no grade
214                             continue;
215                         }
217                         // If the grade item uses a custom scale
218                         if (!empty($oldvalue->grade_item->scaleid)) {
220                             if ((int)$oldvalue->finalgrade === (int)$postedvalue) {
221                                 continue;
222                             }
223                         } else {
224                             // The grade item uses a numeric scale
226                             // Format the finalgrade from the DB so that it matches the grade from the client
227                             if ($postedvalue === format_float($oldvalue->finalgrade, $oldvalue->grade_item->get_decimals())) {
228                                 continue;
229                             }
230                         }
232                         $changedgrades = true;
234                     } else if ($datatype === 'feedback') {
235                         // If quick grading is on, feedback needs to be compared without line breaks.
236                         if ($this->get_pref('quickgrading')) {
237                             $oldvalue->feedback = preg_replace("/\r\n|\r|\n/", "", $oldvalue->feedback);
238                         }
239                         if (($oldvalue->feedback === $postedvalue) or ($oldvalue->feedback === null and empty($postedvalue))) {
240                             continue;
241                         }
242                     }
244                     if (!$gradeitem = grade_item::fetch(array('id'=>$itemid, 'courseid'=>$this->courseid))) {
245                         print_error('invalidgradeitemid');
246                     }
248                     // Pre-process grade
249                     if ($datatype == 'grade') {
250                         $feedback = false;
251                         $feedbackformat = false;
252                         if ($gradeitem->gradetype == GRADE_TYPE_SCALE) {
253                             if ($postedvalue == -1) { // -1 means no grade
254                                 $finalgrade = null;
255                             } else {
256                                 $finalgrade = $postedvalue;
257                             }
258                         } else {
259                             $finalgrade = unformat_float($postedvalue);
260                         }
262                         $errorstr = '';
263                         $skip = false;
265                         $dategraded = $oldvalue->get_dategraded();
266                         if (!empty($dategraded) && $timepageload < $dategraded) {
267                             // Warn if the grade was updated while we were editing this form.
268                             $errorstr = 'gradewasmodifiedduringediting';
269                             $skip = true;
270                         } else if (!is_null($finalgrade)) {
271                             // Warn if the grade is out of bounds.
272                             $bounded = $gradeitem->bounded_grade($finalgrade);
273                             if ($bounded > $finalgrade) {
274                                 $errorstr = 'lessthanmin';
275                             } else if ($bounded < $finalgrade) {
276                                 $errorstr = 'morethanmax';
277                             }
278                         }
280                         if ($errorstr) {
281                             $userfields = 'id, ' . get_all_user_name_fields(true);
282                             $user = $DB->get_record('user', array('id' => $userid), $userfields);
283                             $gradestr = new stdClass();
284                             $gradestr->username = fullname($user);
285                             $gradestr->itemname = $gradeitem->get_name();
286                             $warnings[] = get_string($errorstr, 'grades', $gradestr);
287                             if ($skip) {
288                                 // Skipping the update of this grade it failed the tests above.
289                                 continue;
290                             }
291                         }
293                     } else if ($datatype == 'feedback') {
294                         $finalgrade = false;
295                         $trimmed = trim($postedvalue);
296                         if (empty($trimmed)) {
297                              $feedback = null;
298                         } else {
299                              $feedback = $postedvalue;
300                         }
301                     }
303                     // group access control
304                     if ($separategroups) {
305                         // note: we can not use $this->currentgroup because it would fail badly
306                         //       when having two browser windows each with different group
307                         $sharinggroup = false;
308                         foreach ($mygroups as $groupid) {
309                             if (groups_is_member($groupid, $userid)) {
310                                 $sharinggroup = true;
311                                 break;
312                             }
313                         }
314                         if (!$sharinggroup) {
315                             // either group membership changed or somebody is hacking grades of other group
316                             $warnings[] = get_string('errorsavegrade', 'grades');
317                             continue;
318                         }
319                     }
321                     $gradeitem->update_final_grade($userid, $finalgrade, 'gradebook', $feedback, FORMAT_MOODLE);
323                     // We can update feedback without reloading the grade item as it doesn't affect grade calculations
324                     if ($datatype === 'feedback') {
325                         $this->grades[$userid][$itemid]->feedback = $feedback;
326                     }
327                 }
328             }
329         }
331         if ($changedgrades) {
332             // If a final grade was overriden reload grades so dependent grades like course total will be correct
333             $this->grades = null;
334         }
336         return $warnings;
337     }
340     /**
341      * Setting the sort order, this depends on last state
342      * all this should be in the new table class that we might need to use
343      * for displaying grades.
344      */
345     private function setup_sortitemid() {
347         global $SESSION;
349         if (!isset($SESSION->gradeuserreport)) {
350             $SESSION->gradeuserreport = new stdClass();
351         }
353         if ($this->sortitemid) {
354             if (!isset($SESSION->gradeuserreport->sort)) {
355                 if ($this->sortitemid == 'firstname' || $this->sortitemid == 'lastname') {
356                     $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC';
357                 } else {
358                     $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC';
359                 }
360             } else {
361                 // this is the first sort, i.e. by last name
362                 if (!isset($SESSION->gradeuserreport->sortitemid)) {
363                     if ($this->sortitemid == 'firstname' || $this->sortitemid == 'lastname') {
364                         $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC';
365                     } else {
366                         $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC';
367                     }
368                 } else if ($SESSION->gradeuserreport->sortitemid == $this->sortitemid) {
369                     // same as last sort
370                     if ($SESSION->gradeuserreport->sort == 'ASC') {
371                         $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC';
372                     } else {
373                         $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC';
374                     }
375                 } else {
376                     if ($this->sortitemid == 'firstname' || $this->sortitemid == 'lastname') {
377                         $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC';
378                     } else {
379                         $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC';
380                     }
381                 }
382             }
383             $SESSION->gradeuserreport->sortitemid = $this->sortitemid;
384         } else {
385             // not requesting sort, use last setting (for paging)
387             if (isset($SESSION->gradeuserreport->sortitemid)) {
388                 $this->sortitemid = $SESSION->gradeuserreport->sortitemid;
389             } else {
390                 $this->sortitemid = 'lastname';
391             }
393             if (isset($SESSION->gradeuserreport->sort)) {
394                 $this->sortorder = $SESSION->gradeuserreport->sort;
395             } else {
396                 $this->sortorder = 'ASC';
397             }
398         }
399     }
401     /**
402      * pulls out the userids of the users to be display, and sorts them
403      */
404     public function load_users() {
405         global $CFG, $DB;
407         if (!empty($this->users)) {
408             return;
409         }
410         $this->setup_users();
412         // Limit to users with a gradeable role.
413         list($gradebookrolessql, $gradebookrolesparams) = $DB->get_in_or_equal(explode(',', $this->gradebookroles), SQL_PARAMS_NAMED, 'grbr0');
415         // Check the status of showing only active enrolments.
416         $coursecontext = $this->context->get_course_context(true);
417         $defaultgradeshowactiveenrol = !empty($CFG->grade_report_showonlyactiveenrol);
418         $showonlyactiveenrol = get_user_preferences('grade_report_showonlyactiveenrol', $defaultgradeshowactiveenrol);
419         $showonlyactiveenrol = $showonlyactiveenrol || !has_capability('moodle/course:viewsuspendedusers', $coursecontext);
421         // Limit to users with an active enrollment.
422         list($enrolledsql, $enrolledparams) = get_enrolled_sql($this->context, '', 0, $showonlyactiveenrol);
424         // Fields we need from the user table.
425         $userfields = user_picture::fields('u', get_extra_user_fields($this->context));
427         // We want to query both the current context and parent contexts.
428         list($relatedctxsql, $relatedctxparams) = $DB->get_in_or_equal($this->context->get_parent_context_ids(true), SQL_PARAMS_NAMED, 'relatedctx');
430         // If the user has clicked one of the sort asc/desc arrows.
431         if (is_numeric($this->sortitemid)) {
432             $params = array_merge(array('gitemid' => $this->sortitemid), $gradebookrolesparams, $this->userwheresql_params,
433                     $this->groupwheresql_params, $enrolledparams, $relatedctxparams);
435             $sortjoin = "LEFT JOIN {grade_grades} g ON g.userid = u.id AND g.itemid = $this->sortitemid";
436             $sort = "g.finalgrade $this->sortorder";
437         } else {
438             $sortjoin = '';
439             switch($this->sortitemid) {
440                 case 'lastname':
441                     $sort = "u.lastname $this->sortorder, u.firstname $this->sortorder";
442                     break;
443                 case 'firstname':
444                     $sort = "u.firstname $this->sortorder, u.lastname $this->sortorder";
445                     break;
446                 case 'email':
447                     $sort = "u.email $this->sortorder";
448                     break;
449                 case 'idnumber':
450                 default:
451                     $sort = "u.idnumber $this->sortorder";
452                     break;
453             }
455             $params = array_merge($gradebookrolesparams, $this->userwheresql_params, $this->groupwheresql_params, $enrolledparams, $relatedctxparams);
456         }
458         $sql = "SELECT $userfields
459                   FROM {user} u
460                   JOIN ($enrolledsql) je ON je.id = u.id
461                        $this->groupsql
462                        $sortjoin
463                   JOIN (
464                            SELECT DISTINCT ra.userid
465                              FROM {role_assignments} ra
466                             WHERE ra.roleid IN ($this->gradebookroles)
467                               AND ra.contextid $relatedctxsql
468                        ) rainner ON rainner.userid = u.id
469                    AND u.deleted = 0
470                    $this->userwheresql
471                    $this->groupwheresql
472               ORDER BY $sort";
473         $studentsperpage = $this->get_students_per_page();
474         $this->users = $DB->get_records_sql($sql, $params, $studentsperpage * $this->page, $studentsperpage);
476         if (empty($this->users)) {
477             $this->userselect = '';
478             $this->users = array();
479             $this->userselect_params = array();
480         } else {
481             list($usql, $uparams) = $DB->get_in_or_equal(array_keys($this->users), SQL_PARAMS_NAMED, 'usid0');
482             $this->userselect = "AND g.userid $usql";
483             $this->userselect_params = $uparams;
485             // First flag everyone as not suspended.
486             foreach ($this->users as $user) {
487                 $this->users[$user->id]->suspendedenrolment = false;
488             }
490             // If we want to mix both suspended and not suspended users, let's find out who is suspended.
491             if (!$showonlyactiveenrol) {
492                 $sql = "SELECT ue.userid
493                           FROM {user_enrolments} ue
494                           JOIN {enrol} e ON e.id = ue.enrolid
495                          WHERE ue.userid $usql
496                                AND ue.status = :uestatus
497                                AND e.status = :estatus
498                                AND e.courseid = :courseid
499                                AND ue.timestart < :now1 AND (ue.timeend = 0 OR ue.timeend > :now2)
500                       GROUP BY ue.userid";
502                 $time = time();
503                 $params = array_merge($uparams, array('estatus' => ENROL_INSTANCE_ENABLED, 'uestatus' => ENROL_USER_ACTIVE,
504                         'courseid' => $coursecontext->instanceid, 'now1' => $time, 'now2' => $time));
505                 $useractiveenrolments = $DB->get_records_sql($sql, $params);
507                 foreach ($this->users as $user) {
508                     $this->users[$user->id]->suspendedenrolment = !array_key_exists($user->id, $useractiveenrolments);
509                 }
510             }
511         }
512         return $this->users;
513     }
515     /**
516      * we supply the userids in this query, and get all the grades
517      * pulls out all the grades, this does not need to worry about paging
518      */
519     public function load_final_grades() {
520         global $CFG, $DB;
522         if (!empty($this->grades)) {
523             return;
524         }
526         if (empty($this->users)) {
527             return;
528         }
530         // please note that we must fetch all grade_grades fields if we want to construct grade_grade object from it!
531         $params = array_merge(array('courseid'=>$this->courseid), $this->userselect_params);
532         $sql = "SELECT g.*
533                   FROM {grade_items} gi,
534                        {grade_grades} g
535                  WHERE g.itemid = gi.id AND gi.courseid = :courseid {$this->userselect}";
537         $userids = array_keys($this->users);
539         if ($grades = $DB->get_records_sql($sql, $params)) {
540             foreach ($grades as $graderec) {
541                 if (in_array($graderec->userid, $userids) and array_key_exists($graderec->itemid, $this->gtree->get_items())) { // some items may not be present!!
542                     $this->grades[$graderec->userid][$graderec->itemid] = new grade_grade($graderec, false);
543                     $this->grades[$graderec->userid][$graderec->itemid]->grade_item = $this->gtree->get_item($graderec->itemid); // db caching
544                 }
545             }
546         }
548         // prefil grades that do not exist yet
549         foreach ($userids as $userid) {
550             foreach ($this->gtree->get_items() as $itemid => $unused) {
551                 if (!isset($this->grades[$userid][$itemid])) {
552                     $this->grades[$userid][$itemid] = new grade_grade();
553                     $this->grades[$userid][$itemid]->itemid = $itemid;
554                     $this->grades[$userid][$itemid]->userid = $userid;
555                     $this->grades[$userid][$itemid]->grade_item = $this->gtree->get_item($itemid); // db caching
556                 }
557             }
558         }
559     }
561     /**
562      * Gets html toggle
563      * @deprecated since Moodle 2.4 as it appears not to be used any more.
564      */
565     public function get_toggles_html() {
566         throw new coding_exception('get_toggles_html() can not be used any more');
567     }
569     /**
570      * Prints html toggle
571      * @deprecated since 2.4 as it appears not to be used any more.
572      * @param unknown $type
573      */
574     public function print_toggle($type) {
575         throw new coding_exception('print_toggle() can not be used any more');
576     }
578     /**
579      * Builds and returns the rows that will make up the left part of the grader report
580      * This consists of student names and icons, links to user reports and id numbers, as well
581      * as header cells for these columns. It also includes the fillers required for the
582      * categories displayed on the right side of the report.
583      * @param boolean $displayaverages whether to display average rows in the table
584      * @return array Array of html_table_row objects
585      */
586     public function get_left_rows($displayaverages) {
587         global $CFG, $USER, $OUTPUT;
589         $rows = array();
591         $showuserimage = $this->get_pref('showuserimage');
592         $canseeuserreport = has_capability('gradereport/'.$CFG->grade_profilereport.':view', $this->context);
593         $canseesingleview = has_all_capabilities(array('gradereport/singleview:view', 'moodle/grade:viewall',
594             'moodle/grade:edit'), $this->context);
595         $hasuserreportcell = $canseeuserreport || $canseesingleview;
597         $strfeedback  = $this->get_lang_string("feedback");
598         $strgrade     = $this->get_lang_string('grade');
600         $extrafields = get_extra_user_fields($this->context);
602         $arrows = $this->get_sort_arrows($extrafields);
604         $colspan = 1 + $hasuserreportcell + count($extrafields);
606         $levels = count($this->gtree->levels) - 1;
608         $fillercell = new html_table_cell();
609         $fillercell->header = true;
610         $fillercell->attributes['scope'] = 'col';
611         $fillercell->attributes['class'] = 'cell topleft';
612         $fillercell->text = html_writer::span(get_string('participants'), 'accesshide');
613         $fillercell->colspan = $colspan;
614         $fillercell->rowspan = $levels;
615         $row = new html_table_row(array($fillercell));
616         $rows[] = $row;
618         for ($i = 1; $i < $levels; $i++) {
619             $row = new html_table_row();
620             $rows[] = $row;
621         }
623         $headerrow = new html_table_row();
624         $headerrow->attributes['class'] = 'heading';
626         $studentheader = new html_table_cell();
627         $studentheader->attributes['class'] = 'header';
628         $studentheader->scope = 'col';
629         $studentheader->header = true;
630         $studentheader->id = 'studentheader';
631         if ($hasuserreportcell) {
632             $studentheader->colspan = 2;
633         }
634         $studentheader->text = $arrows['studentname'];
636         $headerrow->cells[] = $studentheader;
638         foreach ($extrafields as $field) {
639             $fieldheader = new html_table_cell();
640             $fieldheader->attributes['class'] = 'header userfield user' . $field;
641             $fieldheader->scope = 'col';
642             $fieldheader->header = true;
643             $fieldheader->text = $arrows[$field];
645             $headerrow->cells[] = $fieldheader;
646         }
648         $rows[] = $headerrow;
650         $rows = $this->get_left_icons_row($rows, $colspan);
652         $suspendedstring = null;
653         foreach ($this->users as $userid => $user) {
654             $userrow = new html_table_row();
655             $userrow->id = 'fixed_user_'.$userid;
657             $usercell = new html_table_cell();
658             $usercell->attributes['class'] = 'header user';
660             $usercell->header = true;
661             $usercell->scope = 'row';
663             if ($showuserimage) {
664                 $usercell->text = $OUTPUT->user_picture($user, array('visibletoscreenreaders' => false));
665             }
667             $fullname = fullname($user);
668             $usercell->text .= html_writer::link(new moodle_url('/user/view.php', array('id' => $user->id, 'course' => $this->course->id)), $fullname, array(
669                 'class' => 'username',
670             ));
672             if (!empty($user->suspendedenrolment)) {
673                 $usercell->attributes['class'] .= ' usersuspended';
675                 //may be lots of suspended users so only get the string once
676                 if (empty($suspendedstring)) {
677                     $suspendedstring = get_string('userenrolmentsuspended', 'grades');
678                 }
679                 $usercell->text .= html_writer::empty_tag('img', array('src'=>$OUTPUT->pix_url('i/enrolmentsuspended'), 'title'=>$suspendedstring,
680                         'alt'=>$suspendedstring, 'class'=>'usersuspendedicon'));
681             }
683             $userrow->cells[] = $usercell;
685             $userreportcell = new html_table_cell();
686             $userreportcell->attributes['class'] = 'userreport';
687             $userreportcell->header = false;
688             if ($canseeuserreport) {
689                 $a = new stdClass();
690                 $a->user = $fullname;
691                 $strgradesforuser = get_string('gradesforuser', 'grades', $a);
692                 $url = new moodle_url('/grade/report/'.$CFG->grade_profilereport.'/index.php', array('userid' => $user->id, 'id' => $this->course->id));
693                 $userreportcell->text .= $OUTPUT->action_icon($url, new pix_icon('t/grades', $strgradesforuser));
694             }
696             if ($canseesingleview) {
697                 $url = new moodle_url('/grade/report/singleview/index.php', array('id' => $this->course->id, 'itemid' => $user->id, 'item' => 'user'));
698                 $singleview = $OUTPUT->action_icon($url, new pix_icon('t/editstring', get_string('singleview', 'grades', $fullname)));
699                 $userreportcell->text .= $singleview;
700             }
702             if ($userreportcell->text) {
703                 $userrow->cells[] = $userreportcell;
704             }
706             foreach ($extrafields as $field) {
707                 $fieldcell = new html_table_cell();
708                 $fieldcell->attributes['class'] = 'userfield user' . $field;
709                 $fieldcell->header = false;
710                 $fieldcell->text = $user->{$field};
711                 $userrow->cells[] = $fieldcell;
712             }
714             $userrow->attributes['data-uid'] = $userid;
715             $rows[] = $userrow;
716         }
718         $rows = $this->get_left_range_row($rows, $colspan);
719         if ($displayaverages) {
720             $rows = $this->get_left_avg_row($rows, $colspan, true);
721             $rows = $this->get_left_avg_row($rows, $colspan);
722         }
724         return $rows;
725     }
727     /**
728      * Builds and returns the rows that will make up the right part of the grader report
729      * @param boolean $displayaverages whether to display average rows in the table
730      * @return array Array of html_table_row objects
731      */
732     public function get_right_rows($displayaverages) {
733         global $CFG, $USER, $OUTPUT, $DB, $PAGE;
735         $rows = array();
736         $this->rowcount = 0;
737         $numrows = count($this->gtree->get_levels());
738         $numusers = count($this->users);
739         $gradetabindex = 1;
740         $columnstounset = array();
741         $strgrade = $this->get_lang_string('grade');
742         $strfeedback  = $this->get_lang_string("feedback");
743         $arrows = $this->get_sort_arrows();
745         $jsarguments = array(
746             'cfg'       => array('ajaxenabled'=>false),
747             'items'     => array(),
748             'users'     => array(),
749             'feedback'  => array()
750         );
751         $jsscales = array();
753         // Get preferences once.
754         $showactivityicons = $this->get_pref('showactivityicons');
755         $quickgrading = $this->get_pref('quickgrading');
756         $showquickfeedback = $this->get_pref('showquickfeedback');
757         $enableajax = $this->get_pref('enableajax');
758         $showanalysisicon = $this->get_pref('showanalysisicon');
760         // Get strings which are re-used inside the loop.
761         $strftimedatetimeshort = get_string('strftimedatetimeshort');
762         $strexcludedgrades = get_string('excluded', 'grades');
763         $strerror = get_string('error');
765         foreach ($this->gtree->get_levels() as $key => $row) {
766             $headingrow = new html_table_row();
767             $headingrow->attributes['class'] = 'heading_name_row';
769             foreach ($row as $columnkey => $element) {
770                 $sortlink = clone($this->baseurl);
771                 if (isset($element['object']->id)) {
772                     $sortlink->param('sortitemid', $element['object']->id);
773                 }
775                 $eid    = $element['eid'];
776                 $object = $element['object'];
777                 $type   = $element['type'];
778                 $categorystate = @$element['categorystate'];
780                 if (!empty($element['colspan'])) {
781                     $colspan = $element['colspan'];
782                 } else {
783                     $colspan = 1;
784                 }
786                 if (!empty($element['depth'])) {
787                     $catlevel = 'catlevel'.$element['depth'];
788                 } else {
789                     $catlevel = '';
790                 }
792                 // Element is a filler
793                 if ($type == 'filler' or $type == 'fillerfirst' or $type == 'fillerlast') {
794                     $fillercell = new html_table_cell();
795                     $fillercell->attributes['class'] = $type . ' ' . $catlevel;
796                     $fillercell->colspan = $colspan;
797                     $fillercell->text = '&nbsp;';
799                     // This is a filler cell; don't use a <th>, it'll confuse screen readers.
800                     $fillercell->header = false;
801                     $headingrow->cells[] = $fillercell;
802                 } else if ($type == 'category') {
803                     // Element is a category
804                     $categorycell = new html_table_cell();
805                     $categorycell->attributes['class'] = 'category ' . $catlevel;
806                     $categorycell->colspan = $colspan;
807                     $categorycell->text = $this->get_course_header($element);
808                     $categorycell->header = true;
809                     $categorycell->scope = 'col';
811                     // Print icons
812                     if ($USER->gradeediting[$this->courseid]) {
813                         $categorycell->text .= $this->get_icons($element);
814                     }
816                     $headingrow->cells[] = $categorycell;
817                 } else {
818                     // Element is a grade_item
819                     if ($element['object']->id == $this->sortitemid) {
820                         if ($this->sortorder == 'ASC') {
821                             $arrow = $this->get_sort_arrow('up', $sortlink);
822                         } else {
823                             $arrow = $this->get_sort_arrow('down', $sortlink);
824                         }
825                     } else {
826                         $arrow = $this->get_sort_arrow('move', $sortlink);
827                     }
829                     $headerlink = $this->gtree->get_element_header($element, true, $showactivityicons, false, false, true);
831                     $itemcell = new html_table_cell();
832                     $itemcell->attributes['class'] = $type . ' ' . $catlevel . ' highlightable'. ' i'. $element['object']->id;
833                     $itemcell->attributes['data-itemid'] = $element['object']->id;
835                     if ($element['object']->is_hidden()) {
836                         $itemcell->attributes['class'] .= ' dimmed_text';
837                     }
839                     $singleview = '';
840                     if (has_all_capabilities(array('gradereport/singleview:view', 'moodle/grade:viewall',
841                         'moodle/grade:edit'), $this->context)) {
843                         $url = new moodle_url('/grade/report/singleview/index.php', array(
844                             'id' => $this->course->id,
845                             'item' => 'grade',
846                             'itemid' => $element['object']->id));
847                         $singleview = $OUTPUT->action_icon(
848                             $url,
849                             new pix_icon('t/editstring', get_string('singleview', 'grades', $element['object']->get_name()))
850                         );
851                     }
853                     $itemcell->colspan = $colspan;
854                     $itemcell->text = shorten_text($headerlink) . $arrow . $singleview;
855                     $itemcell->header = true;
856                     $itemcell->scope = 'col';
858                     $headingrow->cells[] = $itemcell;
859                 }
860             }
861             $rows[] = $headingrow;
862         }
864         $rows = $this->get_right_icons_row($rows);
866         // Preload scale objects for items with a scaleid and initialize tab indices
867         $scaleslist = array();
868         $tabindices = array();
870         foreach ($this->gtree->get_items() as $itemid => $item) {
871             $scale = null;
872             if (!empty($item->scaleid)) {
873                 $scaleslist[] = $item->scaleid;
874                 $jsarguments['items'][$itemid] = array('id'=>$itemid, 'name'=>$item->get_name(true), 'type'=>'scale', 'scale'=>$item->scaleid, 'decimals'=>$item->get_decimals());
875             } else {
876                 $jsarguments['items'][$itemid] = array('id'=>$itemid, 'name'=>$item->get_name(true), 'type'=>'value', 'scale'=>false, 'decimals'=>$item->get_decimals());
877             }
878             $tabindices[$item->id]['grade'] = $gradetabindex;
879             $tabindices[$item->id]['feedback'] = $gradetabindex + $numusers;
880             $gradetabindex += $numusers * 2;
881         }
882         $scalesarray = array();
884         if (!empty($scaleslist)) {
885             $scalesarray = $DB->get_records_list('scale', 'id', $scaleslist);
886         }
887         $jsscales = $scalesarray;
889         foreach ($this->users as $userid => $user) {
891             if ($this->canviewhidden) {
892                 $altered = array();
893                 $unknown = array();
894             } else {
895                 $hidingaffected = grade_grade::get_hiding_affected($this->grades[$userid], $this->gtree->get_items());
896                 $altered = $hidingaffected['altered'];
897                 $unknown = $hidingaffected['unknown'];
898                 unset($hidingaffected);
899             }
901             $itemrow = new html_table_row();
902             $itemrow->id = 'user_'.$userid;
904             $fullname = fullname($user);
905             $jsarguments['users'][$userid] = $fullname;
907             foreach ($this->gtree->items as $itemid => $unused) {
908                 $item =& $this->gtree->items[$itemid];
909                 $grade = $this->grades[$userid][$item->id];
911                 $itemcell = new html_table_cell();
913                 $itemcell->id = 'u'.$userid.'i'.$itemid;
914                 $itemcell->attributes['data-itemid'] = $itemid;
916                 // Get the decimal points preference for this item
917                 $decimalpoints = $item->get_decimals();
919                 if (in_array($itemid, $unknown)) {
920                     $gradeval = null;
921                 } else if (array_key_exists($itemid, $altered)) {
922                     $gradeval = $altered[$itemid];
923                 } else {
924                     $gradeval = $grade->finalgrade;
925                 }
926                 if (!empty($grade->finalgrade)) {
927                     $gradevalforjs = null;
928                     if ($item->scaleid && !empty($scalesarray[$item->scaleid])) {
929                         $gradevalforjs = (int)$gradeval;
930                     } else {
931                         $gradevalforjs = format_float($gradeval, $decimalpoints);
932                     }
933                     $jsarguments['grades'][] = array('user'=>$userid, 'item'=>$itemid, 'grade'=>$gradevalforjs);
934                 }
936                 // MDL-11274
937                 // Hide grades in the grader report if the current grader doesn't have 'moodle/grade:viewhidden'
938                 if (!$this->canviewhidden and $grade->is_hidden()) {
939                     if (!empty($CFG->grade_hiddenasdate) and $grade->get_datesubmitted() and !$item->is_category_item() and !$item->is_course_item()) {
940                         // 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
941                         $itemcell->text = "<span class='datesubmitted'>" .
942                                 userdate($grade->get_datesubmitted(), $strftimedatetimeshort) . "</span>";
943                     } else {
944                         $itemcell->text = '-';
945                     }
946                     $itemrow->cells[] = $itemcell;
947                     continue;
948                 }
950                 // emulate grade element
951                 $eid = $this->gtree->get_grade_eid($grade);
952                 $element = array('eid'=>$eid, 'object'=>$grade, 'type'=>'grade');
954                 $itemcell->attributes['class'] .= ' grade i'.$itemid;
955                 if ($item->is_category_item()) {
956                     $itemcell->attributes['class'] .= ' cat';
957                 }
958                 if ($item->is_course_item()) {
959                     $itemcell->attributes['class'] .= ' course';
960                 }
961                 if ($grade->is_overridden()) {
962                     $itemcell->attributes['class'] .= ' overridden';
963                     $itemcell->attributes['aria-label'] = get_string('overriddengrade', 'gradereport_grader');
964                 }
966                 if (!empty($grade->feedback)) {
967                     $feedback = wordwrap(trim(format_string($grade->feedback, $grade->feedbackformat)), 34, '<br>');
968                     $itemcell->attributes['data-feedback'] = $feedback;
969                     $jsarguments['feedback'][] = array('user'=>$userid, 'item'=>$itemid, 'content' => $feedback);
970                 }
972                 if ($grade->is_excluded()) {
973                     // Adding white spaces before and after to prevent a screenreader from
974                     // thinking that the words are attached to the next/previous <span> or text.
975                     $itemcell->text .= " <span class='excludedfloater'>" . $strexcludedgrades . "</span> ";
976                 }
978                 // Do not show any icons if no grade (no record in DB to match)
979                 if (!$item->needsupdate and $USER->gradeediting[$this->courseid]) {
980                     $itemcell->text .= $this->get_icons($element);
981                 }
983                 $hidden = '';
984                 if ($grade->is_hidden()) {
985                     $hidden = ' dimmed_text ';
986                 }
988                 $gradepass = ' gradefail ';
989                 if ($grade->is_passed($item)) {
990                     $gradepass = ' gradepass ';
991                 } else if (is_null($grade->is_passed($item))) {
992                     $gradepass = '';
993                 }
995                 // if in editing mode, we need to print either a text box
996                 // or a drop down (for scales)
997                 // grades in item of type grade category or course are not directly editable
998                 if ($item->needsupdate) {
999                     $itemcell->text .= "<span class='gradingerror{$hidden}'>" . $strerror . "</span>";
1001                 } else if ($USER->gradeediting[$this->courseid]) {
1003                     if ($item->scaleid && !empty($scalesarray[$item->scaleid])) {
1004                         $scale = $scalesarray[$item->scaleid];
1005                         $gradeval = (int)$gradeval; // scales use only integers
1006                         $scales = explode(",", $scale->scale);
1007                         // reindex because scale is off 1
1009                         // MDL-12104 some previous scales might have taken up part of the array
1010                         // so this needs to be reset
1011                         $scaleopt = array();
1012                         $i = 0;
1013                         foreach ($scales as $scaleoption) {
1014                             $i++;
1015                             $scaleopt[$i] = $scaleoption;
1016                         }
1018                         if ($quickgrading and $grade->is_editable()) {
1019                             $oldval = empty($gradeval) ? -1 : $gradeval;
1020                             if (empty($item->outcomeid)) {
1021                                 $nogradestr = $this->get_lang_string('nograde');
1022                             } else {
1023                                 $nogradestr = $this->get_lang_string('nooutcome', 'grades');
1024                             }
1025                             $attributes = array('tabindex' => $tabindices[$item->id]['grade'], 'id'=>'grade_'.$userid.'_'.$item->id);
1026                             $gradelabel = $fullname . ' ' . $item->itemname;
1027                             $itemcell->text .= html_writer::label(
1028                                 get_string('useractivitygrade', 'gradereport_grader', $gradelabel), $attributes['id'], false,
1029                                     array('class' => 'accesshide'));
1030                             $itemcell->text .= html_writer::select($scaleopt, 'grade['.$userid.']['.$item->id.']', $gradeval, array(-1=>$nogradestr), $attributes);
1031                         } else if (!empty($scale)) {
1032                             $scales = explode(",", $scale->scale);
1034                             // invalid grade if gradeval < 1
1035                             if ($gradeval < 1) {
1036                                 $itemcell->text .= "<span class='gradevalue{$hidden}{$gradepass}'>-</span>";
1037                             } else {
1038                                 $gradeval = $grade->grade_item->bounded_grade($gradeval); //just in case somebody changes scale
1039                                 $itemcell->text .= "<span class='gradevalue{$hidden}{$gradepass}'>{$scales[$gradeval - 1]}</span>";
1040                             }
1041                         }
1043                     } else if ($item->gradetype != GRADE_TYPE_TEXT) { // Value type
1044                         if ($quickgrading and $grade->is_editable()) {
1045                             $value = format_float($gradeval, $decimalpoints);
1046                             $gradelabel = $fullname . ' ' . $item->itemname;
1047                             $itemcell->text .= '<label class="accesshide" for="grade_'.$userid.'_'.$item->id.'">'
1048                                           .get_string('useractivitygrade', 'gradereport_grader', $gradelabel).'</label>';
1049                             $itemcell->text .= '<input size="6" tabindex="' . $tabindices[$item->id]['grade']
1050                                           . '" type="text" class="text" title="'. $strgrade .'" name="grade['
1051                                           .$userid.'][' .$item->id.']" id="grade_'.$userid.'_'.$item->id.'" value="'.$value.'" />';
1052                         } else {
1053                             $itemcell->text .= "<span class='gradevalue{$hidden}{$gradepass}'>" .
1054                                     format_float($gradeval, $decimalpoints) . "</span>";
1055                         }
1056                     }
1058                     // If quickfeedback is on, print an input element
1059                     if ($showquickfeedback and $grade->is_editable()) {
1060                         $feedbacklabel = $fullname . ' ' . $item->itemname;
1061                         $itemcell->text .= '<label class="accesshide" for="feedback_'.$userid.'_'.$item->id.'">'
1062                                       .get_string('useractivityfeedback', 'gradereport_grader', $feedbacklabel).'</label>';
1063                         $itemcell->text .= '<input class="quickfeedback" tabindex="' . $tabindices[$item->id]['feedback'].'" id="feedback_'.$userid.'_'.$item->id
1064                                       . '" size="6" title="' . $strfeedback . '" type="text" name="feedback['.$userid.']['.$item->id.']" value="' . s($grade->feedback) . '" />';
1065                     }
1067                 } else { // Not editing
1068                     $gradedisplaytype = $item->get_displaytype();
1070                     if ($item->scaleid && !empty($scalesarray[$item->scaleid])) {
1071                         $itemcell->attributes['class'] .= ' grade_type_scale';
1072                     } else if ($item->gradetype != GRADE_TYPE_TEXT) {
1073                         $itemcell->attributes['class'] .= ' grade_type_text';
1074                     }
1076                     if ($enableajax) {
1077                         $canoverride = true;
1078                         if ($item->is_category_item() || $item->is_course_item()) {
1079                             $canoverride = (bool) get_config('moodle', 'grade_overridecat');
1080                         }
1081                         if ($canoverride) {
1082                             $itemcell->attributes['class'] .= ' clickable';
1083                         }
1084                     }
1086                     if ($item->needsupdate) {
1087                         $itemcell->text .= "<span class='gradingerror{$hidden}{$gradepass}'>" . $error . "</span>";
1088                     } else {
1089                         // The max and min for an aggregation may be different to the grade_item.
1090                         if (!is_null($gradeval)) {
1091                             $item->grademax = $grade->get_grade_max();
1092                             $item->grademin = $grade->get_grade_min();
1093                         }
1095                         $itemcell->text .= "<span class='gradevalue{$hidden}{$gradepass}'>" .
1096                                 grade_format_gradevalue($gradeval, $item, true, $gradedisplaytype, null) . "</span>";
1097                         if ($showanalysisicon) {
1098                             $itemcell->text .= $this->gtree->get_grade_analysis_icon($grade);
1099                         }
1100                     }
1101                 }
1103                 if (!empty($this->gradeserror[$item->id][$userid])) {
1104                     $itemcell->text .= $this->gradeserror[$item->id][$userid];
1105                 }
1107                 $itemrow->cells[] = $itemcell;
1108             }
1109             $rows[] = $itemrow;
1110         }
1112         if ($enableajax) {
1113             $jsarguments['cfg']['ajaxenabled'] = true;
1114             $jsarguments['cfg']['scales'] = array();
1115             foreach ($jsscales as $scale) {
1116                 $jsarguments['cfg']['scales'][$scale->id] = explode(',', $scale->scale);
1117             }
1118             $jsarguments['cfg']['feedbacktrunclength'] =  $this->feedback_trunc_length;
1120             // Student grades and feedback are already at $jsarguments['feedback'] and $jsarguments['grades']
1121         }
1122         $jsarguments['cfg']['isediting'] = (bool)$USER->gradeediting[$this->courseid];
1123         $jsarguments['cfg']['courseid'] = $this->courseid;
1124         $jsarguments['cfg']['studentsperpage'] = $this->get_students_per_page();
1125         $jsarguments['cfg']['showquickfeedback'] = (bool) $showquickfeedback;
1127         $module = array(
1128             'name'      => 'gradereport_grader',
1129             'fullpath'  => '/grade/report/grader/module.js',
1130             'requires'  => array('base', 'dom', 'event', 'event-mouseenter', 'event-key', 'io-queue', 'json-parse', 'overlay')
1131         );
1132         $PAGE->requires->js_init_call('M.gradereport_grader.init_report', $jsarguments, false, $module);
1133         $PAGE->requires->strings_for_js(array('addfeedback', 'feedback', 'grade'), 'grades');
1134         $PAGE->requires->strings_for_js(array('ajaxchoosescale', 'ajaxclicktoclose', 'ajaxerror', 'ajaxfailedupdate', 'ajaxfieldchanged'), 'gradereport_grader');
1135         if (!$enableajax && $USER->gradeediting[$this->courseid]) {
1136             $PAGE->requires->yui_module('moodle-core-formchangechecker',
1137                     'M.core_formchangechecker.init',
1138                     array(array(
1139                         'formid' => 'gradereport_grader'
1140                     ))
1141             );
1142             $PAGE->requires->string_for_js('changesmadereallygoaway', 'moodle');
1143         }
1145         $rows = $this->get_right_range_row($rows);
1146         if ($displayaverages) {
1147             $rows = $this->get_right_avg_row($rows, true);
1148             $rows = $this->get_right_avg_row($rows);
1149         }
1151         return $rows;
1152     }
1154     /**
1155      * Depending on the style of report (fixedstudents vs traditional one-table),
1156      * arranges the rows of data in one or two tables, and returns the output of
1157      * these tables in HTML
1158      * @param boolean $displayaverages whether to display average rows in the table
1159      * @return string HTML
1160      */
1161     public function get_grade_table($displayaverages = false) {
1162         global $OUTPUT;
1163         $leftrows = $this->get_left_rows($displayaverages);
1164         $rightrows = $this->get_right_rows($displayaverages);
1166         $html = '';
1168         $fulltable = new html_table();
1169         $fulltable->attributes['class'] = 'gradereport-grader-table';
1170         $fulltable->id = 'user-grades';
1171         $fulltable->summary = get_string('summarygrader', 'gradereport_grader');
1173         // Extract rows from each side (left and right) and collate them into one row each
1174         foreach ($leftrows as $key => $row) {
1175             $row->cells = array_merge($row->cells, $rightrows[$key]->cells);
1176             $fulltable->data[] = $row;
1177         }
1178         $html .= html_writer::table($fulltable);
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 i'.$itemid;
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->attributes['class'] .= ' range i'. $itemid;
1328                 $hidden = '';
1329                 if ($item->is_hidden()) {
1330                     $hidden = ' dimmed_text ';
1331                 }
1333                 $formattedrange = $item->get_formatted_range($rangesdisplaytype, $rangesdecimalpoints);
1335                 $itemcell->text = $OUTPUT->container($formattedrange, 'rangevalues'.$hidden);
1336                 $rangerow->cells[] = $itemcell;
1337             }
1338             $rows[] = $rangerow;
1339         }
1340         return $rows;
1341     }
1343     /**
1344      * Builds and return the row of averages for the right part of the grader report.
1345      * @param array $rows Whether to return only group averages or all averages.
1346      * @param bool $grouponly Whether to return only group averages or all averages.
1347      * @return array Array of rows for the right part of the report
1348      */
1349     public function get_right_avg_row($rows=array(), $grouponly=false) {
1350         global $USER, $DB, $OUTPUT, $CFG;
1352         if (!$this->canviewhidden) {
1353             // Totals might be affected by hiding, if user can not see hidden grades the aggregations might be altered
1354             // better not show them at all if user can not see all hidden grades.
1355             return $rows;
1356         }
1358         $averagesdisplaytype   = $this->get_pref('averagesdisplaytype');
1359         $averagesdecimalpoints = $this->get_pref('averagesdecimalpoints');
1360         $meanselection         = $this->get_pref('meanselection');
1361         $shownumberofgrades    = $this->get_pref('shownumberofgrades');
1363         if ($grouponly) {
1364             $showaverages = $this->currentgroup && $this->get_pref('showaverages');
1365             $groupsql = $this->groupsql;
1366             $groupwheresql = $this->groupwheresql;
1367             $groupwheresqlparams = $this->groupwheresql_params;
1368         } else {
1369             $showaverages = $this->get_pref('showaverages');
1370             $groupsql = "";
1371             $groupwheresql = "";
1372             $groupwheresqlparams = array();
1373         }
1375         if ($showaverages) {
1376             $totalcount = $this->get_numusers($grouponly);
1378             // Limit to users with a gradeable role.
1379             list($gradebookrolessql, $gradebookrolesparams) = $DB->get_in_or_equal(explode(',', $this->gradebookroles), SQL_PARAMS_NAMED, 'grbr0');
1381             // Limit to users with an active enrollment.
1382             $coursecontext = $this->context->get_course_context(true);
1383             $defaultgradeshowactiveenrol = !empty($CFG->grade_report_showonlyactiveenrol);
1384             $showonlyactiveenrol = get_user_preferences('grade_report_showonlyactiveenrol', $defaultgradeshowactiveenrol);
1385             $showonlyactiveenrol = $showonlyactiveenrol || !has_capability('moodle/course:viewsuspendedusers', $coursecontext);
1386             list($enrolledsql, $enrolledparams) = get_enrolled_sql($this->context, '', 0, $showonlyactiveenrol);
1388             // We want to query both the current context and parent contexts.
1389             list($relatedctxsql, $relatedctxparams) = $DB->get_in_or_equal($this->context->get_parent_context_ids(true), SQL_PARAMS_NAMED, 'relatedctx');
1391             $params = array_merge(array('courseid' => $this->courseid), $gradebookrolesparams, $enrolledparams, $groupwheresqlparams, $relatedctxparams);
1393             // Find sums of all grade items in course.
1394             $sql = "SELECT g.itemid, SUM(g.finalgrade) AS sum
1395                       FROM {grade_items} gi
1396                       JOIN {grade_grades} g ON g.itemid = gi.id
1397                       JOIN {user} u ON u.id = g.userid
1398                       JOIN ($enrolledsql) je ON je.id = u.id
1399                       JOIN (
1400                                SELECT DISTINCT ra.userid
1401                                  FROM {role_assignments} ra
1402                                 WHERE ra.roleid $gradebookrolessql
1403                                   AND ra.contextid $relatedctxsql
1404                            ) rainner ON rainner.userid = u.id
1405                       $groupsql
1406                      WHERE gi.courseid = :courseid
1407                        AND u.deleted = 0
1408                        AND g.finalgrade IS NOT NULL
1409                        $groupwheresql
1410                      GROUP BY g.itemid";
1411             $sumarray = array();
1412             if ($sums = $DB->get_records_sql($sql, $params)) {
1413                 foreach ($sums as $itemid => $csum) {
1414                     $sumarray[$itemid] = $csum->sum;
1415                 }
1416             }
1418             // MDL-10875 Empty grades must be evaluated as grademin, NOT always 0
1419             // This query returns a count of ungraded grades (NULL finalgrade OR no matching record in grade_grades table)
1420             $sql = "SELECT gi.id, COUNT(DISTINCT u.id) AS count
1421                       FROM {grade_items} gi
1422                       CROSS JOIN {user} u
1423                       JOIN ($enrolledsql) je
1424                            ON je.id = u.id
1425                       JOIN {role_assignments} ra
1426                            ON ra.userid = u.id
1427                       LEFT OUTER JOIN {grade_grades} g
1428                            ON (g.itemid = gi.id AND g.userid = u.id AND g.finalgrade IS NOT NULL)
1429                       $groupsql
1430                      WHERE gi.courseid = :courseid
1431                            AND ra.roleid $gradebookrolessql
1432                            AND ra.contextid $relatedctxsql
1433                            AND u.deleted = 0
1434                            AND g.id IS NULL
1435                            $groupwheresql
1436                   GROUP BY gi.id";
1438             $ungradedcounts = $DB->get_records_sql($sql, $params);
1440             $avgrow = new html_table_row();
1441             $avgrow->attributes['class'] = 'avg';
1443             foreach ($this->gtree->items as $itemid => $unused) {
1444                 $item =& $this->gtree->items[$itemid];
1446                 if ($item->needsupdate) {
1447                     $avgcell = new html_table_cell();
1448                     $avgcell->attributes['class'] = 'i'. $itemid;
1449                     $avgcell->text = $OUTPUT->container(get_string('error'), 'gradingerror');
1450                     $avgrow->cells[] = $avgcell;
1451                     continue;
1452                 }
1454                 if (!isset($sumarray[$item->id])) {
1455                     $sumarray[$item->id] = 0;
1456                 }
1458                 if (empty($ungradedcounts[$itemid])) {
1459                     $ungradedcount = 0;
1460                 } else {
1461                     $ungradedcount = $ungradedcounts[$itemid]->count;
1462                 }
1464                 if ($meanselection == GRADE_REPORT_MEAN_GRADED) {
1465                     $meancount = $totalcount - $ungradedcount;
1466                 } else { // Bump up the sum by the number of ungraded items * grademin
1467                     $sumarray[$item->id] += $ungradedcount * $item->grademin;
1468                     $meancount = $totalcount;
1469                 }
1471                 // Determine which display type to use for this average
1472                 if ($USER->gradeediting[$this->courseid]) {
1473                     $displaytype = GRADE_DISPLAY_TYPE_REAL;
1475                 } else if ($averagesdisplaytype == GRADE_REPORT_PREFERENCE_INHERIT) { // no ==0 here, please resave the report and user preferences
1476                     $displaytype = $item->get_displaytype();
1478                 } else {
1479                     $displaytype = $averagesdisplaytype;
1480                 }
1482                 // Override grade_item setting if a display preference (not inherit) was set for the averages
1483                 if ($averagesdecimalpoints == GRADE_REPORT_PREFERENCE_INHERIT) {
1484                     $decimalpoints = $item->get_decimals();
1486                 } else {
1487                     $decimalpoints = $averagesdecimalpoints;
1488                 }
1490                 if (!isset($sumarray[$item->id]) || $meancount == 0) {
1491                     $avgcell = new html_table_cell();
1492                     $avgcell->attributes['class'] = 'i'. $itemid;
1493                     $avgcell->text = '-';
1494                     $avgrow->cells[] = $avgcell;
1496                 } else {
1497                     $sum = $sumarray[$item->id];
1498                     $avgradeval = $sum/$meancount;
1499                     $gradehtml = grade_format_gradevalue($avgradeval, $item, true, $displaytype, $decimalpoints);
1501                     $numberofgrades = '';
1502                     if ($shownumberofgrades) {
1503                         $numberofgrades = " ($meancount)";
1504                     }
1506                     $avgcell = new html_table_cell();
1507                     $avgcell->attributes['class'] = 'i'. $itemid;
1508                     $avgcell->text = $gradehtml.$numberofgrades;
1509                     $avgrow->cells[] = $avgcell;
1510                 }
1511             }
1512             $rows[] = $avgrow;
1513         }
1514         return $rows;
1515     }
1517     /**
1518      * Given element category, create a collapsible icon and
1519      * course header.
1520      *
1521      * @param array $element
1522      * @return string HTML
1523      */
1524     protected function get_course_header($element) {
1525         global $OUTPUT;
1527         $icon = '';
1528         // If object is a category, display expand/contract icon.
1529         if ($element['type'] == 'category') {
1530             // Load language strings.
1531             $strswitchminus = $this->get_lang_string('aggregatesonly', 'grades');
1532             $strswitchplus  = $this->get_lang_string('gradesonly', 'grades');
1533             $strswitchwhole = $this->get_lang_string('fullmode', 'grades');
1535             $url = new moodle_url($this->gpr->get_return_url(null, array('target' => $element['eid'], 'sesskey' => sesskey())));
1537             if (in_array($element['object']->id, $this->collapsed['aggregatesonly'])) {
1538                 $url->param('action', 'switch_plus');
1539                 $icon = $OUTPUT->action_icon($url, new pix_icon('t/switch_plus', $strswitchplus), null, null);
1540                 $showing = get_string('showingaggregatesonly', 'grades');
1541             } else if (in_array($element['object']->id, $this->collapsed['gradesonly'])) {
1542                 $url->param('action', 'switch_whole');
1543                 $icon = $OUTPUT->action_icon($url, new pix_icon('t/switch_whole', $strswitchwhole), null, null);
1544                 $showing = get_string('showinggradesonly', 'grades');
1545             } else {
1546                 $url->param('action', 'switch_minus');
1547                 $icon = $OUTPUT->action_icon($url, new pix_icon('t/switch_minus', $strswitchminus), null, null);
1548                 $showing = get_string('showingfullmode', 'grades');
1549             }
1550         }
1552         $name = shorten_text($element['object']->get_name());
1553         $courseheader = html_writer::tag('span', $name, array('id' => 'courseheader'));
1554         $courseheader .= html_writer::label($showing, 'courseheader', false, array('class' => 'accesshide'));
1555         $courseheader .= $icon;
1557         return $courseheader;
1558     }
1560     /**
1561      * Given a grade_category, grade_item or grade_grade, this function
1562      * figures out the state of the object and builds then returns a div
1563      * with the icons needed for the grader report.
1564      *
1565      * @param array $element
1566      * @return string HTML
1567      */
1568     protected function get_icons($element) {
1569         global $CFG, $USER, $OUTPUT;
1571         if (!$USER->gradeediting[$this->courseid]) {
1572             return '<div class="grade_icons" />';
1573         }
1575         // Init all icons
1576         $editicon = '';
1578         $editable = true;
1580         if ($element['type'] == 'grade') {
1581             $item = $element['object']->grade_item;
1582             if ($item->is_course_item() or $item->is_category_item()) {
1583                 $editable = $this->overridecat;
1584             }
1585         }
1587         if ($element['type'] != 'categoryitem' && $element['type'] != 'courseitem' && $editable) {
1588             $editicon = $this->gtree->get_edit_icon($element, $this->gpr);
1589         }
1591         $editcalculationicon = '';
1592         $showhideicon        = '';
1593         $lockunlockicon      = '';
1595         if (has_capability('moodle/grade:manage', $this->context)) {
1596             if ($this->get_pref('showcalculations')) {
1597                 $editcalculationicon = $this->gtree->get_calculation_icon($element, $this->gpr);
1598             }
1600             if ($this->get_pref('showeyecons')) {
1601                 $showhideicon = $this->gtree->get_hiding_icon($element, $this->gpr);
1602             }
1604             if ($this->get_pref('showlocks')) {
1605                 $lockunlockicon = $this->gtree->get_locking_icon($element, $this->gpr);
1606             }
1608         }
1610         $gradeanalysisicon   = '';
1611         if ($this->get_pref('showanalysisicon') && $element['type'] == 'grade') {
1612             $gradeanalysisicon .= $this->gtree->get_grade_analysis_icon($element['object']);
1613         }
1615         return $OUTPUT->container($editicon.$editcalculationicon.$showhideicon.$lockunlockicon.$gradeanalysisicon, 'grade_icons');
1616     }
1618     /**
1619      * Given a category element returns collapsing +/- icon if available
1620      *
1621      * @deprecated since Moodle 2.9 MDL-46662 - please do not use this function any more.
1622      * @todo MDL-49021 This will be deleted in Moodle 3.1
1623      * @see grade_report_grader::get_course_header()
1624      * @param object $element
1625      * @return string HTML
1626      */
1627     protected function get_collapsing_icon($element) {
1628         global $OUTPUT;
1629         debugging('get_collapsing_icon is deprecated, please use get_course_header instead.', DEBUG_DEVELOPER);
1631         $icon = '';
1632         // If object is a category, display expand/contract icon
1633         if ($element['type'] == 'category') {
1634             // Load language strings
1635             $strswitchminus = $this->get_lang_string('aggregatesonly', 'grades');
1636             $strswitchplus  = $this->get_lang_string('gradesonly', 'grades');
1637             $strswitchwhole = $this->get_lang_string('fullmode', 'grades');
1639             $url = new moodle_url($this->gpr->get_return_url(null, array('target'=>$element['eid'], 'sesskey'=>sesskey())));
1641             if (in_array($element['object']->id, $this->collapsed['aggregatesonly'])) {
1642                 $url->param('action', 'switch_plus');
1643                 $icon = $OUTPUT->action_icon($url, new pix_icon('t/switch_plus', $strswitchplus));
1645             } else if (in_array($element['object']->id, $this->collapsed['gradesonly'])) {
1646                 $url->param('action', 'switch_whole');
1647                 $icon = $OUTPUT->action_icon($url, new pix_icon('t/switch_whole', $strswitchwhole));
1649             } else {
1650                 $url->param('action', 'switch_minus');
1651                 $icon = $OUTPUT->action_icon($url, new pix_icon('t/switch_minus', $strswitchminus));
1652             }
1653         }
1654         return $icon;
1655     }
1657     /**
1658      * Processes a single action against a category, grade_item or grade.
1659      * @param string $target eid ({type}{id}, e.g. c4 for category4)
1660      * @param string $action Which action to take (edit, delete etc...)
1661      * @return
1662      */
1663     public function process_action($target, $action) {
1664         return self::do_process_action($target, $action, $this->course->id);
1665     }
1667     /**
1668      * From the list of categories that this user prefers to collapse choose ones that belong to the current course.
1669      *
1670      * This function serves two purposes.
1671      * Mainly it helps migrating from user preference style when all courses were stored in one preference.
1672      * Also it helps to remove the settings for categories that were removed if the array for one course grows too big.
1673      *
1674      * @param int $courseid
1675      * @param array $collapsed
1676      * @return array
1677      */
1678     protected static function filter_collapsed_categories($courseid, $collapsed) {
1679         global $DB;
1680         if (empty($collapsed)) {
1681             $collapsed = array('aggregatesonly' => array(), 'gradesonly' => array());
1682         }
1683         if (empty($collapsed['aggregatesonly']) && empty($collapsed['gradesonly'])) {
1684             return $collapsed;
1685         }
1686         $cats = $DB->get_fieldset_select('grade_categories', 'id', 'courseid = ?', array($courseid));
1687         $collapsed['aggregatesonly'] = array_values(array_intersect($collapsed['aggregatesonly'], $cats));
1688         $collapsed['gradesonly'] = array_values(array_intersect($collapsed['gradesonly'], $cats));
1689         return $collapsed;
1690     }
1692     /**
1693      * Returns the list of categories that this user wants to collapse or display aggregatesonly
1694      *
1695      * This method also migrates on request from the old format of storing user preferences when they were stored
1696      * in one preference for all courses causing DB error when trying to insert very big value.
1697      *
1698      * @param int $courseid
1699      * @return array
1700      */
1701     protected static function get_collapsed_preferences($courseid) {
1702         if ($collapsed = get_user_preferences('grade_report_grader_collapsed_categories'.$courseid)) {
1703             return json_decode($collapsed, true);
1704         }
1706         // Try looking for old location of user setting that used to store all courses in one serialized user preference.
1707         if (($oldcollapsedpref = get_user_preferences('grade_report_grader_collapsed_categories')) !== null) {
1708             if ($collapsedall = @unserialize($oldcollapsedpref)) {
1709                 // We found the old-style preference, filter out only categories that belong to this course and update the prefs.
1710                 $collapsed = static::filter_collapsed_categories($courseid, $collapsedall);
1711                 if (!empty($collapsed['aggregatesonly']) || !empty($collapsed['gradesonly'])) {
1712                     static::set_collapsed_preferences($courseid, $collapsed);
1713                     $collapsedall['aggregatesonly'] = array_diff($collapsedall['aggregatesonly'], $collapsed['aggregatesonly']);
1714                     $collapsedall['gradesonly'] = array_diff($collapsedall['gradesonly'], $collapsed['gradesonly']);
1715                     if (!empty($collapsedall['aggregatesonly']) || !empty($collapsedall['gradesonly'])) {
1716                         set_user_preference('grade_report_grader_collapsed_categories', serialize($collapsedall));
1717                     } else {
1718                         unset_user_preference('grade_report_grader_collapsed_categories');
1719                     }
1720                 }
1721             } else {
1722                 // We found the old-style preference, but it is unreadable, discard it.
1723                 unset_user_preference('grade_report_grader_collapsed_categories');
1724             }
1725         } else {
1726             $collapsed = array('aggregatesonly' => array(), 'gradesonly' => array());
1727         }
1728         return $collapsed;
1729     }
1731     /**
1732      * Sets the list of categories that user wants to see collapsed in user preferences
1733      *
1734      * This method may filter or even trim the list if it does not fit in DB field.
1735      *
1736      * @param int $courseid
1737      * @param array $collapsed
1738      */
1739     protected static function set_collapsed_preferences($courseid, $collapsed) {
1740         global $DB;
1741         // In an unlikely case that the list of collapsed categories for one course is too big for the user preference size,
1742         // try to filter the list of categories since array may contain categories that were deleted.
1743         if (strlen(json_encode($collapsed)) >= 1333) {
1744             $collapsed = static::filter_collapsed_categories($courseid, $collapsed);
1745         }
1747         // If this did not help, "forget" about some of the collapsed categories. Still better than to loose all information.
1748         while (strlen(json_encode($collapsed)) >= 1333) {
1749             if (count($collapsed['aggregatesonly'])) {
1750                 array_pop($collapsed['aggregatesonly']);
1751             }
1752             if (count($collapsed['gradesonly'])) {
1753                 array_pop($collapsed['gradesonly']);
1754             }
1755         }
1757         if (!empty($collapsed['aggregatesonly']) || !empty($collapsed['gradesonly'])) {
1758             set_user_preference('grade_report_grader_collapsed_categories'.$courseid, json_encode($collapsed));
1759         } else {
1760             unset_user_preference('grade_report_grader_collapsed_categories'.$courseid);
1761         }
1762     }
1764     /**
1765      * Processes a single action against a category, grade_item or grade.
1766      * @param string $target eid ({type}{id}, e.g. c4 for category4)
1767      * @param string $action Which action to take (edit, delete etc...)
1768      * @param int $courseid affected course.
1769      * @return
1770      */
1771     public static function do_process_action($target, $action, $courseid = null) {
1772         global $DB;
1773         // TODO: this code should be in some grade_tree static method
1774         $targettype = substr($target, 0, 2);
1775         $targetid = substr($target, 2);
1776         // TODO: end
1778         if ($targettype !== 'cg') {
1779             // The following code only works with categories.
1780             return true;
1781         }
1783         if (!$courseid) {
1784             debugging('Function grade_report_grader::do_process_action() now requires additional argument courseid',
1785                 DEBUG_DEVELOPER);
1786             if (!$courseid = $DB->get_field('grade_categories', 'courseid', array('id' => $targetid), IGNORE_MISSING)) {
1787                 return true;
1788             }
1789         }
1791         $collapsed = static::get_collapsed_preferences($courseid);
1793         switch ($action) {
1794             case 'switch_minus': // Add category to array of aggregatesonly
1795                 if (!in_array($targetid, $collapsed['aggregatesonly'])) {
1796                     $collapsed['aggregatesonly'][] = $targetid;
1797                     static::set_collapsed_preferences($courseid, $collapsed);
1798                 }
1799                 break;
1801             case 'switch_plus': // Remove category from array of aggregatesonly, and add it to array of gradesonly
1802                 $key = array_search($targetid, $collapsed['aggregatesonly']);
1803                 if ($key !== false) {
1804                     unset($collapsed['aggregatesonly'][$key]);
1805                 }
1806                 if (!in_array($targetid, $collapsed['gradesonly'])) {
1807                     $collapsed['gradesonly'][] = $targetid;
1808                 }
1809                 static::set_collapsed_preferences($courseid, $collapsed);
1810                 break;
1811             case 'switch_whole': // Remove the category from the array of collapsed cats
1812                 $key = array_search($targetid, $collapsed['gradesonly']);
1813                 if ($key !== false) {
1814                     unset($collapsed['gradesonly'][$key]);
1815                     static::set_collapsed_preferences($courseid, $collapsed);
1816                 }
1818                 break;
1819             default:
1820                 break;
1821         }
1823         return true;
1824     }
1826     /**
1827      * Refactored function for generating HTML of sorting links with matching arrows.
1828      * Returns an array with 'studentname' and 'idnumber' as keys, with HTML ready
1829      * to inject into a table header cell.
1830      * @param array $extrafields Array of extra fields being displayed, such as
1831      *   user idnumber
1832      * @return array An associative array of HTML sorting links+arrows
1833      */
1834     public function get_sort_arrows(array $extrafields = array()) {
1835         global $OUTPUT;
1836         $arrows = array();
1838         $strsortasc   = $this->get_lang_string('sortasc', 'grades');
1839         $strsortdesc  = $this->get_lang_string('sortdesc', 'grades');
1840         $strfirstname = $this->get_lang_string('firstname');
1841         $strlastname  = $this->get_lang_string('lastname');
1842         $iconasc = $OUTPUT->pix_icon('t/sort_asc', $strsortasc, '', array('class' => 'iconsmall sorticon'));
1843         $icondesc = $OUTPUT->pix_icon('t/sort_desc', $strsortdesc, '', array('class' => 'iconsmall sorticon'));
1845         $firstlink = html_writer::link(new moodle_url($this->baseurl, array('sortitemid'=>'firstname')), $strfirstname);
1846         $lastlink = html_writer::link(new moodle_url($this->baseurl, array('sortitemid'=>'lastname')), $strlastname);
1848         $arrows['studentname'] = $lastlink;
1850         if ($this->sortitemid === 'lastname') {
1851             if ($this->sortorder == 'ASC') {
1852                 $arrows['studentname'] .= $iconasc;
1853             } else {
1854                 $arrows['studentname'] .= $icondesc;
1855             }
1856         }
1858         $arrows['studentname'] .= ' ' . $firstlink;
1860         if ($this->sortitemid === 'firstname') {
1861             if ($this->sortorder == 'ASC') {
1862                 $arrows['studentname'] .= $iconasc;
1863             } else {
1864                 $arrows['studentname'] .= $icondesc;
1865             }
1866         }
1868         foreach ($extrafields as $field) {
1869             $fieldlink = html_writer::link(new moodle_url($this->baseurl,
1870                     array('sortitemid'=>$field)), get_user_field_name($field));
1871             $arrows[$field] = $fieldlink;
1873             if ($field == $this->sortitemid) {
1874                 if ($this->sortorder == 'ASC') {
1875                     $arrows[$field] .= $iconasc;
1876                 } else {
1877                     $arrows[$field] .= $icondesc;
1878                 }
1879             }
1880         }
1882         return $arrows;
1883     }
1885     /**
1886      * Returns the maximum number of students to be displayed on each page
1887      *
1888      * @return int The maximum number of students to display per page
1889      */
1890     public function get_students_per_page() {
1891         return $this->get_pref('studentsperpage');
1892     }