source: moodle/trunk/fuentes/grade/report/grader/lib.php @ 1331

Last change on this file since 1331 was 1331, checked in by jrpelegrina, 3 years ago

Updated to moodle 3.0.3

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