2 // This file is part of Moodle - http://moodle.org/
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.
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.
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/>.
18 * Definition of the grader report class
20 * @package gradereport_grader
21 * @copyright 2007 Nicolas Connault
22 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25 require_once($CFG->dirroot . '/grade/report/lib.php');
26 require_once($CFG->libdir.'/tablelib.php');
29 * Class providing an API for the grader report building and displaying.
31 * @copyright 2007 Nicolas Connault
32 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
34 class grade_report_grader extends grade_report {
42 * Array of errors for bulk grades updating.
43 * @var array $gradeserror
45 public $gradeserror = array();
50 * The id of the grade_item by which this report will be sorted.
51 * @var int $sortitemid
56 * Sortorder used in the SQL selections.
62 * An SQL fragment affecting the search for users.
63 * @var string $userselect
68 * The bound params for $userselect
69 * @var array $userselectparams
71 public $userselectparams = array();
74 * List of collapsed categories from user preference
75 * @var array $collapsed
80 * A count of the rows, used for css classes.
86 * Capability check caching
87 * @var boolean $canviewhidden
89 public $canviewhidden;
92 * Length at which feedback will be truncated (to the nearest word) and an ellipsis be added.
93 * TODO replace this by a report preference
94 * @var int $feedback_trunc_length
96 protected $feedback_trunc_length = 50;
99 * Allow category grade overriding
100 * @var bool $overridecat
102 protected $overridecat;
105 * Constructor. Sets local copies of user preferences and initialises grade_tree.
106 * @param int $courseid
107 * @param object $gpr grade plugin return tracking object
108 * @param string $context
109 * @param int $page The current page being viewed (when report is paged)
110 * @param int $sortitemid The id of the grade_item by which to sort the table
112 public function __construct($courseid, $gpr, $context, $page=null, $sortitemid=null) {
114 parent::__construct($courseid, $gpr, $context, $page);
116 $this->canviewhidden = has_capability('moodle/grade:viewhidden', context_course::instance($this->course->id));
118 // load collapsed settings for this report
119 $this->collapsed = static::get_collapsed_preferences($this->course->id);
121 if (empty($CFG->enableoutcomes)) {
124 $nooutcomes = get_user_preferences('grade_report_shownooutcomes');
127 // if user report preference set or site report setting set use it, otherwise use course or site setting
128 $switch = $this->get_pref('aggregationposition');
130 $switch = grade_get_setting($this->courseid, 'aggregationposition', $CFG->grade_aggregationposition);
133 // Grab the grade_tree for this course
134 $this->gtree = new grade_tree($this->courseid, true, $switch, $this->collapsed, $nooutcomes);
136 $this->sortitemid = $sortitemid;
138 // base url for sorting by first/last name
140 $this->baseurl = new moodle_url('index.php', array('id' => $this->courseid));
142 $studentsperpage = $this->get_students_per_page();
143 if (!empty($this->page) && !empty($studentsperpage)) {
144 $this->baseurl->params(array('perpage' => $studentsperpage, 'page' => $this->page));
147 $this->pbarurl = new moodle_url('/grade/report/grader/index.php', array('id' => $this->courseid));
149 $this->setup_groups();
150 $this->setup_users();
151 $this->setup_sortitemid();
153 $this->overridecat = (bool)get_config('moodle', 'grade_overridecat');
157 * Processes the data sent by the form (grades and feedbacks).
158 * Caller is responsible for all access control checks
159 * @param array $data form submission (with magic quotes)
160 * @return array empty array if success, array of warnings if something fails.
162 public function process_data($data) {
166 $separategroups = false;
168 if ($this->groupmode == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $this->context)) {
169 $separategroups = true;
170 $mygroups = groups_get_user_groups($this->course->id);
171 $mygroups = $mygroups[0]; // ignore groupings
172 // reorder the groups fro better perf below
173 $current = array_search($this->currentgroup, $mygroups);
174 if ($current !== false) {
175 unset($mygroups[$current]);
176 array_unshift($mygroups, $this->currentgroup);
180 // always initialize all arrays
184 $this->load_final_grades();
186 // Were any changes made?
187 $changedgrades = false;
188 $timepageload = clean_param($data->timepageload, PARAM_INT);
190 foreach ($data as $varname => $students) {
192 $needsupdate = false;
194 // skip, not a grade nor feedback
195 if (strpos($varname, 'grade') === 0) {
197 } else if (strpos($varname, 'feedback') === 0) {
198 $datatype = 'feedback';
203 foreach ($students as $userid => $items) {
204 $userid = clean_param($userid, PARAM_INT);
205 foreach ($items as $itemid => $postedvalue) {
206 $itemid = clean_param($itemid, PARAM_INT);
208 // Was change requested?
209 $oldvalue = $this->grades[$userid][$itemid];
210 if ($datatype === 'grade') {
211 // If there was no grade and there still isn't
212 if (is_null($oldvalue->finalgrade) && $postedvalue == -1) {
217 // If the grade item uses a custom scale
218 if (!empty($oldvalue->grade_item->scaleid)) {
220 if ((int)$oldvalue->finalgrade === (int)$postedvalue) {
224 // The grade item uses a numeric scale
226 // Format the finalgrade from the DB so that it matches the grade from the client
227 if ($postedvalue === format_float($oldvalue->finalgrade, $oldvalue->grade_item->get_decimals())) {
232 $changedgrades = true;
234 } else if ($datatype === 'feedback') {
235 // If quick grading is on, feedback needs to be compared without line breaks.
236 if ($this->get_pref('quickgrading')) {
237 $oldvalue->feedback = preg_replace("/\r\n|\r|\n/", "", $oldvalue->feedback);
239 if (($oldvalue->feedback === $postedvalue) or ($oldvalue->feedback === null and empty($postedvalue))) {
244 if (!$gradeitem = grade_item::fetch(array('id'=>$itemid, 'courseid'=>$this->courseid))) {
245 print_error('invalidgradeitemid');
249 if ($datatype == 'grade') {
251 $feedbackformat = false;
252 if ($gradeitem->gradetype == GRADE_TYPE_SCALE) {
253 if ($postedvalue == -1) { // -1 means no grade
256 $finalgrade = $postedvalue;
259 $finalgrade = unformat_float($postedvalue);
265 $dategraded = $oldvalue->get_dategraded();
266 if (!empty($dategraded) && $timepageload < $dategraded) {
267 // Warn if the grade was updated while we were editing this form.
268 $errorstr = 'gradewasmodifiedduringediting';
270 } else if (!is_null($finalgrade)) {
271 // Warn if the grade is out of bounds.
272 $bounded = $gradeitem->bounded_grade($finalgrade);
273 if ($bounded > $finalgrade) {
274 $errorstr = 'lessthanmin';
275 } else if ($bounded < $finalgrade) {
276 $errorstr = 'morethanmax';
281 $userfields = 'id, ' . get_all_user_name_fields(true);
282 $user = $DB->get_record('user', array('id' => $userid), $userfields);
283 $gradestr = new stdClass();
284 $gradestr->username = fullname($user);
285 $gradestr->itemname = $gradeitem->get_name();
286 $warnings[] = get_string($errorstr, 'grades', $gradestr);
288 // Skipping the update of this grade it failed the tests above.
293 } else if ($datatype == 'feedback') {
295 $trimmed = trim($postedvalue);
296 if (empty($trimmed)) {
299 $feedback = $postedvalue;
303 // group access control
304 if ($separategroups) {
305 // note: we can not use $this->currentgroup because it would fail badly
306 // when having two browser windows each with different group
307 $sharinggroup = false;
308 foreach ($mygroups as $groupid) {
309 if (groups_is_member($groupid, $userid)) {
310 $sharinggroup = true;
314 if (!$sharinggroup) {
315 // either group membership changed or somebody is hacking grades of other group
316 $warnings[] = get_string('errorsavegrade', 'grades');
321 $gradeitem->update_final_grade($userid, $finalgrade, 'gradebook', $feedback, FORMAT_MOODLE);
323 // We can update feedback without reloading the grade item as it doesn't affect grade calculations
324 if ($datatype === 'feedback') {
325 $this->grades[$userid][$itemid]->feedback = $feedback;
331 if ($changedgrades) {
332 // If a final grade was overriden reload grades so dependent grades like course total will be correct
333 $this->grades = null;
341 * Setting the sort order, this depends on last state
342 * all this should be in the new table class that we might need to use
343 * for displaying grades.
345 private function setup_sortitemid() {
349 if (!isset($SESSION->gradeuserreport)) {
350 $SESSION->gradeuserreport = new stdClass();
353 if ($this->sortitemid) {
354 if (!isset($SESSION->gradeuserreport->sort)) {
355 if ($this->sortitemid == 'firstname' || $this->sortitemid == 'lastname') {
356 $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC';
358 $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC';
361 // this is the first sort, i.e. by last name
362 if (!isset($SESSION->gradeuserreport->sortitemid)) {
363 if ($this->sortitemid == 'firstname' || $this->sortitemid == 'lastname') {
364 $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC';
366 $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC';
368 } else if ($SESSION->gradeuserreport->sortitemid == $this->sortitemid) {
370 if ($SESSION->gradeuserreport->sort == 'ASC') {
371 $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC';
373 $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC';
376 if ($this->sortitemid == 'firstname' || $this->sortitemid == 'lastname') {
377 $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC';
379 $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC';
383 $SESSION->gradeuserreport->sortitemid = $this->sortitemid;
385 // not requesting sort, use last setting (for paging)
387 if (isset($SESSION->gradeuserreport->sortitemid)) {
388 $this->sortitemid = $SESSION->gradeuserreport->sortitemid;
390 $this->sortitemid = 'lastname';
393 if (isset($SESSION->gradeuserreport->sort)) {
394 $this->sortorder = $SESSION->gradeuserreport->sort;
396 $this->sortorder = 'ASC';
402 * pulls out the userids of the users to be display, and sorts them
404 public function load_users() {
407 if (!empty($this->users)) {
410 $this->setup_users();
412 // Limit to users with a gradeable role.
413 list($gradebookrolessql, $gradebookrolesparams) = $DB->get_in_or_equal(explode(',', $this->gradebookroles), SQL_PARAMS_NAMED, 'grbr0');
415 // Check the status of showing only active enrolments.
416 $coursecontext = $this->context->get_course_context(true);
417 $defaultgradeshowactiveenrol = !empty($CFG->grade_report_showonlyactiveenrol);
418 $showonlyactiveenrol = get_user_preferences('grade_report_showonlyactiveenrol', $defaultgradeshowactiveenrol);
419 $showonlyactiveenrol = $showonlyactiveenrol || !has_capability('moodle/course:viewsuspendedusers', $coursecontext);
421 // Limit to users with an active enrollment.
422 list($enrolledsql, $enrolledparams) = get_enrolled_sql($this->context, '', 0, $showonlyactiveenrol);
424 // Fields we need from the user table.
425 $userfields = user_picture::fields('u', get_extra_user_fields($this->context));
427 // We want to query both the current context and parent contexts.
428 list($relatedctxsql, $relatedctxparams) = $DB->get_in_or_equal($this->context->get_parent_context_ids(true), SQL_PARAMS_NAMED, 'relatedctx');
430 // If the user has clicked one of the sort asc/desc arrows.
431 if (is_numeric($this->sortitemid)) {
432 $params = array_merge(array('gitemid' => $this->sortitemid), $gradebookrolesparams, $this->userwheresql_params,
433 $this->groupwheresql_params, $enrolledparams, $relatedctxparams);
435 $sortjoin = "LEFT JOIN {grade_grades} g ON g.userid = u.id AND g.itemid = $this->sortitemid";
436 $sort = "g.finalgrade $this->sortorder";
439 switch($this->sortitemid) {
441 $sort = "u.lastname $this->sortorder, u.firstname $this->sortorder";
444 $sort = "u.firstname $this->sortorder, u.lastname $this->sortorder";
447 $sort = "u.email $this->sortorder";
451 $sort = "u.idnumber $this->sortorder";
455 $params = array_merge($gradebookrolesparams, $this->userwheresql_params, $this->groupwheresql_params, $enrolledparams, $relatedctxparams);
458 $sql = "SELECT $userfields
460 JOIN ($enrolledsql) je ON je.id = u.id
464 SELECT DISTINCT ra.userid
465 FROM {role_assignments} ra
466 WHERE ra.roleid IN ($this->gradebookroles)
467 AND ra.contextid $relatedctxsql
468 ) rainner ON rainner.userid = u.id
473 $studentsperpage = $this->get_students_per_page();
474 $this->users = $DB->get_records_sql($sql, $params, $studentsperpage * $this->page, $studentsperpage);
476 if (empty($this->users)) {
477 $this->userselect = '';
478 $this->users = array();
479 $this->userselect_params = array();
481 list($usql, $uparams) = $DB->get_in_or_equal(array_keys($this->users), SQL_PARAMS_NAMED, 'usid0');
482 $this->userselect = "AND g.userid $usql";
483 $this->userselect_params = $uparams;
485 // First flag everyone as not suspended.
486 foreach ($this->users as $user) {
487 $this->users[$user->id]->suspendedenrolment = false;
490 // If we want to mix both suspended and not suspended users, let's find out who is suspended.
491 if (!$showonlyactiveenrol) {
492 $sql = "SELECT ue.userid
493 FROM {user_enrolments} ue
494 JOIN {enrol} e ON e.id = ue.enrolid
495 WHERE ue.userid $usql
496 AND ue.status = :uestatus
497 AND e.status = :estatus
498 AND e.courseid = :courseid
499 AND ue.timestart < :now1 AND (ue.timeend = 0 OR ue.timeend > :now2)
503 $params = array_merge($uparams, array('estatus' => ENROL_INSTANCE_ENABLED, 'uestatus' => ENROL_USER_ACTIVE,
504 'courseid' => $coursecontext->instanceid, 'now1' => $time, 'now2' => $time));
505 $useractiveenrolments = $DB->get_records_sql($sql, $params);
507 foreach ($this->users as $user) {
508 $this->users[$user->id]->suspendedenrolment = !array_key_exists($user->id, $useractiveenrolments);
516 * we supply the userids in this query, and get all the grades
517 * pulls out all the grades, this does not need to worry about paging
519 public function load_final_grades() {
522 if (!empty($this->grades)) {
526 if (empty($this->users)) {
530 // please note that we must fetch all grade_grades fields if we want to construct grade_grade object from it!
531 $params = array_merge(array('courseid'=>$this->courseid), $this->userselect_params);
533 FROM {grade_items} gi,
535 WHERE g.itemid = gi.id AND gi.courseid = :courseid {$this->userselect}";
537 $userids = array_keys($this->users);
539 if ($grades = $DB->get_records_sql($sql, $params)) {
540 foreach ($grades as $graderec) {
541 if (in_array($graderec->userid, $userids) and array_key_exists($graderec->itemid, $this->gtree->get_items())) { // some items may not be present!!
542 $this->grades[$graderec->userid][$graderec->itemid] = new grade_grade($graderec, false);
543 $this->grades[$graderec->userid][$graderec->itemid]->grade_item = $this->gtree->get_item($graderec->itemid); // db caching
548 // prefil grades that do not exist yet
549 foreach ($userids as $userid) {
550 foreach ($this->gtree->get_items() as $itemid => $unused) {
551 if (!isset($this->grades[$userid][$itemid])) {
552 $this->grades[$userid][$itemid] = new grade_grade();
553 $this->grades[$userid][$itemid]->itemid = $itemid;
554 $this->grades[$userid][$itemid]->userid = $userid;
555 $this->grades[$userid][$itemid]->grade_item = $this->gtree->get_item($itemid); // db caching
563 * @deprecated since Moodle 2.4 as it appears not to be used any more.
565 public function get_toggles_html() {
566 throw new coding_exception('get_toggles_html() can not be used any more');
571 * @deprecated since 2.4 as it appears not to be used any more.
572 * @param unknown $type
574 public function print_toggle($type) {
575 throw new coding_exception('print_toggle() can not be used any more');
579 * Builds and returns the rows that will make up the left part of the grader report
580 * This consists of student names and icons, links to user reports and id numbers, as well
581 * as header cells for these columns. It also includes the fillers required for the
582 * categories displayed on the right side of the report.
583 * @param boolean $displayaverages whether to display average rows in the table
584 * @return array Array of html_table_row objects
586 public function get_left_rows($displayaverages) {
587 global $CFG, $USER, $OUTPUT;
591 $showuserimage = $this->get_pref('showuserimage');
592 // FIXME: MDL-52678 This get_capability_info is hacky and we should have an API for inserting grade row links instead.
593 $canseeuserreport = false;
594 $canseesingleview = false;
595 if (get_capability_info('gradereport/'.$CFG->grade_profilereport.':view')) {
596 $canseeuserreport = has_capability('gradereport/'.$CFG->grade_profilereport.':view', $this->context);
598 if (get_capability_info('gradereport/singleview:view')) {
599 $canseesingleview = has_all_capabilities(array('gradereport/singleview:view', 'moodle/grade:viewall',
600 'moodle/grade:edit'), $this->context);
602 $hasuserreportcell = $canseeuserreport || $canseesingleview;
604 $strfeedback = $this->get_lang_string("feedback");
605 $strgrade = $this->get_lang_string('grade');
607 $extrafields = get_extra_user_fields($this->context);
609 $arrows = $this->get_sort_arrows($extrafields);
611 $colspan = 1 + $hasuserreportcell + count($extrafields);
613 $levels = count($this->gtree->levels) - 1;
615 $fillercell = new html_table_cell();
616 $fillercell->header = true;
617 $fillercell->attributes['scope'] = 'col';
618 $fillercell->attributes['class'] = 'cell topleft';
619 $fillercell->text = html_writer::span(get_string('participants'), 'accesshide');
620 $fillercell->colspan = $colspan;
621 $fillercell->rowspan = $levels;
622 $row = new html_table_row(array($fillercell));
625 for ($i = 1; $i < $levels; $i++) {
626 $row = new html_table_row();
630 $headerrow = new html_table_row();
631 $headerrow->attributes['class'] = 'heading';
633 $studentheader = new html_table_cell();
634 $studentheader->attributes['class'] = 'header';
635 $studentheader->scope = 'col';
636 $studentheader->header = true;
637 $studentheader->id = 'studentheader';
638 if ($hasuserreportcell) {
639 $studentheader->colspan = 2;
641 $studentheader->text = $arrows['studentname'];
643 $headerrow->cells[] = $studentheader;
645 foreach ($extrafields as $field) {
646 $fieldheader = new html_table_cell();
647 $fieldheader->attributes['class'] = 'header userfield user' . $field;
648 $fieldheader->scope = 'col';
649 $fieldheader->header = true;
650 $fieldheader->text = $arrows[$field];
652 $headerrow->cells[] = $fieldheader;
655 $rows[] = $headerrow;
657 $rows = $this->get_left_icons_row($rows, $colspan);
659 $suspendedstring = null;
660 foreach ($this->users as $userid => $user) {
661 $userrow = new html_table_row();
662 $userrow->id = 'fixed_user_'.$userid;
664 $usercell = new html_table_cell();
665 $usercell->attributes['class'] = 'header user';
667 $usercell->header = true;
668 $usercell->scope = 'row';
670 if ($showuserimage) {
671 $usercell->text = $OUTPUT->user_picture($user, array('visibletoscreenreaders' => false));
674 $fullname = fullname($user);
675 $usercell->text .= html_writer::link(new moodle_url('/user/view.php', array('id' => $user->id, 'course' => $this->course->id)), $fullname, array(
676 'class' => 'username',
679 if (!empty($user->suspendedenrolment)) {
680 $usercell->attributes['class'] .= ' usersuspended';
682 //may be lots of suspended users so only get the string once
683 if (empty($suspendedstring)) {
684 $suspendedstring = get_string('userenrolmentsuspended', 'grades');
686 $usercell->text .= html_writer::empty_tag('img', array('src'=>$OUTPUT->pix_url('i/enrolmentsuspended'), 'title'=>$suspendedstring,
687 'alt'=>$suspendedstring, 'class'=>'usersuspendedicon'));
690 $userrow->cells[] = $usercell;
692 $userreportcell = new html_table_cell();
693 $userreportcell->attributes['class'] = 'userreport';
694 $userreportcell->header = false;
695 if ($canseeuserreport) {
697 $a->user = $fullname;
698 $strgradesforuser = get_string('gradesforuser', 'grades', $a);
699 $url = new moodle_url('/grade/report/'.$CFG->grade_profilereport.'/index.php', array('userid' => $user->id, 'id' => $this->course->id));
700 $userreportcell->text .= $OUTPUT->action_icon($url, new pix_icon('t/grades', $strgradesforuser));
703 if ($canseesingleview) {
704 $url = new moodle_url('/grade/report/singleview/index.php', array('id' => $this->course->id, 'itemid' => $user->id, 'item' => 'user'));
705 $singleview = $OUTPUT->action_icon($url, new pix_icon('t/editstring', get_string('singleview', 'grades', $fullname)));
706 $userreportcell->text .= $singleview;
709 if ($userreportcell->text) {
710 $userrow->cells[] = $userreportcell;
713 foreach ($extrafields as $field) {
714 $fieldcell = new html_table_cell();
715 $fieldcell->attributes['class'] = 'userfield user' . $field;
716 $fieldcell->header = false;
717 $fieldcell->text = $user->{$field};
718 $userrow->cells[] = $fieldcell;
721 $userrow->attributes['data-uid'] = $userid;
725 $rows = $this->get_left_range_row($rows, $colspan);
726 if ($displayaverages) {
727 $rows = $this->get_left_avg_row($rows, $colspan, true);
728 $rows = $this->get_left_avg_row($rows, $colspan);
735 * Builds and returns the rows that will make up the right part of the grader report
736 * @param boolean $displayaverages whether to display average rows in the table
737 * @return array Array of html_table_row objects
739 public function get_right_rows($displayaverages) {
740 global $CFG, $USER, $OUTPUT, $DB, $PAGE;
744 $numrows = count($this->gtree->get_levels());
745 $numusers = count($this->users);
747 $columnstounset = array();
748 $strgrade = $this->get_lang_string('grade');
749 $strfeedback = $this->get_lang_string("feedback");
750 $arrows = $this->get_sort_arrows();
752 $jsarguments = array(
753 'cfg' => array('ajaxenabled'=>false),
756 'feedback' => array(),
761 // Get preferences once.
762 $showactivityicons = $this->get_pref('showactivityicons');
763 $quickgrading = $this->get_pref('quickgrading');
764 $showquickfeedback = $this->get_pref('showquickfeedback');
765 $enableajax = $this->get_pref('enableajax');
766 $showanalysisicon = $this->get_pref('showanalysisicon');
768 // Get strings which are re-used inside the loop.
769 $strftimedatetimeshort = get_string('strftimedatetimeshort');
770 $strexcludedgrades = get_string('excluded', 'grades');
771 $strerror = get_string('error');
773 foreach ($this->gtree->get_levels() as $key => $row) {
774 $headingrow = new html_table_row();
775 $headingrow->attributes['class'] = 'heading_name_row';
777 foreach ($row as $columnkey => $element) {
778 $sortlink = clone($this->baseurl);
779 if (isset($element['object']->id)) {
780 $sortlink->param('sortitemid', $element['object']->id);
783 $eid = $element['eid'];
784 $object = $element['object'];
785 $type = $element['type'];
786 $categorystate = @$element['categorystate'];
788 if (!empty($element['colspan'])) {
789 $colspan = $element['colspan'];
794 if (!empty($element['depth'])) {
795 $catlevel = 'catlevel'.$element['depth'];
800 // Element is a filler
801 if ($type == 'filler' or $type == 'fillerfirst' or $type == 'fillerlast') {
802 $fillercell = new html_table_cell();
803 $fillercell->attributes['class'] = $type . ' ' . $catlevel;
804 $fillercell->colspan = $colspan;
805 $fillercell->text = ' ';
807 // This is a filler cell; don't use a <th>, it'll confuse screen readers.
808 $fillercell->header = false;
809 $headingrow->cells[] = $fillercell;
810 } else if ($type == 'category') {
811 // Element is a category
812 $categorycell = new html_table_cell();
813 $categorycell->attributes['class'] = 'category ' . $catlevel;
814 $categorycell->colspan = $colspan;
815 $categorycell->text = $this->get_course_header($element);
816 $categorycell->header = true;
817 $categorycell->scope = 'col';
820 if ($USER->gradeediting[$this->courseid]) {
821 $categorycell->text .= $this->get_icons($element);
824 $headingrow->cells[] = $categorycell;
826 // Element is a grade_item
827 if ($element['object']->id == $this->sortitemid) {
828 if ($this->sortorder == 'ASC') {
829 $arrow = $this->get_sort_arrow('up', $sortlink);
831 $arrow = $this->get_sort_arrow('down', $sortlink);
834 $arrow = $this->get_sort_arrow('move', $sortlink);
837 $headerlink = $this->gtree->get_element_header($element, true, $showactivityicons, false, false, true);
839 $itemcell = new html_table_cell();
840 $itemcell->attributes['class'] = $type . ' ' . $catlevel . ' highlightable'. ' i'. $element['object']->id;
841 $itemcell->attributes['data-itemid'] = $element['object']->id;
843 if ($element['object']->is_hidden()) {
844 $itemcell->attributes['class'] .= ' dimmed_text';
849 // FIXME: MDL-52678 This is extremely hacky we should have an API for inserting grade column links.
850 if (get_capability_info('gradereport/singleview:view')) {
851 if (has_all_capabilities(array('gradereport/singleview:view', 'moodle/grade:viewall',
852 'moodle/grade:edit'), $this->context)) {
854 $url = new moodle_url('/grade/report/singleview/index.php', array(
855 'id' => $this->course->id,
857 'itemid' => $element['object']->id));
858 $singleview = $OUTPUT->action_icon(
860 new pix_icon('t/editstring', get_string('singleview', 'grades', $element['object']->get_name()))
865 $itemcell->colspan = $colspan;
866 $itemcell->text = shorten_text($headerlink) . $arrow . $singleview;
867 $itemcell->header = true;
868 $itemcell->scope = 'col';
870 $headingrow->cells[] = $itemcell;
873 $rows[] = $headingrow;
876 $rows = $this->get_right_icons_row($rows);
878 // Preload scale objects for items with a scaleid and initialize tab indices
879 $scaleslist = array();
880 $tabindices = array();
882 foreach ($this->gtree->get_items() as $itemid => $item) {
884 if (!empty($item->scaleid)) {
885 $scaleslist[] = $item->scaleid;
886 $jsarguments['items'][$itemid] = array('id'=>$itemid, 'name'=>$item->get_name(true), 'type'=>'scale', 'scale'=>$item->scaleid, 'decimals'=>$item->get_decimals());
888 $jsarguments['items'][$itemid] = array('id'=>$itemid, 'name'=>$item->get_name(true), 'type'=>'value', 'scale'=>false, 'decimals'=>$item->get_decimals());
890 $tabindices[$item->id]['grade'] = $gradetabindex;
891 $tabindices[$item->id]['feedback'] = $gradetabindex + $numusers;
892 $gradetabindex += $numusers * 2;
894 $scalesarray = array();
896 if (!empty($scaleslist)) {
897 $scalesarray = $DB->get_records_list('scale', 'id', $scaleslist);
899 $jsscales = $scalesarray;
901 foreach ($this->users as $userid => $user) {
903 if ($this->canviewhidden) {
907 $hidingaffected = grade_grade::get_hiding_affected($this->grades[$userid], $this->gtree->get_items());
908 $altered = $hidingaffected['altered'];
909 $unknown = $hidingaffected['unknown'];
910 unset($hidingaffected);
913 $itemrow = new html_table_row();
914 $itemrow->id = 'user_'.$userid;
916 $fullname = fullname($user);
917 $jsarguments['users'][$userid] = $fullname;
919 foreach ($this->gtree->items as $itemid => $unused) {
920 $item =& $this->gtree->items[$itemid];
921 $grade = $this->grades[$userid][$item->id];
923 $itemcell = new html_table_cell();
925 $itemcell->id = 'u'.$userid.'i'.$itemid;
926 $itemcell->attributes['data-itemid'] = $itemid;
928 // Get the decimal points preference for this item
929 $decimalpoints = $item->get_decimals();
931 if (in_array($itemid, $unknown)) {
933 } else if (array_key_exists($itemid, $altered)) {
934 $gradeval = $altered[$itemid];
936 $gradeval = $grade->finalgrade;
938 if (!empty($grade->finalgrade)) {
939 $gradevalforjs = null;
940 if ($item->scaleid && !empty($scalesarray[$item->scaleid])) {
941 $gradevalforjs = (int)$gradeval;
943 $gradevalforjs = format_float($gradeval, $decimalpoints);
945 $jsarguments['grades'][] = array('user'=>$userid, 'item'=>$itemid, 'grade'=>$gradevalforjs);
949 // Hide grades in the grader report if the current grader doesn't have 'moodle/grade:viewhidden'
950 if (!$this->canviewhidden and $grade->is_hidden()) {
951 if (!empty($CFG->grade_hiddenasdate) and $grade->get_datesubmitted() and !$item->is_category_item() and !$item->is_course_item()) {
952 // the problem here is that we do not have the time when grade value was modified, 'timemodified' is general modification date for grade_grades records
953 $itemcell->text = "<span class='datesubmitted'>" .
954 userdate($grade->get_datesubmitted(), $strftimedatetimeshort) . "</span>";
956 $itemcell->text = '-';
958 $itemrow->cells[] = $itemcell;
962 // emulate grade element
963 $eid = $this->gtree->get_grade_eid($grade);
964 $element = array('eid'=>$eid, 'object'=>$grade, 'type'=>'grade');
966 $itemcell->attributes['class'] .= ' grade i'.$itemid;
967 if ($item->is_category_item()) {
968 $itemcell->attributes['class'] .= ' cat';
970 if ($item->is_course_item()) {
971 $itemcell->attributes['class'] .= ' course';
973 if ($grade->is_overridden()) {
974 $itemcell->attributes['class'] .= ' overridden';
975 $itemcell->attributes['aria-label'] = get_string('overriddengrade', 'gradereport_grader');
978 if (!empty($grade->feedback)) {
979 $feedback = wordwrap(trim(format_string($grade->feedback, $grade->feedbackformat)), 34, '<br>');
980 $itemcell->attributes['data-feedback'] = $feedback;
981 $jsarguments['feedback'][] = array('user'=>$userid, 'item'=>$itemid, 'content' => $feedback);
984 if ($grade->is_excluded()) {
985 // Adding white spaces before and after to prevent a screenreader from
986 // thinking that the words are attached to the next/previous <span> or text.
987 $itemcell->text .= " <span class='excludedfloater'>" . $strexcludedgrades . "</span> ";
990 // Do not show any icons if no grade (no record in DB to match)
991 if (!$item->needsupdate and $USER->gradeediting[$this->courseid]) {
992 $itemcell->text .= $this->get_icons($element);
996 if ($grade->is_hidden()) {
997 $hidden = ' dimmed_text ';
1000 $gradepass = ' gradefail ';
1001 if ($grade->is_passed($item)) {
1002 $gradepass = ' gradepass ';
1003 } else if (is_null($grade->is_passed($item))) {
1007 // if in editing mode, we need to print either a text box
1008 // or a drop down (for scales)
1009 // grades in item of type grade category or course are not directly editable
1010 if ($item->needsupdate) {
1011 $itemcell->text .= "<span class='gradingerror{$hidden}'>" . $strerror . "</span>";
1013 } else if ($USER->gradeediting[$this->courseid]) {
1015 if ($item->scaleid && !empty($scalesarray[$item->scaleid])) {
1016 $itemcell->attributes['class'] .= ' grade_type_scale';
1017 } else if ($item->gradetype == GRADE_TYPE_VALUE) {
1018 $itemcell->attributes['class'] .= ' grade_type_value';
1019 } else if ($item->gradetype == GRADE_TYPE_TEXT) {
1020 $itemcell->attributes['class'] .= ' grade_type_text';
1023 if ($item->scaleid && !empty($scalesarray[$item->scaleid])) {
1024 $scale = $scalesarray[$item->scaleid];
1025 $gradeval = (int)$gradeval; // scales use only integers
1026 $scales = explode(",", $scale->scale);
1027 // reindex because scale is off 1
1029 // MDL-12104 some previous scales might have taken up part of the array
1030 // so this needs to be reset
1031 $scaleopt = array();
1033 foreach ($scales as $scaleoption) {
1035 $scaleopt[$i] = $scaleoption;
1038 if ($quickgrading and $grade->is_editable()) {
1039 $oldval = empty($gradeval) ? -1 : $gradeval;
1040 if (empty($item->outcomeid)) {
1041 $nogradestr = $this->get_lang_string('nograde');
1043 $nogradestr = $this->get_lang_string('nooutcome', 'grades');
1045 $attributes = array('tabindex' => $tabindices[$item->id]['grade'], 'id'=>'grade_'.$userid.'_'.$item->id);
1046 $gradelabel = $fullname . ' ' . $item->itemname;
1047 $itemcell->text .= html_writer::label(
1048 get_string('useractivitygrade', 'gradereport_grader', $gradelabel), $attributes['id'], false,
1049 array('class' => 'accesshide'));
1050 $itemcell->text .= html_writer::select($scaleopt, 'grade['.$userid.']['.$item->id.']', $gradeval, array(-1=>$nogradestr), $attributes);
1051 } else if (!empty($scale)) {
1052 $scales = explode(",", $scale->scale);
1054 // invalid grade if gradeval < 1
1055 if ($gradeval < 1) {
1056 $itemcell->text .= "<span class='gradevalue{$hidden}{$gradepass}'>-</span>";
1058 $gradeval = $grade->grade_item->bounded_grade($gradeval); //just in case somebody changes scale
1059 $itemcell->text .= "<span class='gradevalue{$hidden}{$gradepass}'>{$scales[$gradeval - 1]}</span>";
1063 } else if ($item->gradetype != GRADE_TYPE_TEXT) { // Value type
1064 if ($quickgrading and $grade->is_editable()) {
1065 $value = format_float($gradeval, $decimalpoints);
1066 $gradelabel = $fullname . ' ' . $item->itemname;
1067 $itemcell->text .= '<label class="accesshide" for="grade_'.$userid.'_'.$item->id.'">'
1068 .get_string('useractivitygrade', 'gradereport_grader', $gradelabel).'</label>';
1069 $itemcell->text .= '<input size="6" tabindex="' . $tabindices[$item->id]['grade']
1070 . '" type="text" class="text" title="'. $strgrade .'" name="grade['
1071 .$userid.'][' .$item->id.']" id="grade_'.$userid.'_'.$item->id.'" value="'.$value.'" />';
1073 $itemcell->text .= "<span class='gradevalue{$hidden}{$gradepass}'>" .
1074 format_float($gradeval, $decimalpoints) . "</span>";
1078 // If quickfeedback is on, print an input element
1079 if ($showquickfeedback and $grade->is_editable()) {
1080 $feedbacklabel = $fullname . ' ' . $item->itemname;
1081 $itemcell->text .= '<label class="accesshide" for="feedback_'.$userid.'_'.$item->id.'">'
1082 .get_string('useractivityfeedback', 'gradereport_grader', $feedbacklabel).'</label>';
1083 $itemcell->text .= '<input class="quickfeedback" tabindex="' . $tabindices[$item->id]['feedback'].'" id="feedback_'.$userid.'_'.$item->id
1084 . '" size="6" title="' . $strfeedback . '" type="text" name="feedback['.$userid.']['.$item->id.']" value="' . s($grade->feedback) . '" />';
1087 } else { // Not editing
1088 $gradedisplaytype = $item->get_displaytype();
1090 if ($item->scaleid && !empty($scalesarray[$item->scaleid])) {
1091 $itemcell->attributes['class'] .= ' grade_type_scale';
1092 } else if ($item->gradetype == GRADE_TYPE_VALUE) {
1093 $itemcell->attributes['class'] .= ' grade_type_value';
1094 } else if ($item->gradetype == GRADE_TYPE_TEXT) {
1095 $itemcell->attributes['class'] .= ' grade_type_text';
1098 // Only allow edting if the grade is editable (not locked, not in a unoverridable category, etc).
1099 if ($enableajax && $grade->is_editable()) {
1100 // If a grade item is type text, and we don't have show quick feedback on, it can't be edited.
1101 if ($item->gradetype != GRADE_TYPE_TEXT || $showquickfeedback) {
1102 $itemcell->attributes['class'] .= ' clickable';
1106 if ($item->needsupdate) {
1107 $itemcell->text .= "<span class='gradingerror{$hidden}{$gradepass}'>" . $error . "</span>";
1109 // The max and min for an aggregation may be different to the grade_item.
1110 if (!is_null($gradeval)) {
1111 $item->grademax = $grade->get_grade_max();
1112 $item->grademin = $grade->get_grade_min();
1115 $itemcell->text .= "<span class='gradevalue{$hidden}{$gradepass}'>" .
1116 grade_format_gradevalue($gradeval, $item, true, $gradedisplaytype, null) . "</span>";
1117 if ($showanalysisicon) {
1118 $itemcell->text .= $this->gtree->get_grade_analysis_icon($grade);
1123 // Enable keyboard navigation if the grade is editable (not locked, not in a unoverridable category, etc).
1124 if ($enableajax && $grade->is_editable()) {
1125 // If a grade item is type text, and we don't have show quick feedback on, it can't be edited.
1126 if ($item->gradetype != GRADE_TYPE_TEXT || $showquickfeedback) {
1127 $itemcell->attributes['class'] .= ' gbnavigable';
1131 if (!empty($this->gradeserror[$item->id][$userid])) {
1132 $itemcell->text .= $this->gradeserror[$item->id][$userid];
1135 $itemrow->cells[] = $itemcell;
1141 $jsarguments['cfg']['ajaxenabled'] = true;
1142 $jsarguments['cfg']['scales'] = array();
1143 foreach ($jsscales as $scale) {
1144 // Trim the scale values, as they may have a space that is ommitted from values later.
1145 $jsarguments['cfg']['scales'][$scale->id] = array_map('trim', explode(',', $scale->scale));
1147 $jsarguments['cfg']['feedbacktrunclength'] = $this->feedback_trunc_length;
1149 // Student grades and feedback are already at $jsarguments['feedback'] and $jsarguments['grades']
1151 $jsarguments['cfg']['isediting'] = (bool)$USER->gradeediting[$this->courseid];
1152 $jsarguments['cfg']['courseid'] = $this->courseid;
1153 $jsarguments['cfg']['studentsperpage'] = $this->get_students_per_page();
1154 $jsarguments['cfg']['showquickfeedback'] = (bool) $showquickfeedback;
1157 'name' => 'gradereport_grader',
1158 'fullpath' => '/grade/report/grader/module.js',
1159 'requires' => array('base', 'dom', 'event', 'event-mouseenter', 'event-key', 'io-queue', 'json-parse', 'overlay')
1161 $PAGE->requires->js_init_call('M.gradereport_grader.init_report', $jsarguments, false, $module);
1162 $PAGE->requires->strings_for_js(array('addfeedback', 'feedback', 'grade'), 'grades');
1163 $PAGE->requires->strings_for_js(array('ajaxchoosescale', 'ajaxclicktoclose', 'ajaxerror', 'ajaxfailedupdate', 'ajaxfieldchanged'), 'gradereport_grader');
1164 if (!$enableajax && $USER->gradeediting[$this->courseid]) {
1165 $PAGE->requires->yui_module('moodle-core-formchangechecker',
1166 'M.core_formchangechecker.init',
1168 'formid' => 'gradereport_grader'
1171 $PAGE->requires->string_for_js('changesmadereallygoaway', 'moodle');
1174 $rows = $this->get_right_range_row($rows);
1175 if ($displayaverages) {
1176 $rows = $this->get_right_avg_row($rows, true);
1177 $rows = $this->get_right_avg_row($rows);
1184 * Depending on the style of report (fixedstudents vs traditional one-table),
1185 * arranges the rows of data in one or two tables, and returns the output of
1186 * these tables in HTML
1187 * @param boolean $displayaverages whether to display average rows in the table
1188 * @return string HTML
1190 public function get_grade_table($displayaverages = false) {
1192 $leftrows = $this->get_left_rows($displayaverages);
1193 $rightrows = $this->get_right_rows($displayaverages);
1197 $fulltable = new html_table();
1198 $fulltable->attributes['class'] = 'gradereport-grader-table';
1199 $fulltable->id = 'user-grades';
1200 $fulltable->summary = get_string('summarygrader', 'gradereport_grader');
1202 // Extract rows from each side (left and right) and collate them into one row each
1203 foreach ($leftrows as $key => $row) {
1204 $row->cells = array_merge($row->cells, $rightrows[$key]->cells);
1205 $fulltable->data[] = $row;
1207 $html .= html_writer::table($fulltable);
1208 return $OUTPUT->container($html, 'gradeparent');
1212 * Builds and return the row of icons for the left side of the report.
1213 * It only has one cell that says "Controls"
1214 * @param array $rows The Array of rows for the left part of the report
1215 * @param int $colspan The number of columns this cell has to span
1216 * @return array Array of rows for the left part of the report
1218 public function get_left_icons_row($rows=array(), $colspan=1) {
1221 if ($USER->gradeediting[$this->courseid]) {
1222 $controlsrow = new html_table_row();
1223 $controlsrow->attributes['class'] = 'controls';
1224 $controlscell = new html_table_cell();
1225 $controlscell->attributes['class'] = 'header controls';
1226 $controlscell->colspan = $colspan;
1227 $controlscell->text = $this->get_lang_string('controls', 'grades');
1229 $controlsrow->cells[] = $controlscell;
1230 $rows[] = $controlsrow;
1236 * Builds and return the header for the row of ranges, for the left part of the grader report.
1237 * @param array $rows The Array of rows for the left part of the report
1238 * @param int $colspan The number of columns this cell has to span
1239 * @return array Array of rows for the left part of the report
1241 public function get_left_range_row($rows=array(), $colspan=1) {
1244 if ($this->get_pref('showranges')) {
1245 $rangerow = new html_table_row();
1246 $rangerow->attributes['class'] = 'range r'.$this->rowcount++;
1247 $rangecell = new html_table_cell();
1248 $rangecell->attributes['class'] = 'header range';
1249 $rangecell->colspan = $colspan;
1250 $rangecell->header = true;
1251 $rangecell->scope = 'row';
1252 $rangecell->text = $this->get_lang_string('range', 'grades');
1253 $rangerow->cells[] = $rangecell;
1254 $rows[] = $rangerow;
1261 * Builds and return the headers for the rows of averages, for the left part of the grader report.
1262 * @param array $rows The Array of rows for the left part of the report
1263 * @param int $colspan The number of columns this cell has to span
1264 * @param bool $groupavg If true, returns the row for group averages, otherwise for overall averages
1265 * @return array Array of rows for the left part of the report
1267 public function get_left_avg_row($rows=array(), $colspan=1, $groupavg=false) {
1268 if (!$this->canviewhidden) {
1269 // totals might be affected by hiding, if user can not see hidden grades the aggregations might be altered
1270 // better not show them at all if user can not see all hideen grades
1274 $showaverages = $this->get_pref('showaverages');
1275 $showaveragesgroup = $this->currentgroup && $showaverages;
1276 $straveragegroup = get_string('groupavg', 'grades');
1279 if ($showaveragesgroup) {
1280 $groupavgrow = new html_table_row();
1281 $groupavgrow->attributes['class'] = 'groupavg r'.$this->rowcount++;
1282 $groupavgcell = new html_table_cell();
1283 $groupavgcell->attributes['class'] = 'header range';
1284 $groupavgcell->colspan = $colspan;
1285 $groupavgcell->header = true;
1286 $groupavgcell->scope = 'row';
1287 $groupavgcell->text = $straveragegroup;
1288 $groupavgrow->cells[] = $groupavgcell;
1289 $rows[] = $groupavgrow;
1292 $straverage = get_string('overallaverage', 'grades');
1294 if ($showaverages) {
1295 $avgrow = new html_table_row();
1296 $avgrow->attributes['class'] = 'avg r'.$this->rowcount++;
1297 $avgcell = new html_table_cell();
1298 $avgcell->attributes['class'] = 'header range';
1299 $avgcell->colspan = $colspan;
1300 $avgcell->header = true;
1301 $avgcell->scope = 'row';
1302 $avgcell->text = $straverage;
1303 $avgrow->cells[] = $avgcell;
1312 * Builds and return the row of icons when editing is on, for the right part of the grader report.
1313 * @param array $rows The Array of rows for the right part of the report
1314 * @return array Array of rows for the right part of the report
1316 public function get_right_icons_row($rows=array()) {
1318 if ($USER->gradeediting[$this->courseid]) {
1319 $iconsrow = new html_table_row();
1320 $iconsrow->attributes['class'] = 'controls';
1322 foreach ($this->gtree->items as $itemid => $unused) {
1323 // emulate grade element
1324 $item = $this->gtree->get_item($itemid);
1326 $eid = $this->gtree->get_item_eid($item);
1327 $element = $this->gtree->locate_element($eid);
1328 $itemcell = new html_table_cell();
1329 $itemcell->attributes['class'] = 'controls icons i'.$itemid;
1330 $itemcell->text = $this->get_icons($element);
1331 $iconsrow->cells[] = $itemcell;
1333 $rows[] = $iconsrow;
1339 * Builds and return the row of ranges for the right part of the grader report.
1340 * @param array $rows The Array of rows for the right part of the report
1341 * @return array Array of rows for the right part of the report
1343 public function get_right_range_row($rows=array()) {
1346 if ($this->get_pref('showranges')) {
1347 $rangesdisplaytype = $this->get_pref('rangesdisplaytype');
1348 $rangesdecimalpoints = $this->get_pref('rangesdecimalpoints');
1349 $rangerow = new html_table_row();
1350 $rangerow->attributes['class'] = 'heading range';
1352 foreach ($this->gtree->items as $itemid => $unused) {
1353 $item =& $this->gtree->items[$itemid];
1354 $itemcell = new html_table_cell();
1355 $itemcell->attributes['class'] .= ' range i'. $itemid;
1358 if ($item->is_hidden()) {
1359 $hidden = ' dimmed_text ';
1362 $formattedrange = $item->get_formatted_range($rangesdisplaytype, $rangesdecimalpoints);
1364 $itemcell->text = $OUTPUT->container($formattedrange, 'rangevalues'.$hidden);
1365 $rangerow->cells[] = $itemcell;
1367 $rows[] = $rangerow;
1373 * Builds and return the row of averages for the right part of the grader report.
1374 * @param array $rows Whether to return only group averages or all averages.
1375 * @param bool $grouponly Whether to return only group averages or all averages.
1376 * @return array Array of rows for the right part of the report
1378 public function get_right_avg_row($rows=array(), $grouponly=false) {
1379 global $USER, $DB, $OUTPUT, $CFG;
1381 if (!$this->canviewhidden) {
1382 // Totals might be affected by hiding, if user can not see hidden grades the aggregations might be altered
1383 // better not show them at all if user can not see all hidden grades.
1387 $averagesdisplaytype = $this->get_pref('averagesdisplaytype');
1388 $averagesdecimalpoints = $this->get_pref('averagesdecimalpoints');
1389 $meanselection = $this->get_pref('meanselection');
1390 $shownumberofgrades = $this->get_pref('shownumberofgrades');
1393 $showaverages = $this->currentgroup && $this->get_pref('showaverages');
1394 $groupsql = $this->groupsql;
1395 $groupwheresql = $this->groupwheresql;
1396 $groupwheresqlparams = $this->groupwheresql_params;
1398 $showaverages = $this->get_pref('showaverages');
1400 $groupwheresql = "";
1401 $groupwheresqlparams = array();
1404 if ($showaverages) {
1405 $totalcount = $this->get_numusers($grouponly);
1407 // Limit to users with a gradeable role.
1408 list($gradebookrolessql, $gradebookrolesparams) = $DB->get_in_or_equal(explode(',', $this->gradebookroles), SQL_PARAMS_NAMED, 'grbr0');
1410 // Limit to users with an active enrollment.
1411 $coursecontext = $this->context->get_course_context(true);
1412 $defaultgradeshowactiveenrol = !empty($CFG->grade_report_showonlyactiveenrol);
1413 $showonlyactiveenrol = get_user_preferences('grade_report_showonlyactiveenrol', $defaultgradeshowactiveenrol);
1414 $showonlyactiveenrol = $showonlyactiveenrol || !has_capability('moodle/course:viewsuspendedusers', $coursecontext);
1415 list($enrolledsql, $enrolledparams) = get_enrolled_sql($this->context, '', 0, $showonlyactiveenrol);
1417 // We want to query both the current context and parent contexts.
1418 list($relatedctxsql, $relatedctxparams) = $DB->get_in_or_equal($this->context->get_parent_context_ids(true), SQL_PARAMS_NAMED, 'relatedctx');
1420 $params = array_merge(array('courseid' => $this->courseid), $gradebookrolesparams, $enrolledparams, $groupwheresqlparams, $relatedctxparams);
1422 // Find sums of all grade items in course.
1423 $sql = "SELECT g.itemid, SUM(g.finalgrade) AS sum
1424 FROM {grade_items} gi
1425 JOIN {grade_grades} g ON g.itemid = gi.id
1426 JOIN {user} u ON u.id = g.userid
1427 JOIN ($enrolledsql) je ON je.id = u.id
1429 SELECT DISTINCT ra.userid
1430 FROM {role_assignments} ra
1431 WHERE ra.roleid $gradebookrolessql
1432 AND ra.contextid $relatedctxsql
1433 ) rainner ON rainner.userid = u.id
1435 WHERE gi.courseid = :courseid
1437 AND g.finalgrade IS NOT NULL
1440 $sumarray = array();
1441 if ($sums = $DB->get_records_sql($sql, $params)) {
1442 foreach ($sums as $itemid => $csum) {
1443 $sumarray[$itemid] = $csum->sum;
1447 // MDL-10875 Empty grades must be evaluated as grademin, NOT always 0
1448 // This query returns a count of ungraded grades (NULL finalgrade OR no matching record in grade_grades table)
1449 $sql = "SELECT gi.id, COUNT(DISTINCT u.id) AS count
1450 FROM {grade_items} gi
1452 JOIN ($enrolledsql) je
1454 JOIN {role_assignments} ra
1456 LEFT OUTER JOIN {grade_grades} g
1457 ON (g.itemid = gi.id AND g.userid = u.id AND g.finalgrade IS NOT NULL)
1459 WHERE gi.courseid = :courseid
1460 AND ra.roleid $gradebookrolessql
1461 AND ra.contextid $relatedctxsql
1467 $ungradedcounts = $DB->get_records_sql($sql, $params);
1469 $avgrow = new html_table_row();
1470 $avgrow->attributes['class'] = 'avg';
1472 foreach ($this->gtree->items as $itemid => $unused) {
1473 $item =& $this->gtree->items[$itemid];
1475 if ($item->needsupdate) {
1476 $avgcell = new html_table_cell();
1477 $avgcell->attributes['class'] = 'i'. $itemid;
1478 $avgcell->text = $OUTPUT->container(get_string('error'), 'gradingerror');
1479 $avgrow->cells[] = $avgcell;
1483 if (!isset($sumarray[$item->id])) {
1484 $sumarray[$item->id] = 0;
1487 if (empty($ungradedcounts[$itemid])) {
1490 $ungradedcount = $ungradedcounts[$itemid]->count;
1493 if ($meanselection == GRADE_REPORT_MEAN_GRADED) {
1494 $meancount = $totalcount - $ungradedcount;
1495 } else { // Bump up the sum by the number of ungraded items * grademin
1496 $sumarray[$item->id] += $ungradedcount * $item->grademin;
1497 $meancount = $totalcount;
1500 // Determine which display type to use for this average
1501 if ($USER->gradeediting[$this->courseid]) {
1502 $displaytype = GRADE_DISPLAY_TYPE_REAL;
1504 } else if ($averagesdisplaytype == GRADE_REPORT_PREFERENCE_INHERIT) { // no ==0 here, please resave the report and user preferences
1505 $displaytype = $item->get_displaytype();
1508 $displaytype = $averagesdisplaytype;
1511 // Override grade_item setting if a display preference (not inherit) was set for the averages
1512 if ($averagesdecimalpoints == GRADE_REPORT_PREFERENCE_INHERIT) {
1513 $decimalpoints = $item->get_decimals();
1516 $decimalpoints = $averagesdecimalpoints;
1519 if (!isset($sumarray[$item->id]) || $meancount == 0) {
1520 $avgcell = new html_table_cell();
1521 $avgcell->attributes['class'] = 'i'. $itemid;
1522 $avgcell->text = '-';
1523 $avgrow->cells[] = $avgcell;
1526 $sum = $sumarray[$item->id];
1527 $avgradeval = $sum/$meancount;
1528 $gradehtml = grade_format_gradevalue($avgradeval, $item, true, $displaytype, $decimalpoints);
1530 $numberofgrades = '';
1531 if ($shownumberofgrades) {
1532 $numberofgrades = " ($meancount)";
1535 $avgcell = new html_table_cell();
1536 $avgcell->attributes['class'] = 'i'. $itemid;
1537 $avgcell->text = $gradehtml.$numberofgrades;
1538 $avgrow->cells[] = $avgcell;
1547 * Given element category, create a collapsible icon and
1550 * @param array $element
1551 * @return string HTML
1553 protected function get_course_header($element) {
1557 // If object is a category, display expand/contract icon.
1558 if ($element['type'] == 'category') {
1559 // Load language strings.
1560 $strswitchminus = $this->get_lang_string('aggregatesonly', 'grades');
1561 $strswitchplus = $this->get_lang_string('gradesonly', 'grades');
1562 $strswitchwhole = $this->get_lang_string('fullmode', 'grades');
1564 $url = new moodle_url($this->gpr->get_return_url(null, array('target' => $element['eid'], 'sesskey' => sesskey())));
1566 if (in_array($element['object']->id, $this->collapsed['aggregatesonly'])) {
1567 $url->param('action', 'switch_plus');
1568 $icon = $OUTPUT->action_icon($url, new pix_icon('t/switch_plus', $strswitchplus), null, null);
1569 $showing = get_string('showingaggregatesonly', 'grades');
1570 } else if (in_array($element['object']->id, $this->collapsed['gradesonly'])) {
1571 $url->param('action', 'switch_whole');
1572 $icon = $OUTPUT->action_icon($url, new pix_icon('t/switch_whole', $strswitchwhole), null, null);
1573 $showing = get_string('showinggradesonly', 'grades');
1575 $url->param('action', 'switch_minus');
1576 $icon = $OUTPUT->action_icon($url, new pix_icon('t/switch_minus', $strswitchminus), null, null);
1577 $showing = get_string('showingfullmode', 'grades');
1581 $name = shorten_text($element['object']->get_name());
1582 $courseheader = html_writer::tag('span', $name, array('id' => 'courseheader'));
1583 $courseheader .= html_writer::label($showing, 'courseheader', false, array('class' => 'accesshide'));
1584 $courseheader .= $icon;
1586 return $courseheader;
1590 * Given a grade_category, grade_item or grade_grade, this function
1591 * figures out the state of the object and builds then returns a div
1592 * with the icons needed for the grader report.
1594 * @param array $element
1595 * @return string HTML
1597 protected function get_icons($element) {
1598 global $CFG, $USER, $OUTPUT;
1600 if (!$USER->gradeediting[$this->courseid]) {
1601 return '<div class="grade_icons" />';
1609 if ($element['type'] == 'grade') {
1610 $item = $element['object']->grade_item;
1611 if ($item->is_course_item() or $item->is_category_item()) {
1612 $editable = $this->overridecat;
1616 if ($element['type'] != 'categoryitem' && $element['type'] != 'courseitem' && $editable) {
1617 $editicon = $this->gtree->get_edit_icon($element, $this->gpr);
1620 $editcalculationicon = '';
1622 $lockunlockicon = '';
1624 if (has_capability('moodle/grade:manage', $this->context)) {
1625 if ($this->get_pref('showcalculations')) {
1626 $editcalculationicon = $this->gtree->get_calculation_icon($element, $this->gpr);
1629 if ($this->get_pref('showeyecons')) {
1630 $showhideicon = $this->gtree->get_hiding_icon($element, $this->gpr);
1633 if ($this->get_pref('showlocks')) {
1634 $lockunlockicon = $this->gtree->get_locking_icon($element, $this->gpr);
1639 $gradeanalysisicon = '';
1640 if ($this->get_pref('showanalysisicon') && $element['type'] == 'grade') {
1641 $gradeanalysisicon .= $this->gtree->get_grade_analysis_icon($element['object']);
1644 return $OUTPUT->container($editicon.$editcalculationicon.$showhideicon.$lockunlockicon.$gradeanalysisicon, 'grade_icons');
1648 * Given a category element returns collapsing +/- icon if available
1650 * @deprecated since Moodle 2.9 MDL-46662 - please do not use this function any more.
1652 protected function get_collapsing_icon($element) {
1653 throw new coding_exception('get_collapsing_icon() can not be used any more, please use get_course_header() instead.');
1657 * Processes a single action against a category, grade_item or grade.
1658 * @param string $target eid ({type}{id}, e.g. c4 for category4)
1659 * @param string $action Which action to take (edit, delete etc...)
1662 public function process_action($target, $action) {
1663 return self::do_process_action($target, $action, $this->course->id);
1667 * From the list of categories that this user prefers to collapse choose ones that belong to the current course.
1669 * This function serves two purposes.
1670 * Mainly it helps migrating from user preference style when all courses were stored in one preference.
1671 * Also it helps to remove the settings for categories that were removed if the array for one course grows too big.
1673 * @param int $courseid
1674 * @param array $collapsed
1677 protected static function filter_collapsed_categories($courseid, $collapsed) {
1679 if (empty($collapsed)) {
1680 $collapsed = array('aggregatesonly' => array(), 'gradesonly' => array());
1682 if (empty($collapsed['aggregatesonly']) && empty($collapsed['gradesonly'])) {
1685 $cats = $DB->get_fieldset_select('grade_categories', 'id', 'courseid = ?', array($courseid));
1686 $collapsed['aggregatesonly'] = array_values(array_intersect($collapsed['aggregatesonly'], $cats));
1687 $collapsed['gradesonly'] = array_values(array_intersect($collapsed['gradesonly'], $cats));
1692 * Returns the list of categories that this user wants to collapse or display aggregatesonly
1694 * This method also migrates on request from the old format of storing user preferences when they were stored
1695 * in one preference for all courses causing DB error when trying to insert very big value.
1697 * @param int $courseid
1700 protected static function get_collapsed_preferences($courseid) {
1701 if ($collapsed = get_user_preferences('grade_report_grader_collapsed_categories'.$courseid)) {
1702 return json_decode($collapsed, true);
1705 // Try looking for old location of user setting that used to store all courses in one serialized user preference.
1706 if (($oldcollapsedpref = get_user_preferences('grade_report_grader_collapsed_categories')) !== null) {
1707 if ($collapsedall = @unserialize($oldcollapsedpref)) {
1708 // We found the old-style preference, filter out only categories that belong to this course and update the prefs.
1709 $collapsed = static::filter_collapsed_categories($courseid, $collapsedall);
1710 if (!empty($collapsed['aggregatesonly']) || !empty($collapsed['gradesonly'])) {
1711 static::set_collapsed_preferences($courseid, $collapsed);
1712 $collapsedall['aggregatesonly'] = array_diff($collapsedall['aggregatesonly'], $collapsed['aggregatesonly']);
1713 $collapsedall['gradesonly'] = array_diff($collapsedall['gradesonly'], $collapsed['gradesonly']);
1714 if (!empty($collapsedall['aggregatesonly']) || !empty($collapsedall['gradesonly'])) {
1715 set_user_preference('grade_report_grader_collapsed_categories', serialize($collapsedall));
1717 unset_user_preference('grade_report_grader_collapsed_categories');
1721 // We found the old-style preference, but it is unreadable, discard it.
1722 unset_user_preference('grade_report_grader_collapsed_categories');
1725 $collapsed = array('aggregatesonly' => array(), 'gradesonly' => array());
1731 * Sets the list of categories that user wants to see collapsed in user preferences
1733 * This method may filter or even trim the list if it does not fit in DB field.
1735 * @param int $courseid
1736 * @param array $collapsed
1738 protected static function set_collapsed_preferences($courseid, $collapsed) {
1740 // In an unlikely case that the list of collapsed categories for one course is too big for the user preference size,
1741 // try to filter the list of categories since array may contain categories that were deleted.
1742 if (strlen(json_encode($collapsed)) >= 1333) {
1743 $collapsed = static::filter_collapsed_categories($courseid, $collapsed);
1746 // If this did not help, "forget" about some of the collapsed categories. Still better than to loose all information.
1747 while (strlen(json_encode($collapsed)) >= 1333) {
1748 if (count($collapsed['aggregatesonly'])) {
1749 array_pop($collapsed['aggregatesonly']);
1751 if (count($collapsed['gradesonly'])) {
1752 array_pop($collapsed['gradesonly']);
1756 if (!empty($collapsed['aggregatesonly']) || !empty($collapsed['gradesonly'])) {
1757 set_user_preference('grade_report_grader_collapsed_categories'.$courseid, json_encode($collapsed));
1759 unset_user_preference('grade_report_grader_collapsed_categories'.$courseid);
1764 * Processes a single action against a category, grade_item or grade.
1765 * @param string $target eid ({type}{id}, e.g. c4 for category4)
1766 * @param string $action Which action to take (edit, delete etc...)
1767 * @param int $courseid affected course.
1770 public static function do_process_action($target, $action, $courseid = null) {
1772 // TODO: this code should be in some grade_tree static method
1773 $targettype = substr($target, 0, 2);
1774 $targetid = substr($target, 2);
1777 if ($targettype !== 'cg') {
1778 // The following code only works with categories.
1783 debugging('Function grade_report_grader::do_process_action() now requires additional argument courseid',
1785 if (!$courseid = $DB->get_field('grade_categories', 'courseid', array('id' => $targetid), IGNORE_MISSING)) {
1790 $collapsed = static::get_collapsed_preferences($courseid);
1793 case 'switch_minus': // Add category to array of aggregatesonly
1794 if (!in_array($targetid, $collapsed['aggregatesonly'])) {
1795 $collapsed['aggregatesonly'][] = $targetid;
1796 static::set_collapsed_preferences($courseid, $collapsed);
1800 case 'switch_plus': // Remove category from array of aggregatesonly, and add it to array of gradesonly
1801 $key = array_search($targetid, $collapsed['aggregatesonly']);
1802 if ($key !== false) {
1803 unset($collapsed['aggregatesonly'][$key]);
1805 if (!in_array($targetid, $collapsed['gradesonly'])) {
1806 $collapsed['gradesonly'][] = $targetid;
1808 static::set_collapsed_preferences($courseid, $collapsed);
1810 case 'switch_whole': // Remove the category from the array of collapsed cats
1811 $key = array_search($targetid, $collapsed['gradesonly']);
1812 if ($key !== false) {
1813 unset($collapsed['gradesonly'][$key]);
1814 static::set_collapsed_preferences($courseid, $collapsed);
1826 * Refactored function for generating HTML of sorting links with matching arrows.
1827 * Returns an array with 'studentname' and 'idnumber' as keys, with HTML ready
1828 * to inject into a table header cell.
1829 * @param array $extrafields Array of extra fields being displayed, such as
1831 * @return array An associative array of HTML sorting links+arrows
1833 public function get_sort_arrows(array $extrafields = array()) {
1837 $strsortasc = $this->get_lang_string('sortasc', 'grades');
1838 $strsortdesc = $this->get_lang_string('sortdesc', 'grades');
1839 $strfirstname = $this->get_lang_string('firstname');
1840 $strlastname = $this->get_lang_string('lastname');
1841 $iconasc = $OUTPUT->pix_icon('t/sort_asc', $strsortasc, '', array('class' => 'iconsmall sorticon'));
1842 $icondesc = $OUTPUT->pix_icon('t/sort_desc', $strsortdesc, '', array('class' => 'iconsmall sorticon'));
1844 $firstlink = html_writer::link(new moodle_url($this->baseurl, array('sortitemid'=>'firstname')), $strfirstname);
1845 $lastlink = html_writer::link(new moodle_url($this->baseurl, array('sortitemid'=>'lastname')), $strlastname);
1847 $arrows['studentname'] = $lastlink;
1849 if ($this->sortitemid === 'lastname') {
1850 if ($this->sortorder == 'ASC') {
1851 $arrows['studentname'] .= $iconasc;
1853 $arrows['studentname'] .= $icondesc;
1857 $arrows['studentname'] .= ' ' . $firstlink;
1859 if ($this->sortitemid === 'firstname') {
1860 if ($this->sortorder == 'ASC') {
1861 $arrows['studentname'] .= $iconasc;
1863 $arrows['studentname'] .= $icondesc;
1867 foreach ($extrafields as $field) {
1868 $fieldlink = html_writer::link(new moodle_url($this->baseurl,
1869 array('sortitemid'=>$field)), get_user_field_name($field));
1870 $arrows[$field] = $fieldlink;
1872 if ($field == $this->sortitemid) {
1873 if ($this->sortorder == 'ASC') {
1874 $arrows[$field] .= $iconasc;
1876 $arrows[$field] .= $icondesc;
1885 * Returns the maximum number of students to be displayed on each page
1887 * @return int The maximum number of students to display per page
1889 public function get_students_per_page() {
1890 return $this->get_pref('studentsperpage');