MDL-36559 usability: Gradebook CSS styling for new icons
[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  * @package gradereport_grader
32  */
33 class grade_report_grader extends grade_report {
34     /**
35      * The final grades.
36      * @var array $grades
37      */
38     public $grades;
40     /**
41      * Array of errors for bulk grades updating.
42      * @var array $gradeserror
43      */
44     public $gradeserror = array();
46 //// SQL-RELATED
48     /**
49      * The id of the grade_item by which this report will be sorted.
50      * @var int $sortitemid
51      */
52     public $sortitemid;
54     /**
55      * Sortorder used in the SQL selections.
56      * @var int $sortorder
57      */
58     public $sortorder;
60     /**
61      * An SQL fragment affecting the search for users.
62      * @var string $userselect
63      */
64     public $userselect;
66     /**
67      * The bound params for $userselect
68      * @var array $userselectparams
69      */
70     public $userselectparams = array();
72     /**
73      * List of collapsed categories from user preference
74      * @var array $collapsed
75      */
76     public $collapsed;
78     /**
79      * A count of the rows, used for css classes.
80      * @var int $rowcount
81      */
82     public $rowcount = 0;
84     /**
85      * Capability check caching
86      * */
87     public $canviewhidden;
89     var $preferencespage=false;
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      * Constructor. Sets local copies of user preferences and initialises grade_tree.
100      * @param int $courseid
101      * @param object $gpr grade plugin return tracking object
102      * @param string $context
103      * @param int $page The current page being viewed (when report is paged)
104      * @param int $sortitemid The id of the grade_item by which to sort the table
105      */
106     public function __construct($courseid, $gpr, $context, $page=null, $sortitemid=null) {
107         global $CFG;
108         parent::__construct($courseid, $gpr, $context, $page);
110         $this->canviewhidden = has_capability('moodle/grade:viewhidden', context_course::instance($this->course->id));
112         // load collapsed settings for this report
113         if ($collapsed = get_user_preferences('grade_report_grader_collapsed_categories')) {
114             $this->collapsed = unserialize($collapsed);
115         } else {
116             $this->collapsed = array('aggregatesonly' => array(), 'gradesonly' => array());
117         }
119         if (empty($CFG->enableoutcomes)) {
120             $nooutcomes = false;
121         } else {
122             $nooutcomes = get_user_preferences('grade_report_shownooutcomes');
123         }
125         // if user report preference set or site report setting set use it, otherwise use course or site setting
126         $switch = $this->get_pref('aggregationposition');
127         if ($switch == '') {
128             $switch = grade_get_setting($this->courseid, 'aggregationposition', $CFG->grade_aggregationposition);
129         }
131         // Grab the grade_tree for this course
132         $this->gtree = new grade_tree($this->courseid, true, $switch, $this->collapsed, $nooutcomes);
134         $this->sortitemid = $sortitemid;
136         // base url for sorting by first/last name
138         $this->baseurl = new moodle_url('index.php', array('id' => $this->courseid));
140         $studentsperpage = $this->get_students_per_page();
141         if (!empty($this->page) && !empty($studentsperpage)) {
142             $this->baseurl->params(array('perpage' => $studentsperpage, 'page' => $this->page));
143         }
145         $this->pbarurl = new moodle_url('/grade/report/grader/index.php', array('id' => $this->courseid));
147         $this->setup_groups();
149         $this->setup_sortitemid();
150     }
152     /**
153      * Processes the data sent by the form (grades and feedbacks).
154      * Caller is responsible for all access control checks
155      * @param array $data form submission (with magic quotes)
156      * @return array empty array if success, array of warnings if something fails.
157      */
158     public function process_data($data) {
159         global $DB;
160         $warnings = array();
162         $separategroups = false;
163         $mygroups       = array();
164         if ($this->groupmode == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $this->context)) {
165             $separategroups = true;
166             $mygroups = groups_get_user_groups($this->course->id);
167             $mygroups = $mygroups[0]; // ignore groupings
168             // reorder the groups fro better perf below
169             $current = array_search($this->currentgroup, $mygroups);
170             if ($current !== false) {
171                 unset($mygroups[$current]);
172                 array_unshift($mygroups, $this->currentgroup);
173             }
174         }
176         // always initialize all arrays
177         $queue = array();
178         $this->load_users();
179         $this->load_final_grades();
181         // Were any changes made?
182         $changedgrades = false;
184         foreach ($data as $varname => $postedvalue) {
186             $needsupdate = false;
188             // skip, not a grade nor feedback
189             if (strpos($varname, 'grade') === 0) {
190                 $datatype = 'grade';
191             } else if (strpos($varname, 'feedback') === 0) {
192                 $datatype = 'feedback';
193             } else {
194                 continue;
195             }
197             $gradeinfo = explode("_", $varname);
198             $userid = clean_param($gradeinfo[1], PARAM_INT);
199             $itemid = clean_param($gradeinfo[2], PARAM_INT);
201             // Was change requested?
202             $oldvalue = $this->grades[$userid][$itemid];
203             if ($datatype === 'grade') {
204                 // If there was no grade and there still isn't
205                 if (is_null($oldvalue->finalgrade) && $postedvalue == -1) {
206                     // -1 means no grade
207                     continue;
208                 }
210                 // If the grade item uses a custom scale
211                 if (!empty($oldvalue->grade_item->scaleid)) {
213                     if ((int)$oldvalue->finalgrade === (int)$postedvalue) {
214                         continue;
215                     }
216                 } else {
217                     // The grade item uses a numeric scale
219                     // Format the finalgrade from the DB so that it matches the grade from the client
220                     if ($postedvalue === format_float($oldvalue->finalgrade, $oldvalue->grade_item->get_decimals())) {
221                         continue;
222                     }
223                 }
225                 $changedgrades = true;
227             } else if ($datatype === 'feedback') {
228                 if (($oldvalue->feedback === $postedvalue) or ($oldvalue->feedback === NULL and empty($postedvalue))) {
229                     continue;
230                 }
231             }
233             if (!$gradeitem = grade_item::fetch(array('id'=>$itemid, 'courseid'=>$this->courseid))) { // we must verify course id here!
234                 print_error('invalidgradeitemid');
235             }
237             // Pre-process grade
238             if ($datatype == 'grade') {
239                 $feedback = false;
240                 $feedbackformat = false;
241                 if ($gradeitem->gradetype == GRADE_TYPE_SCALE) {
242                     if ($postedvalue == -1) { // -1 means no grade
243                         $finalgrade = null;
244                     } else {
245                         $finalgrade = $postedvalue;
246                     }
247                 } else {
248                     $finalgrade = unformat_float($postedvalue);
249                 }
251                 $errorstr = '';
252                 // Warn if the grade is out of bounds.
253                 if (is_null($finalgrade)) {
254                     // ok
255                 } else {
256                     $bounded = $gradeitem->bounded_grade($finalgrade);
257                     if ($bounded > $finalgrade) {
258                     $errorstr = 'lessthanmin';
259                     } else if ($bounded < $finalgrade) {
260                         $errorstr = 'morethanmax';
261                     }
262                 }
263                 if ($errorstr) {
264                     $user = $DB->get_record('user', array('id' => $userid), 'id, firstname, lastname');
265                     $gradestr = new stdClass();
266                     $gradestr->username = fullname($user);
267                     $gradestr->itemname = $gradeitem->get_name();
268                     $warnings[] = get_string($errorstr, 'grades', $gradestr);
269                 }
271             } else if ($datatype == 'feedback') {
272                 $finalgrade = false;
273                 $trimmed = trim($postedvalue);
274                 if (empty($trimmed)) {
275                      $feedback = NULL;
276                 } else {
277                      $feedback = $postedvalue;
278                 }
279             }
281             // group access control
282             if ($separategroups) {
283                 // note: we can not use $this->currentgroup because it would fail badly
284                 //       when having two browser windows each with different group
285                 $sharinggroup = false;
286                 foreach($mygroups as $groupid) {
287                     if (groups_is_member($groupid, $userid)) {
288                         $sharinggroup = true;
289                         break;
290                     }
291                 }
292                 if (!$sharinggroup) {
293                     // either group membership changed or somebody is hacking grades of other group
294                     $warnings[] = get_string('errorsavegrade', 'grades');
295                     continue;
296                 }
297             }
299             $gradeitem->update_final_grade($userid, $finalgrade, 'gradebook', $feedback, FORMAT_MOODLE);
301             // We can update feedback without reloading the grade item as it doesn't affect grade calculations
302             if ($datatype === 'feedback') {
303                 $this->grades[$userid][$itemid]->feedback = $feedback;
304             }
305         }
307         if ($changedgrades) {
308             // If a final grade was overriden reload grades so dependent grades like course total will be correct
309             $this->grades = null;
310         }
312         return $warnings;
313     }
316     /**
317      * Setting the sort order, this depends on last state
318      * all this should be in the new table class that we might need to use
319      * for displaying grades.
320      */
321     private function setup_sortitemid() {
323         global $SESSION;
325         if (!isset($SESSION->gradeuserreport)) {
326             $SESSION->gradeuserreport = new stdClass();
327         }
329         if ($this->sortitemid) {
330             if (!isset($SESSION->gradeuserreport->sort)) {
331                 if ($this->sortitemid == 'firstname' || $this->sortitemid == 'lastname') {
332                     $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC';
333                 } else {
334                     $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC';
335                 }
336             } else {
337                 // this is the first sort, i.e. by last name
338                 if (!isset($SESSION->gradeuserreport->sortitemid)) {
339                     if ($this->sortitemid == 'firstname' || $this->sortitemid == 'lastname') {
340                         $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC';
341                     } else {
342                         $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC';
343                     }
344                 } else if ($SESSION->gradeuserreport->sortitemid == $this->sortitemid) {
345                     // same as last sort
346                     if ($SESSION->gradeuserreport->sort == 'ASC') {
347                         $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC';
348                     } else {
349                         $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC';
350                     }
351                 } else {
352                     if ($this->sortitemid == 'firstname' || $this->sortitemid == 'lastname') {
353                         $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC';
354                     } else {
355                         $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC';
356                     }
357                 }
358             }
359             $SESSION->gradeuserreport->sortitemid = $this->sortitemid;
360         } else {
361             // not requesting sort, use last setting (for paging)
363             if (isset($SESSION->gradeuserreport->sortitemid)) {
364                 $this->sortitemid = $SESSION->gradeuserreport->sortitemid;
365             }else{
366                 $this->sortitemid = 'lastname';
367             }
369             if (isset($SESSION->gradeuserreport->sort)) {
370                 $this->sortorder = $SESSION->gradeuserreport->sort;
371             } else {
372                 $this->sortorder = 'ASC';
373             }
374         }
375     }
377     /**
378      * pulls out the userids of the users to be display, and sorts them
379      */
380     public function load_users() {
381         global $CFG, $DB;
383         if (!empty($this->users)) {
384             return;
385         }
387         //limit to users with a gradeable role
388         list($gradebookrolessql, $gradebookrolesparams) = $DB->get_in_or_equal(explode(',', $this->gradebookroles), SQL_PARAMS_NAMED, 'grbr0');
390         //limit to users with an active enrollment
391         list($enrolledsql, $enrolledparams) = get_enrolled_sql($this->context);
393         //fields we need from the user table
394         $userfields = user_picture::fields('u', get_extra_user_fields($this->context));
396         $sortjoin = $sort = $params = null;
398         //if the user has clicked one of the sort asc/desc arrows
399         if (is_numeric($this->sortitemid)) {
400             $params = array_merge(array('gitemid'=>$this->sortitemid), $gradebookrolesparams, $this->groupwheresql_params, $enrolledparams);
402             $sortjoin = "LEFT JOIN {grade_grades} g ON g.userid = u.id AND g.itemid = $this->sortitemid";
403             $sort = "g.finalgrade $this->sortorder";
405         } else {
406             $sortjoin = '';
407             switch($this->sortitemid) {
408                 case 'lastname':
409                     $sort = "u.lastname $this->sortorder, u.firstname $this->sortorder";
410                     break;
411                 case 'firstname':
412                     $sort = "u.firstname $this->sortorder, u.lastname $this->sortorder";
413                     break;
414                 case 'email':
415                     $sort = "u.email $this->sortorder";
416                     break;
417                 case 'idnumber':
418                 default:
419                     $sort = "u.idnumber $this->sortorder";
420                     break;
421             }
423             $params = array_merge($gradebookrolesparams, $this->groupwheresql_params, $enrolledparams);
424         }
426         $sql = "SELECT $userfields
427                   FROM {user} u
428                   JOIN ($enrolledsql) je ON je.id = u.id
429                        $this->groupsql
430                        $sortjoin
431                   JOIN (
432                            SELECT DISTINCT ra.userid
433                              FROM {role_assignments} ra
434                             WHERE ra.roleid IN ($this->gradebookroles)
435                               AND ra.contextid " . get_related_contexts_string($this->context) . "
436                        ) rainner ON rainner.userid = u.id
437                    AND u.deleted = 0
438                    $this->groupwheresql
439               ORDER BY $sort";
441         $studentsperpage = $this->get_students_per_page();
442         $this->users = $DB->get_records_sql($sql, $params, $studentsperpage * $this->page, $studentsperpage);
444         if (empty($this->users)) {
445             $this->userselect = '';
446             $this->users = array();
447             $this->userselect_params = array();
448         } else {
449             list($usql, $uparams) = $DB->get_in_or_equal(array_keys($this->users), SQL_PARAMS_NAMED, 'usid0');
450             $this->userselect = "AND g.userid $usql";
451             $this->userselect_params = $uparams;
453             //add a flag to each user indicating whether their enrolment is active
454             $sql = "SELECT ue.userid
455                       FROM {user_enrolments} ue
456                       JOIN {enrol} e ON e.id = ue.enrolid
457                      WHERE ue.userid $usql
458                            AND ue.status = :uestatus
459                            AND e.status = :estatus
460                            AND e.courseid = :courseid
461                   GROUP BY ue.userid";
462             $coursecontext = get_course_context($this->context);
463             $params = array_merge($uparams, array('estatus'=>ENROL_INSTANCE_ENABLED, 'uestatus'=>ENROL_USER_ACTIVE, 'courseid'=>$coursecontext->instanceid));
464             $useractiveenrolments = $DB->get_records_sql($sql, $params);
466             foreach ($this->users as $user) {
467                 $this->users[$user->id]->suspendedenrolment = !array_key_exists($user->id, $useractiveenrolments);
468             }
469         }
471         return $this->users;
472     }
474     /**
475      * we supply the userids in this query, and get all the grades
476      * pulls out all the grades, this does not need to worry about paging
477      */
478     public function load_final_grades() {
479         global $CFG, $DB;
481         if (!empty($this->grades)) {
482             return;
483         }
485         // please note that we must fetch all grade_grades fields if we want to construct grade_grade object from it!
486         $params = array_merge(array('courseid'=>$this->courseid), $this->userselect_params);
487         $sql = "SELECT g.*
488                   FROM {grade_items} gi,
489                        {grade_grades} g
490                  WHERE g.itemid = gi.id AND gi.courseid = :courseid {$this->userselect}";
492         $userids = array_keys($this->users);
495         if ($grades = $DB->get_records_sql($sql, $params)) {
496             foreach ($grades as $graderec) {
497                 if (in_array($graderec->userid, $userids) and array_key_exists($graderec->itemid, $this->gtree->get_items())) { // some items may not be present!!
498                     $this->grades[$graderec->userid][$graderec->itemid] = new grade_grade($graderec, false);
499                     $this->grades[$graderec->userid][$graderec->itemid]->grade_item = $this->gtree->get_item($graderec->itemid); // db caching
500                 }
501             }
502         }
504         // prefil grades that do not exist yet
505         foreach ($userids as $userid) {
506             foreach ($this->gtree->get_items() as $itemid=>$unused) {
507                 if (!isset($this->grades[$userid][$itemid])) {
508                     $this->grades[$userid][$itemid] = new grade_grade();
509                     $this->grades[$userid][$itemid]->itemid = $itemid;
510                     $this->grades[$userid][$itemid]->userid = $userid;
511                     $this->grades[$userid][$itemid]->grade_item = $this->gtree->get_item($itemid); // db caching
512                 }
513             }
514         }
515     }
517     /**
518      * Builds and returns a div with on/off toggles.
519      * @return string HTML code
520      * @deprecated since 2.4 as it appears not to be used any more.
521      */
522     public function get_toggles_html() {
523         global $CFG, $USER, $COURSE, $OUTPUT;
524         debugging('Call to deprecated function grade_report_grader::get_toggles_html().', DEBUG_DEVELOPER);
525         $html = '';
526         if ($USER->gradeediting[$this->courseid]) {
527             if (has_capability('moodle/grade:manage', $this->context) or has_capability('moodle/grade:hide', $this->context)) {
528                 $html .= $this->print_toggle('eyecons');
529             }
530             if (has_capability('moodle/grade:manage', $this->context)
531              or has_capability('moodle/grade:lock', $this->context)
532              or has_capability('moodle/grade:unlock', $this->context)) {
533                 $html .= $this->print_toggle('locks');
534             }
535             if (has_capability('moodle/grade:manage', $this->context)) {
536                 $html .= $this->print_toggle('quickfeedback');
537             }
539             if (has_capability('moodle/grade:manage', $this->context)) {
540                 $html .= $this->print_toggle('calculations');
541             }
542         }
544         if ($this->canviewhidden) {
545             $html .= $this->print_toggle('averages');
546         }
548         $html .= $this->print_toggle('ranges');
549         if (!empty($CFG->enableoutcomes)) {
550             $html .= $this->print_toggle('nooutcomes');
551         }
553         return $OUTPUT->container($html, 'grade-report-toggles');
554     }
556     /**
557     * Shortcut function for printing the grader report toggles.
558     * @param string $type The type of toggle
559     * @param bool $return Whether to return the HTML string rather than printing it
560     * @return void
561     * @deprecated since 2.4 as it appears not to be used any more.
562     */
563     public function print_toggle($type) {
564         global $CFG, $OUTPUT;
565         debugging('Call to deprecated function grade_report_grader::print_toggle().', DEBUG_DEVELOPER);
566         $icons = array('eyecons' => 't/hide',
567                        'calculations' => 't/calc',
568                        'locks' => 't/lock',
569                        'averages' => 't/mean',
570                        'quickfeedback' => 't/feedback',
571                        'nooutcomes' => 't/outcomes');
573         $prefname = 'grade_report_show' . $type;
575         if (array_key_exists($prefname, $CFG)) {
576             $showpref = get_user_preferences($prefname, $CFG->$prefname);
577         } else {
578             $showpref = get_user_preferences($prefname);
579         }
581         $strshow = $this->get_lang_string('show' . $type, 'grades');
582         $strhide = $this->get_lang_string('hide' . $type, 'grades');
584         $showhide = 'show';
585         $toggleaction = 1;
587         if ($showpref) {
588             $showhide = 'hide';
589             $toggleaction = 0;
590         }
592         if (array_key_exists($type, $icons)) {
593             $imagename = $icons[$type];
594         } else {
595             $imagename = "t/$type";
596         }
598         $string = ${'str' . $showhide};
600         $url = new moodle_url($this->baseurl, array('toggle' => $toggleaction, 'toggle_type' => $type));
602         $retval = $OUTPUT->container($OUTPUT->action_icon($url, new pix_icon($imagename, $string))); // TODO: this container looks wrong here
604         return $retval;
605     }
607     /**
608      * Builds and returns the rows that will make up the left part of the grader report
609      * This consists of student names and icons, links to user reports and id numbers, as well
610      * as header cells for these columns. It also includes the fillers required for the
611      * categories displayed on the right side of the report.
612      * @return array Array of html_table_row objects
613      */
614     public function get_left_rows() {
615         global $CFG, $USER, $OUTPUT;
617         $rows = array();
619         $showuserimage = $this->get_pref('showuserimage');
621         $strfeedback  = $this->get_lang_string("feedback");
622         $strgrade     = $this->get_lang_string('grade');
624         $extrafields = get_extra_user_fields($this->context);
626         $arrows = $this->get_sort_arrows($extrafields);
628         $colspan = 1;
629         if (has_capability('gradereport/'.$CFG->grade_profilereport.':view', $this->context)) {
630             $colspan++;
631         }
632         $colspan += count($extrafields);
634         $levels = count($this->gtree->levels) - 1;
636         for ($i = 0; $i < $levels; $i++) {
637             $fillercell = new html_table_cell();
638             $fillercell->attributes['class'] = 'fixedcolumn cell topleft';
639             $fillercell->text = ' ';
640             $fillercell->colspan = $colspan;
641             $row = new html_table_row(array($fillercell));
642             $rows[] = $row;
643         }
645         $headerrow = new html_table_row();
646         $headerrow->attributes['class'] = 'heading';
648         $studentheader = new html_table_cell();
649         $studentheader->attributes['class'] = 'header';
650         $studentheader->scope = 'col';
651         $studentheader->header = true;
652         $studentheader->id = 'studentheader';
653         if (has_capability('gradereport/'.$CFG->grade_profilereport.':view', $this->context)) {
654             $studentheader->colspan = 2;
655         }
656         $studentheader->text = $arrows['studentname'];
658         $headerrow->cells[] = $studentheader;
660         foreach ($extrafields as $field) {
661             $fieldheader = new html_table_cell();
662             $fieldheader->attributes['class'] = 'header userfield user' . $field;
663             $fieldheader->scope = 'col';
664             $fieldheader->header = true;
665             $fieldheader->text = $arrows[$field];
667             $headerrow->cells[] = $fieldheader;
668         }
670         $rows[] = $headerrow;
672         $rows = $this->get_left_icons_row($rows, $colspan);
674         $rowclasses = array('even', 'odd');
676         $suspendedstring = null;
677         foreach ($this->users as $userid => $user) {
678             $userrow = new html_table_row();
679             $userrow->id = 'fixed_user_'.$userid;
680             $userrow->attributes['class'] = 'r'.$this->rowcount++.' '.$rowclasses[$this->rowcount % 2];
682             $usercell = new html_table_cell();
683             $usercell->attributes['class'] = 'user';
685             $usercell->header = true;
686             $usercell->scope = 'row';
688             if ($showuserimage) {
689                 $usercell->text = $OUTPUT->user_picture($user);
690             }
692             $usercell->text .= html_writer::link(new moodle_url('/user/view.php', array('id' => $user->id, 'course' => $this->course->id)), fullname($user));
694             if (!empty($user->suspendedenrolment)) {
695                 $usercell->attributes['class'] .= ' usersuspended';
697                 //may be lots of suspended users so only get the string once
698                 if (empty($suspendedstring)) {
699                     $suspendedstring = get_string('userenrolmentsuspended', 'grades');
700                 }
701                 $usercell->text .= html_writer::empty_tag('img', array('src'=>$OUTPUT->pix_url('i/enrolmentsuspended'), 'title'=>$suspendedstring, 'alt'=>$suspendedstring, 'class'=>'usersuspendedicon'));
702             }
704             $userrow->cells[] = $usercell;
706             if (has_capability('gradereport/'.$CFG->grade_profilereport.':view', $this->context)) {
707                 $userreportcell = new html_table_cell();
708                 $userreportcell->attributes['class'] = 'userreport';
709                 $userreportcell->header = true;
710                 $a = new stdClass();
711                 $a->user = fullname($user);
712                 $strgradesforuser = get_string('gradesforuser', 'grades', $a);
713                 $url = new moodle_url('/grade/report/'.$CFG->grade_profilereport.'/index.php', array('userid' => $user->id, 'id' => $this->course->id));
714                 $userreportcell->text = $OUTPUT->action_icon($url, new pix_icon('t/grades', $strgradesforuser));
715                 $userrow->cells[] = $userreportcell;
716             }
718             foreach ($extrafields as $field) {
719                 $fieldcell = new html_table_cell();
720                 $fieldcell->attributes['class'] = 'header userfield user' . $field;
721                 $fieldcell->header = true;
722                 $fieldcell->scope = 'row';
723                 $fieldcell->text = $user->{$field};
724                 $userrow->cells[] = $fieldcell;
725             }
727             $rows[] = $userrow;
728         }
730         $rows = $this->get_left_range_row($rows, $colspan);
731         $rows = $this->get_left_avg_row($rows, $colspan, true);
732         $rows = $this->get_left_avg_row($rows, $colspan);
734         return $rows;
735     }
737     /**
738      * Builds and returns the rows that will make up the right part of the grader report
739      * @return array Array of html_table_row objects
740      */
741     public function get_right_rows() {
742         global $CFG, $USER, $OUTPUT, $DB, $PAGE;
744         $rows = array();
745         $this->rowcount = 0;
746         $numrows = count($this->gtree->get_levels());
747         $numusers = count($this->users);
748         $gradetabindex = 1;
749         $columnstounset = array();
750         $strgrade = $this->get_lang_string('grade');
751         $strfeedback  = $this->get_lang_string("feedback");
752         $arrows = $this->get_sort_arrows();
754         $jsarguments = array(
755             'id'        => '#fixed_column',
756             'cfg'       => array('ajaxenabled'=>false),
757             'items'     => array(),
758             'users'     => array(),
759             'feedback'  => array()
760         );
761         $jsscales = array();
763         foreach ($this->gtree->get_levels() as $key=>$row) {
764             if ($key == 0) {
765                 // do not display course grade category
766                 // continue;
767             }
769             $headingrow = new html_table_row();
770             $headingrow->attributes['class'] = 'heading_name_row';
772             foreach ($row as $columnkey => $element) {
773                 $sortlink = clone($this->baseurl);
774                 if (isset($element['object']->id)) {
775                     $sortlink->param('sortitemid', $element['object']->id);
776                 }
778                 $eid    = $element['eid'];
779                 $object = $element['object'];
780                 $type   = $element['type'];
781                 $categorystate = @$element['categorystate'];
783                 if (!empty($element['colspan'])) {
784                     $colspan = $element['colspan'];
785                 } else {
786                     $colspan = 1;
787                 }
789                 if (!empty($element['depth'])) {
790                     $catlevel = 'catlevel'.$element['depth'];
791                 } else {
792                     $catlevel = '';
793                 }
795 // Element is a filler
796                 if ($type == 'filler' or $type == 'fillerfirst' or $type == 'fillerlast') {
797                     $fillercell = new html_table_cell();
798                     $fillercell->attributes['class'] = $type . ' ' . $catlevel;
799                     $fillercell->colspan = $colspan;
800                     $fillercell->text = '&nbsp;';
801                     $fillercell->header = true;
802                     $fillercell->scope = 'col';
803                     $headingrow->cells[] = $fillercell;
804                 }
805 // Element is a category
806                 else if ($type == 'category') {
807                     $categorycell = new html_table_cell();
808                     $categorycell->attributes['class'] = 'category ' . $catlevel;
809                     $categorycell->colspan = $colspan;
810                     $categorycell->text = shorten_text($element['object']->get_name());
811                     $categorycell->text .= $this->get_collapsing_icon($element);
812                     $categorycell->header = true;
813                     $categorycell->scope = 'col';
815                     // Print icons
816                     if ($USER->gradeediting[$this->courseid]) {
817                         $categorycell->text .= $this->get_icons($element);
818                     }
820                     $headingrow->cells[] = $categorycell;
821                 }
822 // Element is a grade_item
823                 else {
824                     //$itemmodule = $element['object']->itemmodule;
825                     //$iteminstance = $element['object']->iteminstance;
827                     if ($element['object']->id == $this->sortitemid) {
828                         if ($this->sortorder == 'ASC') {
829                             $arrow = $this->get_sort_arrow('up', $sortlink);
830                         } else {
831                             $arrow = $this->get_sort_arrow('down', $sortlink);
832                         }
833                     } else {
834                         $arrow = $this->get_sort_arrow('move', $sortlink);
835                     }
837                     $headerlink = $this->gtree->get_element_header($element, true, $this->get_pref('showactivityicons'), false);
839                     $itemcell = new html_table_cell();
840                     $itemcell->attributes['class'] = $type . ' ' . $catlevel . ' highlightable';
842                     if ($element['object']->is_hidden()) {
843                         $itemcell->attributes['class'] .= ' hidden';
844                     }
846                     $itemcell->colspan = $colspan;
847                     $itemcell->text = shorten_text($headerlink) . $arrow;
848                     $itemcell->header = true;
849                     $itemcell->scope = 'col';
851                     $headingrow->cells[] = $itemcell;
852                 }
853             }
854             $rows[] = $headingrow;
855         }
857         $rows = $this->get_right_icons_row($rows);
859         // Preload scale objects for items with a scaleid and initialize tab indices
860         $scaleslist = array();
861         $tabindices = array();
863         foreach ($this->gtree->get_items() as $itemid=>$item) {
864             $scale = null;
865             if (!empty($item->scaleid)) {
866                 $scaleslist[] = $item->scaleid;
867                 $jsarguments['items'][$itemid] = array('id'=>$itemid, 'name'=>$item->get_name(true), 'type'=>'scale', 'scale'=>$item->scaleid, 'decimals'=>$item->get_decimals());
868             } else {
869                 $jsarguments['items'][$itemid] = array('id'=>$itemid, 'name'=>$item->get_name(true), 'type'=>'value', 'scale'=>false, 'decimals'=>$item->get_decimals());
870             }
871             $tabindices[$item->id]['grade'] = $gradetabindex;
872             $tabindices[$item->id]['feedback'] = $gradetabindex + $numusers;
873             $gradetabindex += $numusers * 2;
874         }
875         $scalesarray = array();
877         if (!empty($scaleslist)) {
878             $scalesarray = $DB->get_records_list('scale', 'id', $scaleslist);
879         }
880         $jsscales = $scalesarray;
882         $rowclasses = array('even', 'odd');
884         foreach ($this->users as $userid => $user) {
886             if ($this->canviewhidden) {
887                 $altered = array();
888                 $unknown = array();
889             } else {
890                 $hidingaffected = grade_grade::get_hiding_affected($this->grades[$userid], $this->gtree->get_items());
891                 $altered = $hidingaffected['altered'];
892                 $unknown = $hidingaffected['unknown'];
893                 unset($hidingaffected);
894             }
897             $itemrow = new html_table_row();
898             $itemrow->id = 'user_'.$userid;
899             $itemrow->attributes['class'] = $rowclasses[$this->rowcount % 2];
901             $jsarguments['users'][$userid] = fullname($user);
903             foreach ($this->gtree->items as $itemid=>$unused) {
904                 $item =& $this->gtree->items[$itemid];
905                 $grade = $this->grades[$userid][$item->id];
907                 $itemcell = new html_table_cell();
909                 $itemcell->id = 'u'.$userid.'i'.$itemid;
911                 // Get the decimal points preference for this item
912                 $decimalpoints = $item->get_decimals();
914                 if (in_array($itemid, $unknown)) {
915                     $gradeval = null;
916                 } else if (array_key_exists($itemid, $altered)) {
917                     $gradeval = $altered[$itemid];
918                 } else {
919                     $gradeval = $grade->finalgrade;
920                 }
921                 if (!empty($grade->finalgrade)) {
922                     $gradevalforJS = null;
923                     if ($item->scaleid && !empty($scalesarray[$item->scaleid])) {
924                         $gradevalforJS = (int)$gradeval;
925                     } else {
926                         $gradevalforJS = format_float($gradeval, $decimalpoints);
927                     }
928                     $jsarguments['grades'][] = array('user'=>$userid, 'item'=>$itemid, 'grade'=>$gradevalforJS);
929                 }
931                 // MDL-11274
932                 // Hide grades in the grader report if the current grader doesn't have 'moodle/grade:viewhidden'
933                 if (!$this->canviewhidden and $grade->is_hidden()) {
934                     if (!empty($CFG->grade_hiddenasdate) and $grade->get_datesubmitted() and !$item->is_category_item() and !$item->is_course_item()) {
935                         // 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
936                         $itemcell->text = html_writer::tag('span', userdate($grade->get_datesubmitted(),get_string('strftimedatetimeshort')), array('class'=>'datesubmitted'));
937                     } else {
938                         $itemcell->text = '-';
939                     }
940                     $itemrow->cells[] = $itemcell;
941                     continue;
942                 }
944                 // emulate grade element
945                 $eid = $this->gtree->get_grade_eid($grade);
946                 $element = array('eid'=>$eid, 'object'=>$grade, 'type'=>'grade');
948                 $itemcell->attributes['class'] .= ' grade';
949                 if ($item->is_category_item()) {
950                     $itemcell->attributes['class'] .= ' cat';
951                 }
952                 if ($item->is_course_item()) {
953                     $itemcell->attributes['class'] .= ' course';
954                 }
955                 if ($grade->is_overridden()) {
956                     $itemcell->attributes['class'] .= ' overridden';
957                 }
959                 if ($grade->is_excluded()) {
960                     // $itemcell->attributes['class'] .= ' excluded';
961                 }
963                 if (!empty($grade->feedback)) {
964                     //should we be truncating feedback? ie $short_feedback = shorten_text($feedback, $this->feedback_trunc_length);
965                     $jsarguments['feedback'][] = array('user'=>$userid, 'item'=>$itemid, 'content'=>wordwrap(trim(format_string($grade->feedback, $grade->feedbackformat)), 34, '<br/ >'));
966                 }
968                 if ($grade->is_excluded()) {
969                     $itemcell->text .= html_writer::tag('span', get_string('excluded', 'grades'), array('class'=>'excludedfloater'));
970                 }
972                 // Do not show any icons if no grade (no record in DB to match)
973                 if (!$item->needsupdate and $USER->gradeediting[$this->courseid]) {
974                     $itemcell->text .= $this->get_icons($element);
975                 }
977                 $hidden = '';
978                 if ($grade->is_hidden()) {
979                     $hidden = ' hidden ';
980                 }
982                 $gradepass = ' gradefail ';
983                 if ($grade->is_passed($item)) {
984                     $gradepass = ' gradepass ';
985                 } elseif (is_null($grade->is_passed($item))) {
986                     $gradepass = '';
987                 }
989                 // if in editing mode, we need to print either a text box
990                 // or a drop down (for scales)
991                 // grades in item of type grade category or course are not directly editable
992                 if ($item->needsupdate) {
993                     $itemcell->text .= html_writer::tag('span', get_string('error'), array('class'=>"gradingerror$hidden"));
995                 } else if ($USER->gradeediting[$this->courseid]) {
997                     if ($item->scaleid && !empty($scalesarray[$item->scaleid])) {
998                         $scale = $scalesarray[$item->scaleid];
999                         $gradeval = (int)$gradeval; // scales use only integers
1000                         $scales = explode(",", $scale->scale);
1001                         // reindex because scale is off 1
1003                         // MDL-12104 some previous scales might have taken up part of the array
1004                         // so this needs to be reset
1005                         $scaleopt = array();
1006                         $i = 0;
1007                         foreach ($scales as $scaleoption) {
1008                             $i++;
1009                             $scaleopt[$i] = $scaleoption;
1010                         }
1012                         if ($this->get_pref('quickgrading') and $grade->is_editable()) {
1013                             $oldval = empty($gradeval) ? -1 : $gradeval;
1014                             if (empty($item->outcomeid)) {
1015                                 $nogradestr = $this->get_lang_string('nograde');
1016                             } else {
1017                                 $nogradestr = $this->get_lang_string('nooutcome', 'grades');
1018                             }
1019                             $attributes = array('tabindex' => $tabindices[$item->id]['grade'], 'id'=>'grade_'.$userid.'_'.$item->id);
1020                             $itemcell->text .= html_writer::label(get_string('typescale', 'grades'), $attributes['id'], false, array('class' => 'accesshide'));
1021                             $itemcell->text .= html_writer::select($scaleopt, 'grade_'.$userid.'_'.$item->id, $gradeval, array(-1=>$nogradestr), $attributes);
1022                         } elseif(!empty($scale)) {
1023                             $scales = explode(",", $scale->scale);
1025                             // invalid grade if gradeval < 1
1026                             if ($gradeval < 1) {
1027                                 $itemcell->text .= html_writer::tag('span', '-', array('class'=>"gradevalue$hidden$gradepass"));
1028                             } else {
1029                                 $gradeval = $grade->grade_item->bounded_grade($gradeval); //just in case somebody changes scale
1030                                 $itemcell->text .= html_writer::tag('span', $scales[$gradeval-1], array('class'=>"gradevalue$hidden$gradepass"));
1031                             }
1032                         } else {
1033                             // no such scale, throw error?
1034                         }
1036                     } else if ($item->gradetype != GRADE_TYPE_TEXT) { // Value type
1037                         if ($this->get_pref('quickgrading') and $grade->is_editable()) {
1038                             $value = format_float($gradeval, $decimalpoints);
1039                             $gradelabel = fullname($user) . ' ' . $item->itemname;
1040                             $itemcell->text .= '<label class="accesshide" for="grade_'.$userid.'_'.$item->id.'">'
1041                                           .get_string('useractivitygrade', 'gradereport_grader', $gradelabel).'</label>';
1042                             $itemcell->text .= '<input size="6" tabindex="' . $tabindices[$item->id]['grade']
1043                                           . '" type="text" class="text" title="'. $strgrade .'" name="grade_'
1044                                           .$userid.'_' .$item->id.'" id="grade_'.$userid.'_'.$item->id.'" value="'.$value.'" />';
1045                         } else {
1046                             $itemcell->text .= html_writer::tag('span', format_float($gradeval, $decimalpoints), array('class'=>"gradevalue$hidden$gradepass"));
1047                         }
1048                     }
1051                     // If quickfeedback is on, print an input element
1052                     if ($this->get_pref('showquickfeedback') and $grade->is_editable()) {
1053                         $feedbacklabel = fullname($user) . ' ' . $item->itemname;
1054                         $itemcell->text .= '<label class="accesshide" for="feedback_'.$userid.'_'.$item->id.'">'
1055                                       .get_string('useractivityfeedback', 'gradereport_grader', $feedbacklabel).'</label>';
1056                         $itemcell->text .= '<input class="quickfeedback" tabindex="' . $tabindices[$item->id]['feedback'].'" id="feedback_'.$userid.'_'.$item->id
1057                                       . '" size="6" title="' . $strfeedback . '" type="text" name="feedback_'.$userid.'_'.$item->id.'" value="' . s($grade->feedback) . '" />';
1058                     }
1060                 } else { // Not editing
1061                     $gradedisplaytype = $item->get_displaytype();
1063                     if ($item->scaleid && !empty($scalesarray[$item->scaleid])) {
1064                         $itemcell->attributes['class'] .= ' grade_type_scale';
1065                     } else if ($item->gradetype != GRADE_TYPE_TEXT) {
1066                         $itemcell->attributes['class'] .= ' grade_type_text';
1067                     }
1069                     if ($this->get_pref('enableajax')) {
1070                         $itemcell->attributes['class'] .= ' clickable';
1071                     }
1073                     if ($item->needsupdate) {
1074                         $itemcell->text .= html_writer::tag('span', get_string('error'), array('class'=>"gradingerror$hidden$gradepass"));
1075                     } else {
1076                         $itemcell->text .= html_writer::tag('span', grade_format_gradevalue($gradeval, $item, true, $gradedisplaytype, null), array('class'=>"gradevalue$hidden$gradepass"));
1077                         if ($this->get_pref('showanalysisicon')) {
1078                             $itemcell->text .= $this->gtree->get_grade_analysis_icon($grade);
1079                         }
1080                     }
1081                 }
1083                 if (!empty($this->gradeserror[$item->id][$userid])) {
1084                     $itemcell->text .= $this->gradeserror[$item->id][$userid];
1085                 }
1087                 $itemrow->cells[] = $itemcell;
1088             }
1089             $rows[] = $itemrow;
1090         }
1092         if ($this->get_pref('enableajax')) {
1093             $jsarguments['cfg']['ajaxenabled'] = true;
1094             $jsarguments['cfg']['scales'] = array();
1095             foreach ($jsscales as $scale) {
1096                 $jsarguments['cfg']['scales'][$scale->id] = explode(',',$scale->scale);
1097             }
1098             $jsarguments['cfg']['feedbacktrunclength'] =  $this->feedback_trunc_length;
1100             // Student grades and feedback are already at $jsarguments['feedback'] and $jsarguments['grades']
1101         }
1102         $jsarguments['cfg']['isediting'] = (bool)$USER->gradeediting[$this->courseid];
1103         $jsarguments['cfg']['courseid'] =  $this->courseid;
1104         $jsarguments['cfg']['studentsperpage'] =  $this->get_students_per_page();
1105         $jsarguments['cfg']['showquickfeedback'] =  (bool)$this->get_pref('showquickfeedback');
1107         $module = array(
1108             'name'      => 'gradereport_grader',
1109             'fullpath'  => '/grade/report/grader/module.js',
1110             'requires'  => array('base', 'dom', 'event', 'event-mouseenter', 'event-key', 'io-queue', 'json-parse', 'overlay')
1111         );
1112         $PAGE->requires->js_init_call('M.gradereport_grader.init_report', $jsarguments, false, $module);
1113         $PAGE->requires->strings_for_js(array('addfeedback','feedback', 'grade'), 'grades');
1114         $PAGE->requires->strings_for_js(array('ajaxchoosescale','ajaxclicktoclose','ajaxerror','ajaxfailedupdate', 'ajaxfieldchanged'), 'gradereport_grader');
1116         $rows = $this->get_right_range_row($rows);
1117         $rows = $this->get_right_avg_row($rows, true);
1118         $rows = $this->get_right_avg_row($rows);
1120         return $rows;
1121     }
1123     /**
1124      * Depending on the style of report (fixedstudents vs traditional one-table),
1125      * arranges the rows of data in one or two tables, and returns the output of
1126      * these tables in HTML
1127      * @return string HTML
1128      */
1129     public function get_grade_table() {
1130         global $OUTPUT;
1131         $fixedstudents = $this->is_fixed_students();
1133         $leftrows = $this->get_left_rows();
1134         $rightrows = $this->get_right_rows();
1136         $html = '';
1139         if ($fixedstudents) {
1140             $fixedcolumntable = new html_table();
1141             $fixedcolumntable->id = 'fixed_column';
1142             $fixedcolumntable->data = $leftrows;
1143             $html .= $OUTPUT->container(html_writer::table($fixedcolumntable), 'left_scroller');
1145             $righttable = new html_table();
1146             $righttable->id = 'user-grades';
1147             $righttable->data = $rightrows;
1149             $html .= $OUTPUT->container(html_writer::table($righttable), 'right_scroller');
1150         } else {
1151             $fulltable = new html_table();
1152             $fulltable->attributes['class'] = 'gradestable flexible boxaligncenter generaltable';
1153             $fulltable->id = 'user-grades';
1155             // Extract rows from each side (left and right) and collate them into one row each
1156             foreach ($leftrows as $key => $row) {
1157                 $row->cells = array_merge($row->cells, $rightrows[$key]->cells);
1158                 $fulltable->data[] = $row;
1159             }
1160             $html .= html_writer::table($fulltable);
1161         }
1162         return $OUTPUT->container($html, 'gradeparent');
1163     }
1165     /**
1166      * Builds and return the row of icons for the left side of the report.
1167      * It only has one cell that says "Controls"
1168      * @param array $rows The Array of rows for the left part of the report
1169      * @param int $colspan The number of columns this cell has to span
1170      * @return array Array of rows for the left part of the report
1171      */
1172     public function get_left_icons_row($rows=array(), $colspan=1) {
1173         global $USER;
1175         if ($USER->gradeediting[$this->courseid]) {
1176             $controlsrow = new html_table_row();
1177             $controlsrow->attributes['class'] = 'controls';
1178             $controlscell = new html_table_cell();
1179             $controlscell->attributes['class'] = 'header controls';
1180             $controlscell->colspan = $colspan;
1181             $controlscell->text = $this->get_lang_string('controls','grades');
1183             $controlsrow->cells[] = $controlscell;
1184             $rows[] = $controlsrow;
1185         }
1186         return $rows;
1187     }
1189     /**
1190      * Builds and return the header for the row of ranges, for the left part of the grader report.
1191      * @param array $rows The Array of rows for the left part of the report
1192      * @param int $colspan The number of columns this cell has to span
1193      * @return array Array of rows for the left part of the report
1194      */
1195     public function get_left_range_row($rows=array(), $colspan=1) {
1196         global $CFG, $USER;
1198         if ($this->get_pref('showranges')) {
1199             $rangerow = new html_table_row();
1200             $rangerow->attributes['class'] = 'range r'.$this->rowcount++;
1201             $rangecell = new html_table_cell();
1202             $rangecell->attributes['class'] = 'header range';
1203             $rangecell->colspan = $colspan;
1204             $rangecell->header = true;
1205             $rangecell->scope = 'row';
1206             $rangecell->text = $this->get_lang_string('range','grades');
1207             $rangerow->cells[] = $rangecell;
1208             $rows[] = $rangerow;
1209         }
1211         return $rows;
1212     }
1214     /**
1215      * Builds and return the headers for the rows of averages, for the left part of the grader report.
1216      * @param array $rows The Array of rows for the left part of the report
1217      * @param int $colspan The number of columns this cell has to span
1218      * @param bool $groupavg If true, returns the row for group averages, otherwise for overall averages
1219      * @return array Array of rows for the left part of the report
1220      */
1221     public function get_left_avg_row($rows=array(), $colspan=1, $groupavg=false) {
1222         if (!$this->canviewhidden) {
1223             // totals might be affected by hiding, if user can not see hidden grades the aggregations might be altered
1224             // better not show them at all if user can not see all hideen grades
1225             return $rows;
1226         }
1228         $showaverages = $this->get_pref('showaverages');
1229         $showaveragesgroup = $this->currentgroup && $showaverages;
1230         $straveragegroup = get_string('groupavg', 'grades');
1232         if ($groupavg) {
1233             if ($showaveragesgroup) {
1234                 $groupavgrow = new html_table_row();
1235                 $groupavgrow->attributes['class'] = 'groupavg r'.$this->rowcount++;
1236                 $groupavgcell = new html_table_cell();
1237                 $groupavgcell->attributes['class'] = 'header range';
1238                 $groupavgcell->colspan = $colspan;
1239                 $groupavgcell->header = true;
1240                 $groupavgcell->scope = 'row';
1241                 $groupavgcell->text = $straveragegroup;
1242                 $groupavgrow->cells[] = $groupavgcell;
1243                 $rows[] = $groupavgrow;
1244             }
1245         } else {
1246             $straverage = get_string('overallaverage', 'grades');
1248             if ($showaverages) {
1249                 $avgrow = new html_table_row();
1250                 $avgrow->attributes['class'] = 'avg r'.$this->rowcount++;
1251                 $avgcell = new html_table_cell();
1252                 $avgcell->attributes['class'] = 'header range';
1253                 $avgcell->colspan = $colspan;
1254                 $avgcell->header = true;
1255                 $avgcell->scope = 'row';
1256                 $avgcell->text = $straverage;
1257                 $avgrow->cells[] = $avgcell;
1258                 $rows[] = $avgrow;
1259             }
1260         }
1262         return $rows;
1263     }
1265     /**
1266      * Builds and return the row of icons when editing is on, for the right part of the grader report.
1267      * @param array $rows The Array of rows for the right part of the report
1268      * @return array Array of rows for the right part of the report
1269      */
1270     public function get_right_icons_row($rows=array()) {
1271         global $USER;
1272         if ($USER->gradeediting[$this->courseid]) {
1273             $iconsrow = new html_table_row();
1274             $iconsrow->attributes['class'] = 'controls';
1276             foreach ($this->gtree->items as $itemid=>$unused) {
1277                 // emulate grade element
1278                 $item = $this->gtree->get_item($itemid);
1280                 $eid = $this->gtree->get_item_eid($item);
1281                 $element = $this->gtree->locate_element($eid);
1282                 $itemcell = new html_table_cell();
1283                 $itemcell->attributes['class'] = 'controls icons';
1284                 $itemcell->text = $this->get_icons($element);
1285                 $iconsrow->cells[] = $itemcell;
1286             }
1287             $rows[] = $iconsrow;
1288         }
1289         return $rows;
1290     }
1292     /**
1293      * Builds and return the row of ranges for the right part of the grader report.
1294      * @param array $rows The Array of rows for the right part of the report
1295      * @return array Array of rows for the right part of the report
1296      */
1297     public function get_right_range_row($rows=array()) {
1298         global $OUTPUT;
1300         if ($this->get_pref('showranges')) {
1301             $rangesdisplaytype   = $this->get_pref('rangesdisplaytype');
1302             $rangesdecimalpoints = $this->get_pref('rangesdecimalpoints');
1303             $rangerow = new html_table_row();
1304             $rangerow->attributes['class'] = 'heading range';
1306             foreach ($this->gtree->items as $itemid=>$unused) {
1307                 $item =& $this->gtree->items[$itemid];
1308                 $itemcell = new html_table_cell();
1309                 $itemcell->header = true;
1310                 $itemcell->attributes['class'] .= ' header range';
1312                 $hidden = '';
1313                 if ($item->is_hidden()) {
1314                     $hidden = ' hidden ';
1315                 }
1317                 $formattedrange = $item->get_formatted_range($rangesdisplaytype, $rangesdecimalpoints);
1319                 $itemcell->text = $OUTPUT->container($formattedrange, 'rangevalues'.$hidden);
1320                 $rangerow->cells[] = $itemcell;
1321             }
1322             $rows[] = $rangerow;
1323         }
1324         return $rows;
1325     }
1327     /**
1328      * Builds and return the row of averages for the right part of the grader report.
1329      * @param array $rows Whether to return only group averages or all averages.
1330      * @param bool $grouponly Whether to return only group averages or all averages.
1331      * @return array Array of rows for the right part of the report
1332      */
1333     public function get_right_avg_row($rows=array(), $grouponly=false) {
1334         global $CFG, $USER, $DB, $OUTPUT;
1336         if (!$this->canviewhidden) {
1337             // totals might be affected by hiding, if user can not see hidden grades the aggregations might be altered
1338             // better not show them at all if user can not see all hidden grades
1339             return $rows;
1340         }
1342         $showaverages = $this->get_pref('showaverages');
1343         $showaveragesgroup = $this->currentgroup && $showaverages;
1345         $averagesdisplaytype   = $this->get_pref('averagesdisplaytype');
1346         $averagesdecimalpoints = $this->get_pref('averagesdecimalpoints');
1347         $meanselection         = $this->get_pref('meanselection');
1348         $shownumberofgrades    = $this->get_pref('shownumberofgrades');
1350         $avghtml = '';
1351         $avgcssclass = 'avg';
1353         if ($grouponly) {
1354             $straverage = get_string('groupavg', 'grades');
1355             $showaverages = $this->currentgroup && $this->get_pref('showaverages');
1356             $groupsql = $this->groupsql;
1357             $groupwheresql = $this->groupwheresql;
1358             $groupwheresqlparams = $this->groupwheresql_params;
1359             $avgcssclass = 'groupavg';
1360         } else {
1361             $straverage = get_string('overallaverage', 'grades');
1362             $showaverages = $this->get_pref('showaverages');
1363             $groupsql = "";
1364             $groupwheresql = "";
1365             $groupwheresqlparams = array();
1366         }
1368         if ($shownumberofgrades) {
1369             $straverage .= ' (' . get_string('submissions', 'grades') . ') ';
1370         }
1372         $totalcount = $this->get_numusers($grouponly);
1374         //limit to users with a gradeable role
1375         list($gradebookrolessql, $gradebookrolesparams) = $DB->get_in_or_equal(explode(',', $this->gradebookroles), SQL_PARAMS_NAMED, 'grbr0');
1377         //limit to users with an active enrollment
1378         list($enrolledsql, $enrolledparams) = get_enrolled_sql($this->context);
1380         if ($showaverages) {
1381             $params = array_merge(array('courseid'=>$this->courseid), $gradebookrolesparams, $enrolledparams, $groupwheresqlparams);
1383             // find sums of all grade items in course
1384             $sql = "SELECT g.itemid, SUM(g.finalgrade) AS sum
1385                       FROM {grade_items} gi
1386                       JOIN {grade_grades} g ON g.itemid = gi.id
1387                       JOIN {user} u ON u.id = g.userid
1388                       JOIN ($enrolledsql) je ON je.id = u.id
1389                       JOIN (
1390                                SELECT DISTINCT ra.userid
1391                                  FROM {role_assignments} ra
1392                                 WHERE ra.roleid $gradebookrolessql
1393                                   AND ra.contextid " . get_related_contexts_string($this->context) . "
1394                            ) rainner ON rainner.userid = u.id
1395                       $groupsql
1396                      WHERE gi.courseid = :courseid
1397                        AND u.deleted = 0
1398                        AND g.finalgrade IS NOT NULL
1399                        $groupwheresql
1400                      GROUP BY g.itemid";
1401             $sumarray = array();
1402             if ($sums = $DB->get_records_sql($sql, $params)) {
1403                 foreach ($sums as $itemid => $csum) {
1404                     $sumarray[$itemid] = $csum->sum;
1405                 }
1406             }
1408             // MDL-10875 Empty grades must be evaluated as grademin, NOT always 0
1409             // This query returns a count of ungraded grades (NULL finalgrade OR no matching record in grade_grades table)
1410             $sql = "SELECT gi.id, COUNT(DISTINCT u.id) AS count
1411                       FROM {grade_items} gi
1412                       CROSS JOIN {user} u
1413                       JOIN ($enrolledsql) je
1414                            ON je.id = u.id
1415                       JOIN {role_assignments} ra
1416                            ON ra.userid = u.id
1417                       LEFT OUTER JOIN {grade_grades} g
1418                            ON (g.itemid = gi.id AND g.userid = u.id AND g.finalgrade IS NOT NULL)
1419                       $groupsql
1420                      WHERE gi.courseid = :courseid
1421                            AND ra.roleid $gradebookrolessql
1422                            AND ra.contextid ".get_related_contexts_string($this->context)."
1423                            AND u.deleted = 0
1424                            AND g.id IS NULL
1425                            $groupwheresql
1426                   GROUP BY gi.id";
1428             $ungradedcounts = $DB->get_records_sql($sql, $params);
1430             $avgrow = new html_table_row();
1431             $avgrow->attributes['class'] = 'avg';
1433             foreach ($this->gtree->items as $itemid=>$unused) {
1434                 $item =& $this->gtree->items[$itemid];
1436                 if ($item->needsupdate) {
1437                     $avgcell = new html_table_cell();
1438                     $avgcell->text = $OUTPUT->container(get_string('error'), 'gradingerror');
1439                     $avgrow->cells[] = $avgcell;
1440                     continue;
1441                 }
1443                 if (!isset($sumarray[$item->id])) {
1444                     $sumarray[$item->id] = 0;
1445                 }
1447                 if (empty($ungradedcounts[$itemid])) {
1448                     $ungradedcount = 0;
1449                 } else {
1450                     $ungradedcount = $ungradedcounts[$itemid]->count;
1451                 }
1453                 if ($meanselection == GRADE_REPORT_MEAN_GRADED) {
1454                     $meancount = $totalcount - $ungradedcount;
1455                 } else { // Bump up the sum by the number of ungraded items * grademin
1456                     $sumarray[$item->id] += $ungradedcount * $item->grademin;
1457                     $meancount = $totalcount;
1458                 }
1460                 $decimalpoints = $item->get_decimals();
1462                 // Determine which display type to use for this average
1463                 if ($USER->gradeediting[$this->courseid]) {
1464                     $displaytype = GRADE_DISPLAY_TYPE_REAL;
1466                 } else if ($averagesdisplaytype == GRADE_REPORT_PREFERENCE_INHERIT) { // no ==0 here, please resave the report and user preferences
1467                     $displaytype = $item->get_displaytype();
1469                 } else {
1470                     $displaytype = $averagesdisplaytype;
1471                 }
1473                 // Override grade_item setting if a display preference (not inherit) was set for the averages
1474                 if ($averagesdecimalpoints == GRADE_REPORT_PREFERENCE_INHERIT) {
1475                     $decimalpoints = $item->get_decimals();
1477                 } else {
1478                     $decimalpoints = $averagesdecimalpoints;
1479                 }
1481                 if (!isset($sumarray[$item->id]) || $meancount == 0) {
1482                     $avgcell = new html_table_cell();
1483                     $avgcell->text = '-';
1484                     $avgrow->cells[] = $avgcell;
1486                 } else {
1487                     $sum = $sumarray[$item->id];
1488                     $avgradeval = $sum/$meancount;
1489                     $gradehtml = grade_format_gradevalue($avgradeval, $item, true, $displaytype, $decimalpoints);
1491                     $numberofgrades = '';
1492                     if ($shownumberofgrades) {
1493                         $numberofgrades = " ($meancount)";
1494                     }
1496                     $avgcell = new html_table_cell();
1497                     $avgcell->text = $gradehtml.$numberofgrades;
1498                     $avgrow->cells[] = $avgcell;
1499                 }
1500             }
1501             $rows[] = $avgrow;
1502         }
1503         return $rows;
1504     }
1506     /**
1507      * Given a grade_category, grade_item or grade_grade, this function
1508      * figures out the state of the object and builds then returns a div
1509      * with the icons needed for the grader report.
1510      *
1511      * @param array $object
1512      * @return string HTML
1513      */
1514     protected function get_icons($element) {
1515         global $CFG, $USER, $OUTPUT;
1517         if (!$USER->gradeediting[$this->courseid]) {
1518             return '<div class="grade_icons" />';
1519         }
1521         // Init all icons
1522         $editicon = '';
1524         if ($element['type'] != 'categoryitem' && $element['type'] != 'courseitem') {
1525             $editicon = $this->gtree->get_edit_icon($element, $this->gpr);
1526         }
1528         $editcalculationicon = '';
1529         $showhideicon        = '';
1530         $lockunlockicon      = '';
1532         if (has_capability('moodle/grade:manage', $this->context)) {
1533             if ($this->get_pref('showcalculations')) {
1534                 $editcalculationicon = $this->gtree->get_calculation_icon($element, $this->gpr);
1535             }
1537             if ($this->get_pref('showeyecons')) {
1538                $showhideicon = $this->gtree->get_hiding_icon($element, $this->gpr);
1539             }
1541             if ($this->get_pref('showlocks')) {
1542                 $lockunlockicon = $this->gtree->get_locking_icon($element, $this->gpr);
1543             }
1545         }
1547         $gradeanalysisicon   = '';
1548         if ($this->get_pref('showanalysisicon') && $element['type'] == 'grade') {
1549             $gradeanalysisicon .= $this->gtree->get_grade_analysis_icon($element['object']);
1550         }
1552         return $OUTPUT->container($editicon.$editcalculationicon.$showhideicon.$lockunlockicon.$gradeanalysisicon, 'grade_icons');
1553     }
1555     /**
1556      * Given a category element returns collapsing +/- icon if available
1557      * @param object $object
1558      * @return string HTML
1559      */
1560     protected function get_collapsing_icon($element) {
1561         global $OUTPUT;
1563         $icon = '';
1564         // If object is a category, display expand/contract icon
1565         if ($element['type'] == 'category') {
1566             // Load language strings
1567             $strswitchminus = $this->get_lang_string('aggregatesonly', 'grades');
1568             $strswitchplus  = $this->get_lang_string('gradesonly', 'grades');
1569             $strswitchwhole = $this->get_lang_string('fullmode', 'grades');
1571             $url = new moodle_url($this->gpr->get_return_url(null, array('target'=>$element['eid'], 'sesskey'=>sesskey())));
1573             if (in_array($element['object']->id, $this->collapsed['aggregatesonly'])) {
1574                 $url->param('action', 'switch_plus');
1575                 $icon = $OUTPUT->action_icon($url, new pix_icon('t/switch_plus', $strswitchplus));
1577             } else if (in_array($element['object']->id, $this->collapsed['gradesonly'])) {
1578                 $url->param('action', 'switch_whole');
1579                 $icon = $OUTPUT->action_icon($url, new pix_icon('t/switch_whole', $strswitchwhole));
1581             } else {
1582                 $url->param('action', 'switch_minus');
1583                 $icon = $OUTPUT->action_icon($url, new pix_icon('t/switch_minus', $strswitchminus));
1584             }
1585         }
1586         return $icon;
1587     }
1589     public function process_action($target, $action) {
1590         return self::do_process_action($target, $action);
1591     }
1593     /**
1594      * Processes a single action against a category, grade_item or grade.
1595      * @param string $target eid ({type}{id}, e.g. c4 for category4)
1596      * @param string $action Which action to take (edit, delete etc...)
1597      * @return
1598      */
1599     public static function do_process_action($target, $action) {
1600         // TODO: this code should be in some grade_tree static method
1601         $targettype = substr($target, 0, 1);
1602         $targetid = substr($target, 1);
1603         // TODO: end
1605         if ($collapsed = get_user_preferences('grade_report_grader_collapsed_categories')) {
1606             $collapsed = unserialize($collapsed);
1607         } else {
1608             $collapsed = array('aggregatesonly' => array(), 'gradesonly' => array());
1609         }
1611         switch ($action) {
1612             case 'switch_minus': // Add category to array of aggregatesonly
1613                 if (!in_array($targetid, $collapsed['aggregatesonly'])) {
1614                     $collapsed['aggregatesonly'][] = $targetid;
1615                     set_user_preference('grade_report_grader_collapsed_categories', serialize($collapsed));
1616                 }
1617                 break;
1619             case 'switch_plus': // Remove category from array of aggregatesonly, and add it to array of gradesonly
1620                 $key = array_search($targetid, $collapsed['aggregatesonly']);
1621                 if ($key !== false) {
1622                     unset($collapsed['aggregatesonly'][$key]);
1623                 }
1624                 if (!in_array($targetid, $collapsed['gradesonly'])) {
1625                     $collapsed['gradesonly'][] = $targetid;
1626                 }
1627                 set_user_preference('grade_report_grader_collapsed_categories', serialize($collapsed));
1628                 break;
1629             case 'switch_whole': // Remove the category from the array of collapsed cats
1630                 $key = array_search($targetid, $collapsed['gradesonly']);
1631                 if ($key !== false) {
1632                     unset($collapsed['gradesonly'][$key]);
1633                     set_user_preference('grade_report_grader_collapsed_categories', serialize($collapsed));
1634                 }
1636                 break;
1637             default:
1638                 break;
1639         }
1641         return true;
1642     }
1644     /**
1645      * Returns whether or not to display fixed students column.
1646      * Includes a browser check, because IE6 doesn't support the scrollbar.
1647      *
1648      * @return bool
1649      */
1650     public function is_fixed_students() {
1651         global $USER, $CFG;
1652         return $CFG->grade_report_fixedstudents &&
1653             (check_browser_version('MSIE', '7.0') ||
1654              check_browser_version('Firefox', '2.0') ||
1655              check_browser_version('Gecko', '2006010100') ||
1656              check_browser_version('Camino', '1.0') ||
1657              check_browser_version('Opera', '6.0') ||
1658              check_browser_version('Chrome', '6') ||
1659              check_browser_version('Safari', '300'));
1660     }
1662     /**
1663      * Refactored function for generating HTML of sorting links with matching arrows.
1664      * Returns an array with 'studentname' and 'idnumber' as keys, with HTML ready
1665      * to inject into a table header cell.
1666      * @param array $extrafields Array of extra fields being displayed, such as
1667      *   user idnumber
1668      * @return array An associative array of HTML sorting links+arrows
1669      */
1670     public function get_sort_arrows(array $extrafields = array()) {
1671         global $OUTPUT;
1672         $arrows = array();
1674         $strsortasc   = $this->get_lang_string('sortasc', 'grades');
1675         $strsortdesc  = $this->get_lang_string('sortdesc', 'grades');
1676         $strfirstname = $this->get_lang_string('firstname');
1677         $strlastname  = $this->get_lang_string('lastname');
1678         $iconasc = $OUTPUT->pix_icon('t/sort_asc', $strsortasc, '', array('class' => 'iconsmall sorticon'));
1679         $icondesc = $OUTPUT->pix_icon('t/sort_desc', $strsortdesc, '', array('class' => 'iconsmall sorticon'));
1681         $firstlink = html_writer::link(new moodle_url($this->baseurl, array('sortitemid'=>'firstname')), $strfirstname);
1682         $lastlink = html_writer::link(new moodle_url($this->baseurl, array('sortitemid'=>'lastname')), $strlastname);
1684         $arrows['studentname'] = $lastlink;
1686         if ($this->sortitemid === 'lastname') {
1687             if ($this->sortorder == 'ASC') {
1688                 $arrows['studentname'] .= $iconasc;
1689             } else {
1690                 $arrows['studentname'] .= $icondesc;
1691             }
1692         }
1694         $arrows['studentname'] .= ' ' . $firstlink;
1696         if ($this->sortitemid === 'firstname') {
1697             if ($this->sortorder == 'ASC') {
1698                 $arrows['studentname'] .= $iconasc;
1699             } else {
1700                 $arrows['studentname'] .= $icondesc;
1701             }
1702         }
1704         foreach ($extrafields as $field) {
1705             $fieldlink = html_writer::link(new moodle_url($this->baseurl,
1706                     array('sortitemid'=>$field)), get_user_field_name($field));
1707             $arrows[$field] = $fieldlink;
1709             if ($field == $this->sortitemid) {
1710                 if ($this->sortorder == 'ASC') {
1711                     $arrows[$field] .= $iconasc;
1712                 } else {
1713                     $arrows[$field] .= $icondesc;
1714                 }
1715             }
1716         }
1718         return $arrows;
1719     }
1721     /**
1722      * Returns the maximum number of students to be displayed on each page
1723      *
1724      * Takes into account the 'studentsperpage' user preference and the 'max_input_vars'
1725      * PHP setting. Too many fields is only a problem when submitting grades but
1726      * we respect 'max_input_vars' even when viewing grades to prevent students disappearing
1727      * when toggling editing on and off.
1728      *
1729      * @return int The maximum number of students to display per page
1730      */
1731     public function get_students_per_page() {
1732         global $USER;
1733         static $studentsperpage = null;
1735         if ($studentsperpage === null) {
1736             $originalstudentsperpage = $studentsperpage = $this->get_pref('studentsperpage');
1738             // Will this number of students result in more fields that we are allowed?
1739             $maxinputvars = ini_get('max_input_vars');
1740             if ($maxinputvars !== false) {
1741                 $fieldspergradeitem = 0; // The number of fields output per grade item for each student
1743                 if ($this->get_pref('quickgrading')) {
1744                     // One grade field
1745                     $fieldspergradeitem ++;
1746                 }
1747                 if ($this->get_pref('showquickfeedback')) {
1748                     // One feedback field
1749                     $fieldspergradeitem ++;
1750                 }
1752                 $fieldsperstudent = $fieldspergradeitem * count($this->gtree->get_items());
1753                 $fieldsrequired = $studentsperpage * $fieldsperstudent;
1754                 if ($fieldsrequired > $maxinputvars) {
1755                     $studentsperpage = floor($maxinputvars / $fieldsperstudent);
1756                     if ($studentsperpage<1) {
1757                         // Make sure students per page doesn't fall below 1
1758                         // PHP max_input_vars could potentially be reached with 1 student
1759                         // if there are >500 grade items and quickgrading and showquickfeedback are on
1760                         $studentsperpage = 1;
1761                     }
1763                     $a = new stdClass();
1764                     $a->originalstudentsperpage = $originalstudentsperpage;
1765                     $a->studentsperpage = $studentsperpage;
1766                     $a->maxinputvars = $maxinputvars;
1767                     debugging(get_string('studentsperpagereduced', 'grades', $a));
1768                 }
1769             }
1770         }
1772         return $studentsperpage;
1773     }