8e4560f280ab70a1ad92fe2d2c1a59b8bdaf319e
[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      * Contains all the grades for the course - even the ones not displayed in the grade tree.
43      *
44      * @var array $allgrades
45      */
46     private $allgrades;
48     /**
49      * Contains all grade items expect GRADE_TYPE_NONE.
50      *
51      * @var array $allgradeitems
52      */
53     private $allgradeitems;
55     /**
56      * Array of errors for bulk grades updating.
57      * @var array $gradeserror
58      */
59     public $gradeserror = array();
61     // SQL-RELATED
63     /**
64      * The id of the grade_item by which this report will be sorted.
65      * @var int $sortitemid
66      */
67     public $sortitemid;
69     /**
70      * Sortorder used in the SQL selections.
71      * @var int $sortorder
72      */
73     public $sortorder;
75     /**
76      * An SQL fragment affecting the search for users.
77      * @var string $userselect
78      */
79     public $userselect;
81     /**
82      * The bound params for $userselect
83      * @var array $userselectparams
84      */
85     public $userselectparams = array();
87     /**
88      * List of collapsed categories from user preference
89      * @var array $collapsed
90      */
91     public $collapsed;
93     /**
94      * A count of the rows, used for css classes.
95      * @var int $rowcount
96      */
97     public $rowcount = 0;
99     /**
100      * Capability check caching
101      * @var boolean $canviewhidden
102      */
103     public $canviewhidden;
105     /**
106      * Length at which feedback will be truncated (to the nearest word) and an ellipsis be added.
107      * TODO replace this by a report preference
108      * @var int $feedback_trunc_length
109      */
110     protected $feedback_trunc_length = 50;
112     /**
113      * Allow category grade overriding
114      * @var bool $overridecat
115      */
116     protected $overridecat;
118     /**
119      * Constructor. Sets local copies of user preferences and initialises grade_tree.
120      * @param int $courseid
121      * @param object $gpr grade plugin return tracking object
122      * @param string $context
123      * @param int $page The current page being viewed (when report is paged)
124      * @param int $sortitemid The id of the grade_item by which to sort the table
125      */
126     public function __construct($courseid, $gpr, $context, $page=null, $sortitemid=null) {
127         global $CFG;
128         parent::__construct($courseid, $gpr, $context, $page);
130         $this->canviewhidden = has_capability('moodle/grade:viewhidden', context_course::instance($this->course->id));
132         // load collapsed settings for this report
133         $this->collapsed = static::get_collapsed_preferences($this->course->id);
135         if (empty($CFG->enableoutcomes)) {
136             $nooutcomes = false;
137         } else {
138             $nooutcomes = get_user_preferences('grade_report_shownooutcomes');
139         }
141         // if user report preference set or site report setting set use it, otherwise use course or site setting
142         $switch = $this->get_pref('aggregationposition');
143         if ($switch == '') {
144             $switch = grade_get_setting($this->courseid, 'aggregationposition', $CFG->grade_aggregationposition);
145         }
147         // Grab the grade_tree for this course
148         $this->gtree = new grade_tree($this->courseid, true, $switch, $this->collapsed, $nooutcomes);
150         $this->sortitemid = $sortitemid;
152         // base url for sorting by first/last name
154         $this->baseurl = new moodle_url('index.php', array('id' => $this->courseid));
156         $studentsperpage = $this->get_students_per_page();
157         if (!empty($this->page) && !empty($studentsperpage)) {
158             $this->baseurl->params(array('perpage' => $studentsperpage, 'page' => $this->page));
159         }
161         $this->pbarurl = new moodle_url('/grade/report/grader/index.php', array('id' => $this->courseid));
163         $this->setup_groups();
164         $this->setup_users();
165         $this->setup_sortitemid();
167         $this->overridecat = (bool)get_config('moodle', 'grade_overridecat');
168     }
170     /**
171      * Processes the data sent by the form (grades and feedbacks).
172      * Caller is responsible for all access control checks
173      * @param array $data form submission (with magic quotes)
174      * @return array empty array if success, array of warnings if something fails.
175      */
176     public function process_data($data) {
177         global $DB;
178         $warnings = array();
180         $separategroups = false;
181         $mygroups       = array();
182         if ($this->groupmode == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $this->context)) {
183             $separategroups = true;
184             $mygroups = groups_get_user_groups($this->course->id);
185             $mygroups = $mygroups[0]; // ignore groupings
186             // reorder the groups fro better perf below
187             $current = array_search($this->currentgroup, $mygroups);
188             if ($current !== false) {
189                 unset($mygroups[$current]);
190                 array_unshift($mygroups, $this->currentgroup);
191             }
192         }
194         // always initialize all arrays
195         $queue = array();
197         $this->load_users();
198         $this->load_final_grades();
200         // Were any changes made?
201         $changedgrades = false;
202         $timepageload = clean_param($data->timepageload, PARAM_INT);
204         foreach ($data as $varname => $students) {
206             $needsupdate = false;
208             // skip, not a grade nor feedback
209             if (strpos($varname, 'grade') === 0) {
210                 $datatype = 'grade';
211             } else if (strpos($varname, 'feedback') === 0) {
212                 $datatype = 'feedback';
213             } else {
214                 continue;
215             }
217             foreach ($students as $userid => $items) {
218                 $userid = clean_param($userid, PARAM_INT);
219                 foreach ($items as $itemid => $postedvalue) {
220                     $itemid = clean_param($itemid, PARAM_INT);
222                     // Was change requested?
223                     $oldvalue = $this->grades[$userid][$itemid];
224                     if ($datatype === 'grade') {
225                         // If there was no grade and there still isn't
226                         if (is_null($oldvalue->finalgrade) && $postedvalue == -1) {
227                             // -1 means no grade
228                             continue;
229                         }
231                         // If the grade item uses a custom scale
232                         if (!empty($oldvalue->grade_item->scaleid)) {
234                             if ((int)$oldvalue->finalgrade === (int)$postedvalue) {
235                                 continue;
236                             }
237                         } else {
238                             // The grade item uses a numeric scale
240                             // Format the finalgrade from the DB so that it matches the grade from the client
241                             if ($postedvalue === format_float($oldvalue->finalgrade, $oldvalue->grade_item->get_decimals())) {
242                                 continue;
243                             }
244                         }
246                         $changedgrades = true;
248                     } else if ($datatype === 'feedback') {
249                         // If quick grading is on, feedback needs to be compared without line breaks.
250                         if ($this->get_pref('quickgrading')) {
251                             $oldvalue->feedback = preg_replace("/\r\n|\r|\n/", "", $oldvalue->feedback);
252                         }
253                         if (($oldvalue->feedback === $postedvalue) or ($oldvalue->feedback === null and empty($postedvalue))) {
254                             continue;
255                         }
256                     }
258                     if (!$gradeitem = grade_item::fetch(array('id'=>$itemid, 'courseid'=>$this->courseid))) {
259                         print_error('invalidgradeitemid');
260                     }
262                     // Pre-process grade
263                     if ($datatype == 'grade') {
264                         $feedback = false;
265                         $feedbackformat = false;
266                         if ($gradeitem->gradetype == GRADE_TYPE_SCALE) {
267                             if ($postedvalue == -1) { // -1 means no grade
268                                 $finalgrade = null;
269                             } else {
270                                 $finalgrade = $postedvalue;
271                             }
272                         } else {
273                             $finalgrade = unformat_float($postedvalue);
274                         }
276                         $errorstr = '';
277                         $skip = false;
279                         $dategraded = $oldvalue->get_dategraded();
280                         if (!empty($dategraded) && $timepageload < $dategraded) {
281                             // Warn if the grade was updated while we were editing this form.
282                             $errorstr = 'gradewasmodifiedduringediting';
283                             $skip = true;
284                         } else if (!is_null($finalgrade)) {
285                             // Warn if the grade is out of bounds.
286                             $bounded = $gradeitem->bounded_grade($finalgrade);
287                             if ($bounded > $finalgrade) {
288                                 $errorstr = 'lessthanmin';
289                             } else if ($bounded < $finalgrade) {
290                                 $errorstr = 'morethanmax';
291                             }
292                         }
294                         if ($errorstr) {
295                             $userfields = 'id, ' . get_all_user_name_fields(true);
296                             $user = $DB->get_record('user', array('id' => $userid), $userfields);
297                             $gradestr = new stdClass();
298                             $gradestr->username = fullname($user);
299                             $gradestr->itemname = $gradeitem->get_name();
300                             $warnings[] = get_string($errorstr, 'grades', $gradestr);
301                             if ($skip) {
302                                 // Skipping the update of this grade it failed the tests above.
303                                 continue;
304                             }
305                         }
307                     } else if ($datatype == 'feedback') {
308                         $finalgrade = false;
309                         $trimmed = trim($postedvalue);
310                         if (empty($trimmed)) {
311                              $feedback = null;
312                         } else {
313                              $feedback = $postedvalue;
314                         }
315                     }
317                     // group access control
318                     if ($separategroups) {
319                         // note: we can not use $this->currentgroup because it would fail badly
320                         //       when having two browser windows each with different group
321                         $sharinggroup = false;
322                         foreach ($mygroups as $groupid) {
323                             if (groups_is_member($groupid, $userid)) {
324                                 $sharinggroup = true;
325                                 break;
326                             }
327                         }
328                         if (!$sharinggroup) {
329                             // either group membership changed or somebody is hacking grades of other group
330                             $warnings[] = get_string('errorsavegrade', 'grades');
331                             continue;
332                         }
333                     }
335                     $gradeitem->update_final_grade($userid, $finalgrade, 'gradebook', $feedback, FORMAT_MOODLE);
337                     // We can update feedback without reloading the grade item as it doesn't affect grade calculations
338                     if ($datatype === 'feedback') {
339                         $this->grades[$userid][$itemid]->feedback = $feedback;
340                     }
341                 }
342             }
343         }
345         if ($changedgrades) {
346             // If a final grade was overriden reload grades so dependent grades like course total will be correct
347             $this->grades = null;
348         }
350         return $warnings;
351     }
354     /**
355      * Setting the sort order, this depends on last state
356      * all this should be in the new table class that we might need to use
357      * for displaying grades.
358      */
359     private function setup_sortitemid() {
361         global $SESSION;
363         if (!isset($SESSION->gradeuserreport)) {
364             $SESSION->gradeuserreport = new stdClass();
365         }
367         if ($this->sortitemid) {
368             if (!isset($SESSION->gradeuserreport->sort)) {
369                 if ($this->sortitemid == 'firstname' || $this->sortitemid == 'lastname') {
370                     $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC';
371                 } else {
372                     $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC';
373                 }
374             } else {
375                 // this is the first sort, i.e. by last name
376                 if (!isset($SESSION->gradeuserreport->sortitemid)) {
377                     if ($this->sortitemid == 'firstname' || $this->sortitemid == 'lastname') {
378                         $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC';
379                     } else {
380                         $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC';
381                     }
382                 } else if ($SESSION->gradeuserreport->sortitemid == $this->sortitemid) {
383                     // same as last sort
384                     if ($SESSION->gradeuserreport->sort == 'ASC') {
385                         $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC';
386                     } else {
387                         $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC';
388                     }
389                 } else {
390                     if ($this->sortitemid == 'firstname' || $this->sortitemid == 'lastname') {
391                         $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC';
392                     } else {
393                         $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC';
394                     }
395                 }
396             }
397             $SESSION->gradeuserreport->sortitemid = $this->sortitemid;
398         } else {
399             // not requesting sort, use last setting (for paging)
401             if (isset($SESSION->gradeuserreport->sortitemid)) {
402                 $this->sortitemid = $SESSION->gradeuserreport->sortitemid;
403             } else {
404                 $this->sortitemid = 'lastname';
405             }
407             if (isset($SESSION->gradeuserreport->sort)) {
408                 $this->sortorder = $SESSION->gradeuserreport->sort;
409             } else {
410                 $this->sortorder = 'ASC';
411             }
412         }
413     }
415     /**
416      * pulls out the userids of the users to be display, and sorts them
417      */
418     public function load_users() {
419         global $CFG, $DB;
421         if (!empty($this->users)) {
422             return;
423         }
424         $this->setup_users();
426         // Limit to users with a gradeable role.
427         list($gradebookrolessql, $gradebookrolesparams) = $DB->get_in_or_equal(explode(',', $this->gradebookroles), SQL_PARAMS_NAMED, 'grbr0');
429         // Check the status of showing only active enrolments.
430         $coursecontext = $this->context->get_course_context(true);
431         $defaultgradeshowactiveenrol = !empty($CFG->grade_report_showonlyactiveenrol);
432         $showonlyactiveenrol = get_user_preferences('grade_report_showonlyactiveenrol', $defaultgradeshowactiveenrol);
433         $showonlyactiveenrol = $showonlyactiveenrol || !has_capability('moodle/course:viewsuspendedusers', $coursecontext);
435         // Limit to users with an active enrollment.
436         list($enrolledsql, $enrolledparams) = get_enrolled_sql($this->context, '', 0, $showonlyactiveenrol);
438         // Fields we need from the user table.
439         $userfields = user_picture::fields('u', get_extra_user_fields($this->context));
441         // We want to query both the current context and parent contexts.
442         list($relatedctxsql, $relatedctxparams) = $DB->get_in_or_equal($this->context->get_parent_context_ids(true), SQL_PARAMS_NAMED, 'relatedctx');
444         // If the user has clicked one of the sort asc/desc arrows.
445         if (is_numeric($this->sortitemid)) {
446             $params = array_merge(array('gitemid' => $this->sortitemid), $gradebookrolesparams, $this->userwheresql_params,
447                     $this->groupwheresql_params, $enrolledparams, $relatedctxparams);
449             $sortjoin = "LEFT JOIN {grade_grades} g ON g.userid = u.id AND g.itemid = $this->sortitemid";
450             $sort = "g.finalgrade $this->sortorder";
451         } else {
452             $sortjoin = '';
453             switch($this->sortitemid) {
454                 case 'lastname':
455                     $sort = "u.lastname $this->sortorder, u.firstname $this->sortorder";
456                     break;
457                 case 'firstname':
458                     $sort = "u.firstname $this->sortorder, u.lastname $this->sortorder";
459                     break;
460                 case 'email':
461                     $sort = "u.email $this->sortorder";
462                     break;
463                 case 'idnumber':
464                 default:
465                     $sort = "u.idnumber $this->sortorder";
466                     break;
467             }
469             $params = array_merge($gradebookrolesparams, $this->userwheresql_params, $this->groupwheresql_params, $enrolledparams, $relatedctxparams);
470         }
472         $sql = "SELECT $userfields
473                   FROM {user} u
474                   JOIN ($enrolledsql) je ON je.id = u.id
475                        $this->groupsql
476                        $sortjoin
477                   JOIN (
478                            SELECT DISTINCT ra.userid
479                              FROM {role_assignments} ra
480                             WHERE ra.roleid IN ($this->gradebookroles)
481                               AND ra.contextid $relatedctxsql
482                        ) rainner ON rainner.userid = u.id
483                    AND u.deleted = 0
484                    $this->userwheresql
485                    $this->groupwheresql
486               ORDER BY $sort";
487         $studentsperpage = $this->get_students_per_page();
488         $this->users = $DB->get_records_sql($sql, $params, $studentsperpage * $this->page, $studentsperpage);
490         if (empty($this->users)) {
491             $this->userselect = '';
492             $this->users = array();
493             $this->userselect_params = array();
494         } else {
495             list($usql, $uparams) = $DB->get_in_or_equal(array_keys($this->users), SQL_PARAMS_NAMED, 'usid0');
496             $this->userselect = "AND g.userid $usql";
497             $this->userselect_params = $uparams;
499             // First flag everyone as not suspended.
500             foreach ($this->users as $user) {
501                 $this->users[$user->id]->suspendedenrolment = false;
502             }
504             // If we want to mix both suspended and not suspended users, let's find out who is suspended.
505             if (!$showonlyactiveenrol) {
506                 $sql = "SELECT ue.userid
507                           FROM {user_enrolments} ue
508                           JOIN {enrol} e ON e.id = ue.enrolid
509                          WHERE ue.userid $usql
510                                AND ue.status = :uestatus
511                                AND e.status = :estatus
512                                AND e.courseid = :courseid
513                                AND ue.timestart < :now1 AND (ue.timeend = 0 OR ue.timeend > :now2)
514                       GROUP BY ue.userid";
516                 $time = time();
517                 $params = array_merge($uparams, array('estatus' => ENROL_INSTANCE_ENABLED, 'uestatus' => ENROL_USER_ACTIVE,
518                         'courseid' => $coursecontext->instanceid, 'now1' => $time, 'now2' => $time));
519                 $useractiveenrolments = $DB->get_records_sql($sql, $params);
521                 foreach ($this->users as $user) {
522                     $this->users[$user->id]->suspendedenrolment = !array_key_exists($user->id, $useractiveenrolments);
523                 }
524             }
525         }
526         return $this->users;
527     }
529     /**
530      * Load all grade items.
531      */
532     protected function get_allgradeitems() {
533         if (!empty($this->allgradeitems)) {
534             return $this->allgradeitems;
535         }
536         $allgradeitems = grade_item::fetch_all(array('courseid' => $this->courseid));
537         // But hang on - don't include ones which are set to not show the grade at all.
538         $this->allgradeitems = array_filter($allgradeitems, function($item) {
539             return $item->gradetype != GRADE_TYPE_NONE;
540         });
542         return $this->allgradeitems;
543     }
545     /**
546      * we supply the userids in this query, and get all the grades
547      * pulls out all the grades, this does not need to worry about paging
548      */
549     public function load_final_grades() {
550         global $CFG, $DB;
552         if (!empty($this->grades)) {
553             return;
554         }
556         if (empty($this->users)) {
557             return;
558         }
560         // please note that we must fetch all grade_grades fields if we want to construct grade_grade object from it!
561         $params = array_merge(array('courseid'=>$this->courseid), $this->userselect_params);
562         $sql = "SELECT g.*
563                   FROM {grade_items} gi,
564                        {grade_grades} g
565                  WHERE g.itemid = gi.id AND gi.courseid = :courseid {$this->userselect}";
567         $userids = array_keys($this->users);
569         if ($grades = $DB->get_records_sql($sql, $params)) {
570             foreach ($grades as $graderec) {
571                 $grade = new grade_grade($graderec, false);
572                 $this->allgrades[$graderec->userid][$graderec->itemid] = $grade;
573                 if (in_array($graderec->userid, $userids) and array_key_exists($graderec->itemid, $this->gtree->get_items())) { // some items may not be present!!
574                     $this->grades[$graderec->userid][$graderec->itemid] = $grade;
575                     $this->grades[$graderec->userid][$graderec->itemid]->grade_item = $this->gtree->get_item($graderec->itemid); // db caching
576                 }
577             }
578         }
580         // prefil grades that do not exist yet
581         foreach ($userids as $userid) {
582             foreach ($this->gtree->get_items() as $itemid => $unused) {
583                 if (!isset($this->grades[$userid][$itemid])) {
584                     $this->grades[$userid][$itemid] = new grade_grade();
585                     $this->grades[$userid][$itemid]->itemid = $itemid;
586                     $this->grades[$userid][$itemid]->userid = $userid;
587                     $this->grades[$userid][$itemid]->grade_item = $this->gtree->get_item($itemid); // db caching
589                     $this->allgrades[$userid][$itemid] = $this->grades[$userid][$itemid];
590                 }
591             }
592         }
594         // Pre fill grades for any remaining items which might be collapsed.
595         $allgradeitems = $this->get_allgradeitems();
596         foreach ($userids as $userid) {
597             foreach ($allgradeitems as $itemid => $gradeitem) {
598                 if (!isset($this->allgrades[$userid][$itemid])) {
599                     $this->allgrades[$userid][$itemid] = new grade_grade();
600                     $this->allgrades[$userid][$itemid]->itemid = $itemid;
601                     $this->allgrades[$userid][$itemid]->userid = $userid;
602                     $this->allgrades[$userid][$itemid]->grade_item = $gradeitem;
603                 }
604             }
605         }
606     }
608     /**
609      * Gets html toggle
610      * @deprecated since Moodle 2.4 as it appears not to be used any more.
611      */
612     public function get_toggles_html() {
613         throw new coding_exception('get_toggles_html() can not be used any more');
614     }
616     /**
617      * Prints html toggle
618      * @deprecated since 2.4 as it appears not to be used any more.
619      * @param unknown $type
620      */
621     public function print_toggle($type) {
622         throw new coding_exception('print_toggle() can not be used any more');
623     }
625     /**
626      * Builds and returns the rows that will make up the left part of the grader report
627      * This consists of student names and icons, links to user reports and id numbers, as well
628      * as header cells for these columns. It also includes the fillers required for the
629      * categories displayed on the right side of the report.
630      * @param boolean $displayaverages whether to display average rows in the table
631      * @return array Array of html_table_row objects
632      */
633     public function get_left_rows($displayaverages) {
634         global $CFG, $USER, $OUTPUT;
636         $rows = array();
638         $showuserimage = $this->get_pref('showuserimage');
639         // FIXME: MDL-52678 This get_capability_info is hacky and we should have an API for inserting grade row links instead.
640         $canseeuserreport = false;
641         $canseesingleview = false;
642         if (get_capability_info('gradereport/'.$CFG->grade_profilereport.':view')) {
643             $canseeuserreport = has_capability('gradereport/'.$CFG->grade_profilereport.':view', $this->context);
644         }
645         if (get_capability_info('gradereport/singleview:view')) {
646             $canseesingleview = has_all_capabilities(array('gradereport/singleview:view', 'moodle/grade:viewall',
647             'moodle/grade:edit'), $this->context);
648         }
649         $hasuserreportcell = $canseeuserreport || $canseesingleview;
651         $strfeedback  = $this->get_lang_string("feedback");
652         $strgrade     = $this->get_lang_string('grade');
654         $extrafields = get_extra_user_fields($this->context);
656         $arrows = $this->get_sort_arrows($extrafields);
658         $colspan = 1 + $hasuserreportcell + count($extrafields);
660         $levels = count($this->gtree->levels) - 1;
662         $fillercell = new html_table_cell();
663         $fillercell->header = true;
664         $fillercell->attributes['scope'] = 'col';
665         $fillercell->attributes['class'] = 'cell topleft';
666         $fillercell->text = html_writer::span(get_string('participants'), 'accesshide');
667         $fillercell->colspan = $colspan;
668         $fillercell->rowspan = $levels;
669         $row = new html_table_row(array($fillercell));
670         $rows[] = $row;
672         for ($i = 1; $i < $levels; $i++) {
673             $row = new html_table_row();
674             $rows[] = $row;
675         }
677         $headerrow = new html_table_row();
678         $headerrow->attributes['class'] = 'heading';
680         $studentheader = new html_table_cell();
681         $studentheader->attributes['class'] = 'header';
682         $studentheader->scope = 'col';
683         $studentheader->header = true;
684         $studentheader->id = 'studentheader';
685         if ($hasuserreportcell) {
686             $studentheader->colspan = 2;
687         }
688         $studentheader->text = $arrows['studentname'];
690         $headerrow->cells[] = $studentheader;
692         foreach ($extrafields as $field) {
693             $fieldheader = new html_table_cell();
694             $fieldheader->attributes['class'] = 'header userfield user' . $field;
695             $fieldheader->scope = 'col';
696             $fieldheader->header = true;
697             $fieldheader->text = $arrows[$field];
699             $headerrow->cells[] = $fieldheader;
700         }
702         $rows[] = $headerrow;
704         $rows = $this->get_left_icons_row($rows, $colspan);
706         $suspendedstring = null;
707         foreach ($this->users as $userid => $user) {
708             $userrow = new html_table_row();
709             $userrow->id = 'fixed_user_'.$userid;
711             $usercell = new html_table_cell();
712             $usercell->attributes['class'] = 'header user';
714             $usercell->header = true;
715             $usercell->scope = 'row';
717             if ($showuserimage) {
718                 $usercell->text = $OUTPUT->user_picture($user, array('visibletoscreenreaders' => false));
719             }
721             $fullname = fullname($user);
722             $usercell->text .= html_writer::link(new moodle_url('/user/view.php', array('id' => $user->id, 'course' => $this->course->id)), $fullname, array(
723                 'class' => 'username',
724             ));
726             if (!empty($user->suspendedenrolment)) {
727                 $usercell->attributes['class'] .= ' usersuspended';
729                 //may be lots of suspended users so only get the string once
730                 if (empty($suspendedstring)) {
731                     $suspendedstring = get_string('userenrolmentsuspended', 'grades');
732                 }
733                 $usercell->text .= html_writer::empty_tag('img', array('src'=>$OUTPUT->pix_url('i/enrolmentsuspended'), 'title'=>$suspendedstring,
734                         'alt'=>$suspendedstring, 'class'=>'usersuspendedicon'));
735             }
737             $userrow->cells[] = $usercell;
739             $userreportcell = new html_table_cell();
740             $userreportcell->attributes['class'] = 'userreport';
741             $userreportcell->header = false;
742             if ($canseeuserreport) {
743                 $a = new stdClass();
744                 $a->user = $fullname;
745                 $strgradesforuser = get_string('gradesforuser', 'grades', $a);
746                 $url = new moodle_url('/grade/report/'.$CFG->grade_profilereport.'/index.php', array('userid' => $user->id, 'id' => $this->course->id));
747                 $userreportcell->text .= $OUTPUT->action_icon($url, new pix_icon('t/grades', $strgradesforuser));
748             }
750             if ($canseesingleview) {
751                 $url = new moodle_url('/grade/report/singleview/index.php', array('id' => $this->course->id, 'itemid' => $user->id, 'item' => 'user'));
752                 $singleview = $OUTPUT->action_icon($url, new pix_icon('t/editstring', get_string('singleview', 'grades', $fullname)));
753                 $userreportcell->text .= $singleview;
754             }
756             if ($userreportcell->text) {
757                 $userrow->cells[] = $userreportcell;
758             }
760             foreach ($extrafields as $field) {
761                 $fieldcell = new html_table_cell();
762                 $fieldcell->attributes['class'] = 'userfield user' . $field;
763                 $fieldcell->header = false;
764                 $fieldcell->text = $user->{$field};
765                 $userrow->cells[] = $fieldcell;
766             }
768             $userrow->attributes['data-uid'] = $userid;
769             $rows[] = $userrow;
770         }
772         $rows = $this->get_left_range_row($rows, $colspan);
773         if ($displayaverages) {
774             $rows = $this->get_left_avg_row($rows, $colspan, true);
775             $rows = $this->get_left_avg_row($rows, $colspan);
776         }
778         return $rows;
779     }
781     /**
782      * Builds and returns the rows that will make up the right part of the grader report
783      * @param boolean $displayaverages whether to display average rows in the table
784      * @return array Array of html_table_row objects
785      */
786     public function get_right_rows($displayaverages) {
787         global $CFG, $USER, $OUTPUT, $DB, $PAGE;
789         $rows = array();
790         $this->rowcount = 0;
791         $numrows = count($this->gtree->get_levels());
792         $numusers = count($this->users);
793         $gradetabindex = 1;
794         $columnstounset = array();
795         $strgrade = $this->get_lang_string('grade');
796         $strfeedback  = $this->get_lang_string("feedback");
797         $arrows = $this->get_sort_arrows();
799         $jsarguments = array(
800             'cfg'       => array('ajaxenabled'=>false),
801             'items'     => array(),
802             'users'     => array(),
803             'feedback'  => array(),
804             'grades'    => array()
805         );
806         $jsscales = array();
808         // Get preferences once.
809         $showactivityicons = $this->get_pref('showactivityicons');
810         $quickgrading = $this->get_pref('quickgrading');
811         $showquickfeedback = $this->get_pref('showquickfeedback');
812         $enableajax = $this->get_pref('enableajax');
813         $showanalysisicon = $this->get_pref('showanalysisicon');
815         // Get strings which are re-used inside the loop.
816         $strftimedatetimeshort = get_string('strftimedatetimeshort');
817         $strexcludedgrades = get_string('excluded', 'grades');
818         $strerror = get_string('error');
820         foreach ($this->gtree->get_levels() as $key => $row) {
821             $headingrow = new html_table_row();
822             $headingrow->attributes['class'] = 'heading_name_row';
824             foreach ($row as $columnkey => $element) {
825                 $sortlink = clone($this->baseurl);
826                 if (isset($element['object']->id)) {
827                     $sortlink->param('sortitemid', $element['object']->id);
828                 }
830                 $eid    = $element['eid'];
831                 $object = $element['object'];
832                 $type   = $element['type'];
833                 $categorystate = @$element['categorystate'];
835                 if (!empty($element['colspan'])) {
836                     $colspan = $element['colspan'];
837                 } else {
838                     $colspan = 1;
839                 }
841                 if (!empty($element['depth'])) {
842                     $catlevel = 'catlevel'.$element['depth'];
843                 } else {
844                     $catlevel = '';
845                 }
847                 // Element is a filler
848                 if ($type == 'filler' or $type == 'fillerfirst' or $type == 'fillerlast') {
849                     $fillercell = new html_table_cell();
850                     $fillercell->attributes['class'] = $type . ' ' . $catlevel;
851                     $fillercell->colspan = $colspan;
852                     $fillercell->text = '&nbsp;';
854                     // This is a filler cell; don't use a <th>, it'll confuse screen readers.
855                     $fillercell->header = false;
856                     $headingrow->cells[] = $fillercell;
857                 } else if ($type == 'category') {
858                     // Make sure the grade category has a grade total or at least has child grade items.
859                     if (grade_tree::can_output_item($element)) {
860                         // Element is a category.
861                         $categorycell = new html_table_cell();
862                         $categorycell->attributes['class'] = 'category ' . $catlevel;
863                         $categorycell->colspan = $colspan;
864                         $categorycell->text = $this->get_course_header($element);
865                         $categorycell->header = true;
866                         $categorycell->scope = 'col';
868                         // Print icons.
869                         if ($USER->gradeediting[$this->courseid]) {
870                             $categorycell->text .= $this->get_icons($element);
871                         }
873                         $headingrow->cells[] = $categorycell;
874                     }
875                 } else {
876                     // Element is a grade_item
877                     if ($element['object']->id == $this->sortitemid) {
878                         if ($this->sortorder == 'ASC') {
879                             $arrow = $this->get_sort_arrow('up', $sortlink);
880                         } else {
881                             $arrow = $this->get_sort_arrow('down', $sortlink);
882                         }
883                     } else {
884                         $arrow = $this->get_sort_arrow('move', $sortlink);
885                     }
887                     $headerlink = $this->gtree->get_element_header($element, true, $showactivityicons, false, false, true);
889                     $itemcell = new html_table_cell();
890                     $itemcell->attributes['class'] = $type . ' ' . $catlevel . ' highlightable'. ' i'. $element['object']->id;
891                     $itemcell->attributes['data-itemid'] = $element['object']->id;
893                     if ($element['object']->is_hidden()) {
894                         $itemcell->attributes['class'] .= ' dimmed_text';
895                     }
897                     $singleview = '';
899                     // FIXME: MDL-52678 This is extremely hacky we should have an API for inserting grade column links.
900                     if (get_capability_info('gradereport/singleview:view')) {
901                         if (has_all_capabilities(array('gradereport/singleview:view', 'moodle/grade:viewall',
902                             'moodle/grade:edit'), $this->context)) {
904                             $url = new moodle_url('/grade/report/singleview/index.php', array(
905                                 'id' => $this->course->id,
906                                 'item' => 'grade',
907                                 'itemid' => $element['object']->id));
908                             $singleview = $OUTPUT->action_icon(
909                                 $url,
910                                 new pix_icon('t/editstring', get_string('singleview', 'grades', $element['object']->get_name()))
911                             );
912                         }
913                     }
915                     $itemcell->colspan = $colspan;
916                     $itemcell->text = $headerlink . $arrow . $singleview;
917                     $itemcell->header = true;
918                     $itemcell->scope = 'col';
920                     $headingrow->cells[] = $itemcell;
921                 }
922             }
923             $rows[] = $headingrow;
924         }
926         $rows = $this->get_right_icons_row($rows);
928         // Preload scale objects for items with a scaleid and initialize tab indices
929         $scaleslist = array();
930         $tabindices = array();
932         foreach ($this->gtree->get_items() as $itemid => $item) {
933             $scale = null;
934             if (!empty($item->scaleid)) {
935                 $scaleslist[] = $item->scaleid;
936                 $jsarguments['items'][$itemid] = array('id'=>$itemid, 'name'=>$item->get_name(true), 'type'=>'scale', 'scale'=>$item->scaleid, 'decimals'=>$item->get_decimals());
937             } else {
938                 $jsarguments['items'][$itemid] = array('id'=>$itemid, 'name'=>$item->get_name(true), 'type'=>'value', 'scale'=>false, 'decimals'=>$item->get_decimals());
939             }
940             $tabindices[$item->id]['grade'] = $gradetabindex;
941             $tabindices[$item->id]['feedback'] = $gradetabindex + $numusers;
942             $gradetabindex += $numusers * 2;
943         }
944         $scalesarray = array();
946         if (!empty($scaleslist)) {
947             $scalesarray = $DB->get_records_list('scale', 'id', $scaleslist);
948         }
949         $jsscales = $scalesarray;
951         // Get all the grade items if the user can not view hidden grade items.
952         // It is possible that the user is simply viewing the 'Course total' by switching to the 'Aggregates only' view
953         // and that this user does not have the ability to view hidden items. In this case we still need to pass all the
954         // grade items (in case one has been hidden) as the course total shown needs to be adjusted for this particular
955         // user.
956         if (!$this->canviewhidden) {
957             $allgradeitems = $this->get_allgradeitems();
958         }
960         foreach ($this->users as $userid => $user) {
962             if ($this->canviewhidden) {
963                 $altered = array();
964                 $unknown = array();
965             } else {
966                 $usergrades = $this->allgrades[$userid];
967                 $hidingaffected = grade_grade::get_hiding_affected($usergrades, $allgradeitems);
968                 $altered = $hidingaffected['altered'];
969                 $unknown = $hidingaffected['unknown'];
970                 unset($hidingaffected);
971             }
973             $itemrow = new html_table_row();
974             $itemrow->id = 'user_'.$userid;
976             $fullname = fullname($user);
977             $jsarguments['users'][$userid] = $fullname;
979             foreach ($this->gtree->items as $itemid => $unused) {
980                 $item =& $this->gtree->items[$itemid];
981                 $grade = $this->grades[$userid][$item->id];
983                 $itemcell = new html_table_cell();
985                 $itemcell->id = 'u'.$userid.'i'.$itemid;
986                 $itemcell->attributes['data-itemid'] = $itemid;
988                 // Get the decimal points preference for this item
989                 $decimalpoints = $item->get_decimals();
991                 if (in_array($itemid, $unknown)) {
992                     $gradeval = null;
993                 } else if (array_key_exists($itemid, $altered)) {
994                     $gradeval = $altered[$itemid];
995                 } else {
996                     $gradeval = $grade->finalgrade;
997                 }
998                 if (!empty($grade->finalgrade)) {
999                     $gradevalforjs = null;
1000                     if ($item->scaleid && !empty($scalesarray[$item->scaleid])) {
1001                         $gradevalforjs = (int)$gradeval;
1002                     } else {
1003                         $gradevalforjs = format_float($gradeval, $decimalpoints);
1004                     }
1005                     $jsarguments['grades'][] = array('user'=>$userid, 'item'=>$itemid, 'grade'=>$gradevalforjs);
1006                 }
1008                 // MDL-11274
1009                 // Hide grades in the grader report if the current grader doesn't have 'moodle/grade:viewhidden'
1010                 if (!$this->canviewhidden and $grade->is_hidden()) {
1011                     if (!empty($CFG->grade_hiddenasdate) and $grade->get_datesubmitted() and !$item->is_category_item() and !$item->is_course_item()) {
1012                         // 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
1013                         $itemcell->text = "<span class='datesubmitted'>" .
1014                                 userdate($grade->get_datesubmitted(), $strftimedatetimeshort) . "</span>";
1015                     } else {
1016                         $itemcell->text = '-';
1017                     }
1018                     $itemrow->cells[] = $itemcell;
1019                     continue;
1020                 }
1022                 // emulate grade element
1023                 $eid = $this->gtree->get_grade_eid($grade);
1024                 $element = array('eid'=>$eid, 'object'=>$grade, 'type'=>'grade');
1026                 $itemcell->attributes['class'] .= ' grade i'.$itemid;
1027                 if ($item->is_category_item()) {
1028                     $itemcell->attributes['class'] .= ' cat';
1029                 }
1030                 if ($item->is_course_item()) {
1031                     $itemcell->attributes['class'] .= ' course';
1032                 }
1033                 if ($grade->is_overridden()) {
1034                     $itemcell->attributes['class'] .= ' overridden';
1035                     $itemcell->attributes['aria-label'] = get_string('overriddengrade', 'gradereport_grader');
1036                 }
1038                 if (!empty($grade->feedback)) {
1039                     $feedback = wordwrap(trim(format_string($grade->feedback, $grade->feedbackformat)), 34, '<br>');
1040                     $itemcell->attributes['data-feedback'] = $feedback;
1041                     $jsarguments['feedback'][] = array('user'=>$userid, 'item'=>$itemid, 'content' => $feedback);
1042                 }
1044                 if ($grade->is_excluded()) {
1045                     // Adding white spaces before and after to prevent a screenreader from
1046                     // thinking that the words are attached to the next/previous <span> or text.
1047                     $itemcell->text .= " <span class='excludedfloater'>" . $strexcludedgrades . "</span> ";
1048                 }
1050                 // Do not show any icons if no grade (no record in DB to match)
1051                 if (!$item->needsupdate and $USER->gradeediting[$this->courseid]) {
1052                     $itemcell->text .= $this->get_icons($element);
1053                 }
1055                 $hidden = '';
1056                 if ($grade->is_hidden()) {
1057                     $hidden = ' dimmed_text ';
1058                 }
1060                 $gradepass = ' gradefail ';
1061                 if ($grade->is_passed($item)) {
1062                     $gradepass = ' gradepass ';
1063                 } else if (is_null($grade->is_passed($item))) {
1064                     $gradepass = '';
1065                 }
1067                 // if in editing mode, we need to print either a text box
1068                 // or a drop down (for scales)
1069                 // grades in item of type grade category or course are not directly editable
1070                 if ($item->needsupdate) {
1071                     $itemcell->text .= "<span class='gradingerror{$hidden}'>" . $strerror . "</span>";
1073                 } else if ($USER->gradeediting[$this->courseid]) {
1075                     if ($item->scaleid && !empty($scalesarray[$item->scaleid])) {
1076                         $itemcell->attributes['class'] .= ' grade_type_scale';
1077                     } else if ($item->gradetype == GRADE_TYPE_VALUE) {
1078                         $itemcell->attributes['class'] .= ' grade_type_value';
1079                     } else if ($item->gradetype == GRADE_TYPE_TEXT) {
1080                         $itemcell->attributes['class'] .= ' grade_type_text';
1081                     }
1083                     if ($item->scaleid && !empty($scalesarray[$item->scaleid])) {
1084                         $scale = $scalesarray[$item->scaleid];
1085                         $gradeval = (int)$gradeval; // scales use only integers
1086                         $scales = explode(",", $scale->scale);
1087                         // reindex because scale is off 1
1089                         // MDL-12104 some previous scales might have taken up part of the array
1090                         // so this needs to be reset
1091                         $scaleopt = array();
1092                         $i = 0;
1093                         foreach ($scales as $scaleoption) {
1094                             $i++;
1095                             $scaleopt[$i] = $scaleoption;
1096                         }
1098                         if ($quickgrading and $grade->is_editable()) {
1099                             $oldval = empty($gradeval) ? -1 : $gradeval;
1100                             if (empty($item->outcomeid)) {
1101                                 $nogradestr = $this->get_lang_string('nograde');
1102                             } else {
1103                                 $nogradestr = $this->get_lang_string('nooutcome', 'grades');
1104                             }
1105                             $attributes = array('tabindex' => $tabindices[$item->id]['grade'], 'id'=>'grade_'.$userid.'_'.$item->id);
1106                             $gradelabel = $fullname . ' ' . $item->get_name(true);
1107                             $itemcell->text .= html_writer::label(
1108                                 get_string('useractivitygrade', 'gradereport_grader', $gradelabel), $attributes['id'], false,
1109                                     array('class' => 'accesshide'));
1110                             $itemcell->text .= html_writer::select($scaleopt, 'grade['.$userid.']['.$item->id.']', $gradeval, array(-1=>$nogradestr), $attributes);
1111                         } else if (!empty($scale)) {
1112                             $scales = explode(",", $scale->scale);
1114                             // invalid grade if gradeval < 1
1115                             if ($gradeval < 1) {
1116                                 $itemcell->text .= "<span class='gradevalue{$hidden}{$gradepass}'>-</span>";
1117                             } else {
1118                                 $gradeval = $grade->grade_item->bounded_grade($gradeval); //just in case somebody changes scale
1119                                 $itemcell->text .= "<span class='gradevalue{$hidden}{$gradepass}'>{$scales[$gradeval - 1]}</span>";
1120                             }
1121                         }
1123                     } else if ($item->gradetype != GRADE_TYPE_TEXT) { // Value type
1124                         if ($quickgrading and $grade->is_editable()) {
1125                             $value = format_float($gradeval, $decimalpoints);
1126                             $gradelabel = $fullname . ' ' . $item->get_name(true);
1127                             $itemcell->text .= '<label class="accesshide" for="grade_'.$userid.'_'.$item->id.'">'
1128                                           .get_string('useractivitygrade', 'gradereport_grader', $gradelabel).'</label>';
1129                             $itemcell->text .= '<input size="6" tabindex="' . $tabindices[$item->id]['grade']
1130                                           . '" type="text" class="text" title="'. $strgrade .'" name="grade['
1131                                           .$userid.'][' .$item->id.']" id="grade_'.$userid.'_'.$item->id.'" value="'.$value.'" />';
1132                         } else {
1133                             $itemcell->text .= "<span class='gradevalue{$hidden}{$gradepass}'>" .
1134                                     format_float($gradeval, $decimalpoints) . "</span>";
1135                         }
1136                     }
1138                     // If quickfeedback is on, print an input element
1139                     if ($showquickfeedback and $grade->is_editable()) {
1140                         $feedbacklabel = $fullname . ' ' . $item->get_name(true);
1141                         $itemcell->text .= '<label class="accesshide" for="feedback_'.$userid.'_'.$item->id.'">'
1142                                       .get_string('useractivityfeedback', 'gradereport_grader', $feedbacklabel).'</label>';
1143                         $itemcell->text .= '<input class="quickfeedback" tabindex="' . $tabindices[$item->id]['feedback'].'" id="feedback_'.$userid.'_'.$item->id
1144                                       . '" size="6" title="' . $strfeedback . '" type="text" name="feedback['.$userid.']['.$item->id.']" value="' . s($grade->feedback) . '" />';
1145                     }
1147                 } else { // Not editing
1148                     $gradedisplaytype = $item->get_displaytype();
1150                     if ($item->scaleid && !empty($scalesarray[$item->scaleid])) {
1151                         $itemcell->attributes['class'] .= ' grade_type_scale';
1152                     } else if ($item->gradetype == GRADE_TYPE_VALUE) {
1153                         $itemcell->attributes['class'] .= ' grade_type_value';
1154                     } else if ($item->gradetype == GRADE_TYPE_TEXT) {
1155                         $itemcell->attributes['class'] .= ' grade_type_text';
1156                     }
1158                     // Only allow edting if the grade is editable (not locked, not in a unoverridable category, etc).
1159                     if ($enableajax && $grade->is_editable()) {
1160                         // If a grade item is type text, and we don't have show quick feedback on, it can't be edited.
1161                         if ($item->gradetype != GRADE_TYPE_TEXT || $showquickfeedback) {
1162                             $itemcell->attributes['class'] .= ' clickable';
1163                         }
1164                     }
1166                     if ($item->needsupdate) {
1167                         $itemcell->text .= "<span class='gradingerror{$hidden}{$gradepass}'>" . $error . "</span>";
1168                     } else {
1169                         // The max and min for an aggregation may be different to the grade_item.
1170                         if (!is_null($gradeval)) {
1171                             $item->grademax = $grade->get_grade_max();
1172                             $item->grademin = $grade->get_grade_min();
1173                         }
1175                         $itemcell->text .= "<span class='gradevalue{$hidden}{$gradepass}'>" .
1176                                 grade_format_gradevalue($gradeval, $item, true, $gradedisplaytype, null) . "</span>";
1177                         if ($showanalysisicon) {
1178                             $itemcell->text .= $this->gtree->get_grade_analysis_icon($grade);
1179                         }
1180                     }
1181                 }
1183                 // Enable keyboard navigation if the grade is editable (not locked, not in a unoverridable category, etc).
1184                 if ($enableajax && $grade->is_editable()) {
1185                     // If a grade item is type text, and we don't have show quick feedback on, it can't be edited.
1186                     if ($item->gradetype != GRADE_TYPE_TEXT || $showquickfeedback) {
1187                         $itemcell->attributes['class'] .= ' gbnavigable';
1188                     }
1189                 }
1191                 if (!empty($this->gradeserror[$item->id][$userid])) {
1192                     $itemcell->text .= $this->gradeserror[$item->id][$userid];
1193                 }
1195                 $itemrow->cells[] = $itemcell;
1196             }
1197             $rows[] = $itemrow;
1198         }
1200         if ($enableajax) {
1201             $jsarguments['cfg']['ajaxenabled'] = true;
1202             $jsarguments['cfg']['scales'] = array();
1203             foreach ($jsscales as $scale) {
1204                 // Trim the scale values, as they may have a space that is ommitted from values later.
1205                 $jsarguments['cfg']['scales'][$scale->id] = array_map('trim', explode(',', $scale->scale));
1206             }
1207             $jsarguments['cfg']['feedbacktrunclength'] =  $this->feedback_trunc_length;
1209             // Student grades and feedback are already at $jsarguments['feedback'] and $jsarguments['grades']
1210         }
1211         $jsarguments['cfg']['isediting'] = (bool)$USER->gradeediting[$this->courseid];
1212         $jsarguments['cfg']['courseid'] = $this->courseid;
1213         $jsarguments['cfg']['studentsperpage'] = $this->get_students_per_page();
1214         $jsarguments['cfg']['showquickfeedback'] = (bool) $showquickfeedback;
1216         $module = array(
1217             'name'      => 'gradereport_grader',
1218             'fullpath'  => '/grade/report/grader/module.js',
1219             'requires'  => array('base', 'dom', 'event', 'event-mouseenter', 'event-key', 'io-queue', 'json-parse', 'overlay')
1220         );
1221         $PAGE->requires->js_init_call('M.gradereport_grader.init_report', $jsarguments, false, $module);
1222         $PAGE->requires->strings_for_js(array('addfeedback', 'feedback', 'grade'), 'grades');
1223         $PAGE->requires->strings_for_js(array('ajaxchoosescale', 'ajaxclicktoclose', 'ajaxerror', 'ajaxfailedupdate', 'ajaxfieldchanged'), 'gradereport_grader');
1224         if (!$enableajax && $USER->gradeediting[$this->courseid]) {
1225             $PAGE->requires->yui_module('moodle-core-formchangechecker',
1226                     'M.core_formchangechecker.init',
1227                     array(array(
1228                         'formid' => 'gradereport_grader'
1229                     ))
1230             );
1231             $PAGE->requires->string_for_js('changesmadereallygoaway', 'moodle');
1232         }
1234         $rows = $this->get_right_range_row($rows);
1235         if ($displayaverages) {
1236             $rows = $this->get_right_avg_row($rows, true);
1237             $rows = $this->get_right_avg_row($rows);
1238         }
1240         return $rows;
1241     }
1243     /**
1244      * Depending on the style of report (fixedstudents vs traditional one-table),
1245      * arranges the rows of data in one or two tables, and returns the output of
1246      * these tables in HTML
1247      * @param boolean $displayaverages whether to display average rows in the table
1248      * @return string HTML
1249      */
1250     public function get_grade_table($displayaverages = false) {
1251         global $OUTPUT;
1252         $leftrows = $this->get_left_rows($displayaverages);
1253         $rightrows = $this->get_right_rows($displayaverages);
1255         $html = '';
1257         $fulltable = new html_table();
1258         $fulltable->attributes['class'] = 'gradereport-grader-table';
1259         $fulltable->id = 'user-grades';
1260         $fulltable->summary = get_string('summarygrader', 'gradereport_grader');
1262         // Extract rows from each side (left and right) and collate them into one row each
1263         foreach ($leftrows as $key => $row) {
1264             $row->cells = array_merge($row->cells, $rightrows[$key]->cells);
1265             $fulltable->data[] = $row;
1266         }
1267         $html .= html_writer::table($fulltable);
1268         return $OUTPUT->container($html, 'gradeparent');
1269     }
1271     /**
1272      * Builds and return the row of icons for the left side of the report.
1273      * It only has one cell that says "Controls"
1274      * @param array $rows The Array of rows for the left part of the report
1275      * @param int $colspan The number of columns this cell has to span
1276      * @return array Array of rows for the left part of the report
1277      */
1278     public function get_left_icons_row($rows=array(), $colspan=1) {
1279         global $USER;
1281         if ($USER->gradeediting[$this->courseid]) {
1282             $controlsrow = new html_table_row();
1283             $controlsrow->attributes['class'] = 'controls';
1284             $controlscell = new html_table_cell();
1285             $controlscell->attributes['class'] = 'header controls';
1286             $controlscell->colspan = $colspan;
1287             $controlscell->text = $this->get_lang_string('controls', 'grades');
1289             $controlsrow->cells[] = $controlscell;
1290             $rows[] = $controlsrow;
1291         }
1292         return $rows;
1293     }
1295     /**
1296      * Builds and return the header for the row of ranges, for the left part of the grader report.
1297      * @param array $rows The Array of rows for the left part of the report
1298      * @param int $colspan The number of columns this cell has to span
1299      * @return array Array of rows for the left part of the report
1300      */
1301     public function get_left_range_row($rows=array(), $colspan=1) {
1302         global $CFG, $USER;
1304         if ($this->get_pref('showranges')) {
1305             $rangerow = new html_table_row();
1306             $rangerow->attributes['class'] = 'range r'.$this->rowcount++;
1307             $rangecell = new html_table_cell();
1308             $rangecell->attributes['class'] = 'header range';
1309             $rangecell->colspan = $colspan;
1310             $rangecell->header = true;
1311             $rangecell->scope = 'row';
1312             $rangecell->text = $this->get_lang_string('range', 'grades');
1313             $rangerow->cells[] = $rangecell;
1314             $rows[] = $rangerow;
1315         }
1317         return $rows;
1318     }
1320     /**
1321      * Builds and return the headers for the rows of averages, for the left part of the grader report.
1322      * @param array $rows The Array of rows for the left part of the report
1323      * @param int $colspan The number of columns this cell has to span
1324      * @param bool $groupavg If true, returns the row for group averages, otherwise for overall averages
1325      * @return array Array of rows for the left part of the report
1326      */
1327     public function get_left_avg_row($rows=array(), $colspan=1, $groupavg=false) {
1328         if (!$this->canviewhidden) {
1329             // totals might be affected by hiding, if user can not see hidden grades the aggregations might be altered
1330             // better not show them at all if user can not see all hideen grades
1331             return $rows;
1332         }
1334         $showaverages = $this->get_pref('showaverages');
1335         $showaveragesgroup = $this->currentgroup && $showaverages;
1336         $straveragegroup = get_string('groupavg', 'grades');
1338         if ($groupavg) {
1339             if ($showaveragesgroup) {
1340                 $groupavgrow = new html_table_row();
1341                 $groupavgrow->attributes['class'] = 'groupavg r'.$this->rowcount++;
1342                 $groupavgcell = new html_table_cell();
1343                 $groupavgcell->attributes['class'] = 'header range';
1344                 $groupavgcell->colspan = $colspan;
1345                 $groupavgcell->header = true;
1346                 $groupavgcell->scope = 'row';
1347                 $groupavgcell->text = $straveragegroup;
1348                 $groupavgrow->cells[] = $groupavgcell;
1349                 $rows[] = $groupavgrow;
1350             }
1351         } else {
1352             $straverage = get_string('overallaverage', 'grades');
1354             if ($showaverages) {
1355                 $avgrow = new html_table_row();
1356                 $avgrow->attributes['class'] = 'avg r'.$this->rowcount++;
1357                 $avgcell = new html_table_cell();
1358                 $avgcell->attributes['class'] = 'header range';
1359                 $avgcell->colspan = $colspan;
1360                 $avgcell->header = true;
1361                 $avgcell->scope = 'row';
1362                 $avgcell->text = $straverage;
1363                 $avgrow->cells[] = $avgcell;
1364                 $rows[] = $avgrow;
1365             }
1366         }
1368         return $rows;
1369     }
1371     /**
1372      * Builds and return the row of icons when editing is on, for the right part of the grader report.
1373      * @param array $rows The Array of rows for the right part of the report
1374      * @return array Array of rows for the right part of the report
1375      */
1376     public function get_right_icons_row($rows=array()) {
1377         global $USER;
1378         if ($USER->gradeediting[$this->courseid]) {
1379             $iconsrow = new html_table_row();
1380             $iconsrow->attributes['class'] = 'controls';
1382             foreach ($this->gtree->items as $itemid => $unused) {
1383                 // emulate grade element
1384                 $item = $this->gtree->get_item($itemid);
1386                 $eid = $this->gtree->get_item_eid($item);
1387                 $element = $this->gtree->locate_element($eid);
1388                 $itemcell = new html_table_cell();
1389                 $itemcell->attributes['class'] = 'controls icons i'.$itemid;
1390                 $itemcell->text = $this->get_icons($element);
1391                 $iconsrow->cells[] = $itemcell;
1392             }
1393             $rows[] = $iconsrow;
1394         }
1395         return $rows;
1396     }
1398     /**
1399      * Builds and return the row of ranges for the right part of the grader report.
1400      * @param array $rows The Array of rows for the right part of the report
1401      * @return array Array of rows for the right part of the report
1402      */
1403     public function get_right_range_row($rows=array()) {
1404         global $OUTPUT;
1406         if ($this->get_pref('showranges')) {
1407             $rangesdisplaytype   = $this->get_pref('rangesdisplaytype');
1408             $rangesdecimalpoints = $this->get_pref('rangesdecimalpoints');
1409             $rangerow = new html_table_row();
1410             $rangerow->attributes['class'] = 'heading range';
1412             foreach ($this->gtree->items as $itemid => $unused) {
1413                 $item =& $this->gtree->items[$itemid];
1414                 $itemcell = new html_table_cell();
1415                 $itemcell->attributes['class'] .= ' range i'. $itemid;
1417                 $hidden = '';
1418                 if ($item->is_hidden()) {
1419                     $hidden = ' dimmed_text ';
1420                 }
1422                 $formattedrange = $item->get_formatted_range($rangesdisplaytype, $rangesdecimalpoints);
1424                 $itemcell->text = $OUTPUT->container($formattedrange, 'rangevalues'.$hidden);
1425                 $rangerow->cells[] = $itemcell;
1426             }
1427             $rows[] = $rangerow;
1428         }
1429         return $rows;
1430     }
1432     /**
1433      * Builds and return the row of averages for the right part of the grader report.
1434      * @param array $rows Whether to return only group averages or all averages.
1435      * @param bool $grouponly Whether to return only group averages or all averages.
1436      * @return array Array of rows for the right part of the report
1437      */
1438     public function get_right_avg_row($rows=array(), $grouponly=false) {
1439         global $USER, $DB, $OUTPUT, $CFG;
1441         if (!$this->canviewhidden) {
1442             // Totals might be affected by hiding, if user can not see hidden grades the aggregations might be altered
1443             // better not show them at all if user can not see all hidden grades.
1444             return $rows;
1445         }
1447         $averagesdisplaytype   = $this->get_pref('averagesdisplaytype');
1448         $averagesdecimalpoints = $this->get_pref('averagesdecimalpoints');
1449         $meanselection         = $this->get_pref('meanselection');
1450         $shownumberofgrades    = $this->get_pref('shownumberofgrades');
1452         if ($grouponly) {
1453             $showaverages = $this->currentgroup && $this->get_pref('showaverages');
1454             $groupsql = $this->groupsql;
1455             $groupwheresql = $this->groupwheresql;
1456             $groupwheresqlparams = $this->groupwheresql_params;
1457         } else {
1458             $showaverages = $this->get_pref('showaverages');
1459             $groupsql = "";
1460             $groupwheresql = "";
1461             $groupwheresqlparams = array();
1462         }
1464         if ($showaverages) {
1465             $totalcount = $this->get_numusers($grouponly);
1467             // Limit to users with a gradeable role.
1468             list($gradebookrolessql, $gradebookrolesparams) = $DB->get_in_or_equal(explode(',', $this->gradebookroles), SQL_PARAMS_NAMED, 'grbr0');
1470             // Limit to users with an active enrollment.
1471             $coursecontext = $this->context->get_course_context(true);
1472             $defaultgradeshowactiveenrol = !empty($CFG->grade_report_showonlyactiveenrol);
1473             $showonlyactiveenrol = get_user_preferences('grade_report_showonlyactiveenrol', $defaultgradeshowactiveenrol);
1474             $showonlyactiveenrol = $showonlyactiveenrol || !has_capability('moodle/course:viewsuspendedusers', $coursecontext);
1475             list($enrolledsql, $enrolledparams) = get_enrolled_sql($this->context, '', 0, $showonlyactiveenrol);
1477             // We want to query both the current context and parent contexts.
1478             list($relatedctxsql, $relatedctxparams) = $DB->get_in_or_equal($this->context->get_parent_context_ids(true), SQL_PARAMS_NAMED, 'relatedctx');
1480             $params = array_merge(array('courseid' => $this->courseid), $gradebookrolesparams, $enrolledparams, $groupwheresqlparams, $relatedctxparams);
1482             // Find sums of all grade items in course.
1483             $sql = "SELECT g.itemid, SUM(g.finalgrade) AS sum
1484                       FROM {grade_items} gi
1485                       JOIN {grade_grades} g ON g.itemid = gi.id
1486                       JOIN {user} u ON u.id = g.userid
1487                       JOIN ($enrolledsql) je ON je.id = u.id
1488                       JOIN (
1489                                SELECT DISTINCT ra.userid
1490                                  FROM {role_assignments} ra
1491                                 WHERE ra.roleid $gradebookrolessql
1492                                   AND ra.contextid $relatedctxsql
1493                            ) rainner ON rainner.userid = u.id
1494                       $groupsql
1495                      WHERE gi.courseid = :courseid
1496                        AND u.deleted = 0
1497                        AND g.finalgrade IS NOT NULL
1498                        $groupwheresql
1499                      GROUP BY g.itemid";
1500             $sumarray = array();
1501             if ($sums = $DB->get_records_sql($sql, $params)) {
1502                 foreach ($sums as $itemid => $csum) {
1503                     $sumarray[$itemid] = $csum->sum;
1504                 }
1505             }
1507             // MDL-10875 Empty grades must be evaluated as grademin, NOT always 0
1508             // This query returns a count of ungraded grades (NULL finalgrade OR no matching record in grade_grades table)
1509             $sql = "SELECT gi.id, COUNT(DISTINCT u.id) AS count
1510                       FROM {grade_items} gi
1511                       CROSS JOIN {user} u
1512                       JOIN ($enrolledsql) je
1513                            ON je.id = u.id
1514                       JOIN {role_assignments} ra
1515                            ON ra.userid = u.id
1516                       LEFT OUTER JOIN {grade_grades} g
1517                            ON (g.itemid = gi.id AND g.userid = u.id AND g.finalgrade IS NOT NULL)
1518                       $groupsql
1519                      WHERE gi.courseid = :courseid
1520                            AND ra.roleid $gradebookrolessql
1521                            AND ra.contextid $relatedctxsql
1522                            AND u.deleted = 0
1523                            AND g.id IS NULL
1524                            $groupwheresql
1525                   GROUP BY gi.id";
1527             $ungradedcounts = $DB->get_records_sql($sql, $params);
1529             $avgrow = new html_table_row();
1530             $avgrow->attributes['class'] = 'avg';
1532             foreach ($this->gtree->items as $itemid => $unused) {
1533                 $item =& $this->gtree->items[$itemid];
1535                 if ($item->needsupdate) {
1536                     $avgcell = new html_table_cell();
1537                     $avgcell->attributes['class'] = 'i'. $itemid;
1538                     $avgcell->text = $OUTPUT->container(get_string('error'), 'gradingerror');
1539                     $avgrow->cells[] = $avgcell;
1540                     continue;
1541                 }
1543                 if (!isset($sumarray[$item->id])) {
1544                     $sumarray[$item->id] = 0;
1545                 }
1547                 if (empty($ungradedcounts[$itemid])) {
1548                     $ungradedcount = 0;
1549                 } else {
1550                     $ungradedcount = $ungradedcounts[$itemid]->count;
1551                 }
1553                 if ($meanselection == GRADE_REPORT_MEAN_GRADED) {
1554                     $meancount = $totalcount - $ungradedcount;
1555                 } else { // Bump up the sum by the number of ungraded items * grademin
1556                     $sumarray[$item->id] += $ungradedcount * $item->grademin;
1557                     $meancount = $totalcount;
1558                 }
1560                 // Determine which display type to use for this average
1561                 if ($USER->gradeediting[$this->courseid]) {
1562                     $displaytype = GRADE_DISPLAY_TYPE_REAL;
1564                 } else if ($averagesdisplaytype == GRADE_REPORT_PREFERENCE_INHERIT) { // no ==0 here, please resave the report and user preferences
1565                     $displaytype = $item->get_displaytype();
1567                 } else {
1568                     $displaytype = $averagesdisplaytype;
1569                 }
1571                 // Override grade_item setting if a display preference (not inherit) was set for the averages
1572                 if ($averagesdecimalpoints == GRADE_REPORT_PREFERENCE_INHERIT) {
1573                     $decimalpoints = $item->get_decimals();
1575                 } else {
1576                     $decimalpoints = $averagesdecimalpoints;
1577                 }
1579                 if (!isset($sumarray[$item->id]) || $meancount == 0) {
1580                     $avgcell = new html_table_cell();
1581                     $avgcell->attributes['class'] = 'i'. $itemid;
1582                     $avgcell->text = '-';
1583                     $avgrow->cells[] = $avgcell;
1585                 } else {
1586                     $sum = $sumarray[$item->id];
1587                     $avgradeval = $sum/$meancount;
1588                     $gradehtml = grade_format_gradevalue($avgradeval, $item, true, $displaytype, $decimalpoints);
1590                     $numberofgrades = '';
1591                     if ($shownumberofgrades) {
1592                         $numberofgrades = " ($meancount)";
1593                     }
1595                     $avgcell = new html_table_cell();
1596                     $avgcell->attributes['class'] = 'i'. $itemid;
1597                     $avgcell->text = $gradehtml.$numberofgrades;
1598                     $avgrow->cells[] = $avgcell;
1599                 }
1600             }
1601             $rows[] = $avgrow;
1602         }
1603         return $rows;
1604     }
1606     /**
1607      * Given element category, create a collapsible icon and
1608      * course header.
1609      *
1610      * @param array $element
1611      * @return string HTML
1612      */
1613     protected function get_course_header($element) {
1614         global $OUTPUT;
1616         $icon = '';
1617         // If object is a category, display expand/contract icon.
1618         if ($element['type'] == 'category') {
1619             // Load language strings.
1620             $strswitchminus = $this->get_lang_string('aggregatesonly', 'grades');
1621             $strswitchplus  = $this->get_lang_string('gradesonly', 'grades');
1622             $strswitchwhole = $this->get_lang_string('fullmode', 'grades');
1624             $url = new moodle_url($this->gpr->get_return_url(null, array('target' => $element['eid'], 'sesskey' => sesskey())));
1626             if (in_array($element['object']->id, $this->collapsed['aggregatesonly'])) {
1627                 $url->param('action', 'switch_plus');
1628                 $icon = $OUTPUT->action_icon($url, new pix_icon('t/switch_plus', $strswitchplus), null, null);
1629                 $showing = get_string('showingaggregatesonly', 'grades');
1630             } else if (in_array($element['object']->id, $this->collapsed['gradesonly'])) {
1631                 $url->param('action', 'switch_whole');
1632                 $icon = $OUTPUT->action_icon($url, new pix_icon('t/switch_whole', $strswitchwhole), null, null);
1633                 $showing = get_string('showinggradesonly', 'grades');
1634             } else {
1635                 $url->param('action', 'switch_minus');
1636                 $icon = $OUTPUT->action_icon($url, new pix_icon('t/switch_minus', $strswitchminus), null, null);
1637                 $showing = get_string('showingfullmode', 'grades');
1638             }
1639         }
1641         $name = $element['object']->get_name();
1642         $courseheaderid = 'courseheader_' . clean_param($name, PARAM_ALPHANUMEXT);
1643         $courseheader = html_writer::tag('span', $name, array('id' => $courseheaderid,
1644                 'title' => $name, 'class' => 'gradeitemheader'));
1645         $courseheader .= html_writer::label($showing, $courseheaderid, false, array('class' => 'accesshide'));
1646         $courseheader .= $icon;
1648         return $courseheader;
1649     }
1651     /**
1652      * Given a grade_category, grade_item or grade_grade, this function
1653      * figures out the state of the object and builds then returns a div
1654      * with the icons needed for the grader report.
1655      *
1656      * @param array $element
1657      * @return string HTML
1658      */
1659     protected function get_icons($element) {
1660         global $CFG, $USER, $OUTPUT;
1662         if (!$USER->gradeediting[$this->courseid]) {
1663             return '<div class="grade_icons" />';
1664         }
1666         // Init all icons
1667         $editicon = '';
1669         $editable = true;
1671         if ($element['type'] == 'grade') {
1672             $item = $element['object']->grade_item;
1673             if ($item->is_course_item() or $item->is_category_item()) {
1674                 $editable = $this->overridecat;
1675             }
1676         }
1678         if ($element['type'] != 'categoryitem' && $element['type'] != 'courseitem' && $editable) {
1679             $editicon = $this->gtree->get_edit_icon($element, $this->gpr);
1680         }
1682         $editcalculationicon = '';
1683         $showhideicon        = '';
1684         $lockunlockicon      = '';
1686         if (has_capability('moodle/grade:manage', $this->context)) {
1687             if ($this->get_pref('showcalculations')) {
1688                 $editcalculationicon = $this->gtree->get_calculation_icon($element, $this->gpr);
1689             }
1691             if ($this->get_pref('showeyecons')) {
1692                 $showhideicon = $this->gtree->get_hiding_icon($element, $this->gpr);
1693             }
1695             if ($this->get_pref('showlocks')) {
1696                 $lockunlockicon = $this->gtree->get_locking_icon($element, $this->gpr);
1697             }
1699         }
1701         $gradeanalysisicon   = '';
1702         if ($this->get_pref('showanalysisicon') && $element['type'] == 'grade') {
1703             $gradeanalysisicon .= $this->gtree->get_grade_analysis_icon($element['object']);
1704         }
1706         return $OUTPUT->container($editicon.$editcalculationicon.$showhideicon.$lockunlockicon.$gradeanalysisicon, 'grade_icons');
1707     }
1709     /**
1710      * Given a category element returns collapsing +/- icon if available
1711      *
1712      * @deprecated since Moodle 2.9 MDL-46662 - please do not use this function any more.
1713      */
1714     protected function get_collapsing_icon($element) {
1715         throw new coding_exception('get_collapsing_icon() can not be used any more, please use get_course_header() instead.');
1716     }
1718     /**
1719      * Processes a single action against a category, grade_item or grade.
1720      * @param string $target eid ({type}{id}, e.g. c4 for category4)
1721      * @param string $action Which action to take (edit, delete etc...)
1722      * @return
1723      */
1724     public function process_action($target, $action) {
1725         return self::do_process_action($target, $action, $this->course->id);
1726     }
1728     /**
1729      * From the list of categories that this user prefers to collapse choose ones that belong to the current course.
1730      *
1731      * This function serves two purposes.
1732      * Mainly it helps migrating from user preference style when all courses were stored in one preference.
1733      * Also it helps to remove the settings for categories that were removed if the array for one course grows too big.
1734      *
1735      * @param int $courseid
1736      * @param array $collapsed
1737      * @return array
1738      */
1739     protected static function filter_collapsed_categories($courseid, $collapsed) {
1740         global $DB;
1741         if (empty($collapsed)) {
1742             $collapsed = array('aggregatesonly' => array(), 'gradesonly' => array());
1743         }
1744         if (empty($collapsed['aggregatesonly']) && empty($collapsed['gradesonly'])) {
1745             return $collapsed;
1746         }
1747         $cats = $DB->get_fieldset_select('grade_categories', 'id', 'courseid = ?', array($courseid));
1748         $collapsed['aggregatesonly'] = array_values(array_intersect($collapsed['aggregatesonly'], $cats));
1749         $collapsed['gradesonly'] = array_values(array_intersect($collapsed['gradesonly'], $cats));
1750         return $collapsed;
1751     }
1753     /**
1754      * Returns the list of categories that this user wants to collapse or display aggregatesonly
1755      *
1756      * This method also migrates on request from the old format of storing user preferences when they were stored
1757      * in one preference for all courses causing DB error when trying to insert very big value.
1758      *
1759      * @param int $courseid
1760      * @return array
1761      */
1762     protected static function get_collapsed_preferences($courseid) {
1763         if ($collapsed = get_user_preferences('grade_report_grader_collapsed_categories'.$courseid)) {
1764             return json_decode($collapsed, true);
1765         }
1767         // Try looking for old location of user setting that used to store all courses in one serialized user preference.
1768         if (($oldcollapsedpref = get_user_preferences('grade_report_grader_collapsed_categories')) !== null) {
1769             if ($collapsedall = @unserialize($oldcollapsedpref)) {
1770                 // We found the old-style preference, filter out only categories that belong to this course and update the prefs.
1771                 $collapsed = static::filter_collapsed_categories($courseid, $collapsedall);
1772                 if (!empty($collapsed['aggregatesonly']) || !empty($collapsed['gradesonly'])) {
1773                     static::set_collapsed_preferences($courseid, $collapsed);
1774                     $collapsedall['aggregatesonly'] = array_diff($collapsedall['aggregatesonly'], $collapsed['aggregatesonly']);
1775                     $collapsedall['gradesonly'] = array_diff($collapsedall['gradesonly'], $collapsed['gradesonly']);
1776                     if (!empty($collapsedall['aggregatesonly']) || !empty($collapsedall['gradesonly'])) {
1777                         set_user_preference('grade_report_grader_collapsed_categories', serialize($collapsedall));
1778                     } else {
1779                         unset_user_preference('grade_report_grader_collapsed_categories');
1780                     }
1781                 }
1782             } else {
1783                 // We found the old-style preference, but it is unreadable, discard it.
1784                 unset_user_preference('grade_report_grader_collapsed_categories');
1785             }
1786         } else {
1787             $collapsed = array('aggregatesonly' => array(), 'gradesonly' => array());
1788         }
1789         return $collapsed;
1790     }
1792     /**
1793      * Sets the list of categories that user wants to see collapsed in user preferences
1794      *
1795      * This method may filter or even trim the list if it does not fit in DB field.
1796      *
1797      * @param int $courseid
1798      * @param array $collapsed
1799      */
1800     protected static function set_collapsed_preferences($courseid, $collapsed) {
1801         global $DB;
1802         // In an unlikely case that the list of collapsed categories for one course is too big for the user preference size,
1803         // try to filter the list of categories since array may contain categories that were deleted.
1804         if (strlen(json_encode($collapsed)) >= 1333) {
1805             $collapsed = static::filter_collapsed_categories($courseid, $collapsed);
1806         }
1808         // If this did not help, "forget" about some of the collapsed categories. Still better than to loose all information.
1809         while (strlen(json_encode($collapsed)) >= 1333) {
1810             if (count($collapsed['aggregatesonly'])) {
1811                 array_pop($collapsed['aggregatesonly']);
1812             }
1813             if (count($collapsed['gradesonly'])) {
1814                 array_pop($collapsed['gradesonly']);
1815             }
1816         }
1818         if (!empty($collapsed['aggregatesonly']) || !empty($collapsed['gradesonly'])) {
1819             set_user_preference('grade_report_grader_collapsed_categories'.$courseid, json_encode($collapsed));
1820         } else {
1821             unset_user_preference('grade_report_grader_collapsed_categories'.$courseid);
1822         }
1823     }
1825     /**
1826      * Processes a single action against a category, grade_item or grade.
1827      * @param string $target eid ({type}{id}, e.g. c4 for category4)
1828      * @param string $action Which action to take (edit, delete etc...)
1829      * @param int $courseid affected course.
1830      * @return
1831      */
1832     public static function do_process_action($target, $action, $courseid = null) {
1833         global $DB;
1834         // TODO: this code should be in some grade_tree static method
1835         $targettype = substr($target, 0, 2);
1836         $targetid = substr($target, 2);
1837         // TODO: end
1839         if ($targettype !== 'cg') {
1840             // The following code only works with categories.
1841             return true;
1842         }
1844         if (!$courseid) {
1845             debugging('Function grade_report_grader::do_process_action() now requires additional argument courseid',
1846                 DEBUG_DEVELOPER);
1847             if (!$courseid = $DB->get_field('grade_categories', 'courseid', array('id' => $targetid), IGNORE_MISSING)) {
1848                 return true;
1849             }
1850         }
1852         $collapsed = static::get_collapsed_preferences($courseid);
1854         switch ($action) {
1855             case 'switch_minus': // Add category to array of aggregatesonly
1856                 if (!in_array($targetid, $collapsed['aggregatesonly'])) {
1857                     $collapsed['aggregatesonly'][] = $targetid;
1858                     static::set_collapsed_preferences($courseid, $collapsed);
1859                 }
1860                 break;
1862             case 'switch_plus': // Remove category from array of aggregatesonly, and add it to array of gradesonly
1863                 $key = array_search($targetid, $collapsed['aggregatesonly']);
1864                 if ($key !== false) {
1865                     unset($collapsed['aggregatesonly'][$key]);
1866                 }
1867                 if (!in_array($targetid, $collapsed['gradesonly'])) {
1868                     $collapsed['gradesonly'][] = $targetid;
1869                 }
1870                 static::set_collapsed_preferences($courseid, $collapsed);
1871                 break;
1872             case 'switch_whole': // Remove the category from the array of collapsed cats
1873                 $key = array_search($targetid, $collapsed['gradesonly']);
1874                 if ($key !== false) {
1875                     unset($collapsed['gradesonly'][$key]);
1876                     static::set_collapsed_preferences($courseid, $collapsed);
1877                 }
1879                 break;
1880             default:
1881                 break;
1882         }
1884         return true;
1885     }
1887     /**
1888      * Refactored function for generating HTML of sorting links with matching arrows.
1889      * Returns an array with 'studentname' and 'idnumber' as keys, with HTML ready
1890      * to inject into a table header cell.
1891      * @param array $extrafields Array of extra fields being displayed, such as
1892      *   user idnumber
1893      * @return array An associative array of HTML sorting links+arrows
1894      */
1895     public function get_sort_arrows(array $extrafields = array()) {
1896         global $OUTPUT;
1897         $arrows = array();
1899         $strsortasc   = $this->get_lang_string('sortasc', 'grades');
1900         $strsortdesc  = $this->get_lang_string('sortdesc', 'grades');
1901         $strfirstname = $this->get_lang_string('firstname');
1902         $strlastname  = $this->get_lang_string('lastname');
1903         $iconasc = $OUTPUT->pix_icon('t/sort_asc', $strsortasc, '', array('class' => 'iconsmall sorticon'));
1904         $icondesc = $OUTPUT->pix_icon('t/sort_desc', $strsortdesc, '', array('class' => 'iconsmall sorticon'));
1906         $firstlink = html_writer::link(new moodle_url($this->baseurl, array('sortitemid'=>'firstname')), $strfirstname);
1907         $lastlink = html_writer::link(new moodle_url($this->baseurl, array('sortitemid'=>'lastname')), $strlastname);
1909         $arrows['studentname'] = $lastlink;
1911         if ($this->sortitemid === 'lastname') {
1912             if ($this->sortorder == 'ASC') {
1913                 $arrows['studentname'] .= $iconasc;
1914             } else {
1915                 $arrows['studentname'] .= $icondesc;
1916             }
1917         }
1919         $arrows['studentname'] .= ' ' . $firstlink;
1921         if ($this->sortitemid === 'firstname') {
1922             if ($this->sortorder == 'ASC') {
1923                 $arrows['studentname'] .= $iconasc;
1924             } else {
1925                 $arrows['studentname'] .= $icondesc;
1926             }
1927         }
1929         foreach ($extrafields as $field) {
1930             $fieldlink = html_writer::link(new moodle_url($this->baseurl,
1931                     array('sortitemid'=>$field)), get_user_field_name($field));
1932             $arrows[$field] = $fieldlink;
1934             if ($field == $this->sortitemid) {
1935                 if ($this->sortorder == 'ASC') {
1936                     $arrows[$field] .= $iconasc;
1937                 } else {
1938                     $arrows[$field] .= $icondesc;
1939                 }
1940             }
1941         }
1943         return $arrows;
1944     }
1946     /**
1947      * Returns the maximum number of students to be displayed on each page
1948      *
1949      * @return int The maximum number of students to display per page
1950      */
1951     public function get_students_per_page() {
1952         return $this->get_pref('studentsperpage');
1953     }