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