5c591cece7d60c9cc2598986b47ad830e3527905
[moodle.git] / grade / report / grader / lib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * File in which the grader_report class is defined.
20  * @package gradebook
21  */
23 require_once($CFG->dirroot . '/grade/report/lib.php');
24 require_once($CFG->libdir.'/tablelib.php');
26 /**
27  * Class providing an API for the grader report building and displaying.
28  * @uses grade_report
29  * @package gradebook
30  */
31 class grade_report_grader extends grade_report {
32     /**
33      * The final grades.
34      * @var array $grades
35      */
36     public $grades;
38     /**
39      * Array of errors for bulk grades updating.
40      * @var array $gradeserror
41      */
42     public $gradeserror = array();
44 //// SQL-RELATED
46     /**
47      * The id of the grade_item by which this report will be sorted.
48      * @var int $sortitemid
49      */
50     public $sortitemid;
52     /**
53      * Sortorder used in the SQL selections.
54      * @var int $sortorder
55      */
56     public $sortorder;
58     /**
59      * An SQL fragment affecting the search for users.
60      * @var string $userselect
61      */
62     public $userselect;
64     /**
65      * The bound params for $userselect
66      * @var array $userselectparams
67      */
68     public $userselectparams = array();
70     /**
71      * List of collapsed categories from user preference
72      * @var array $collapsed
73      */
74     public $collapsed;
76     /**
77      * A count of the rows, used for css classes.
78      * @var int $rowcount
79      */
80     public $rowcount = 0;
82     /**
83      * Capability check caching
84      * */
85     public $canviewhidden;
87     var $preferencespage=false;
89     /**
90      * Length at which feedback will be truncated (to the nearest word) and an ellipsis be added.
91      * TODO replace this by a report preference
92      * @var int $feedback_trunc_length
93      */
94     protected $feedback_trunc_length = 50;
96     /**
97      * Constructor. Sets local copies of user preferences and initialises grade_tree.
98      * @param int $courseid
99      * @param object $gpr grade plugin return tracking object
100      * @param string $context
101      * @param int $page The current page being viewed (when report is paged)
102      * @param int $sortitemid The id of the grade_item by which to sort the table
103      */
104     public function __construct($courseid, $gpr, $context, $page=null, $sortitemid=null) {
105         global $CFG;
106         parent::__construct($courseid, $gpr, $context, $page);
108         $this->canviewhidden = has_capability('moodle/grade:viewhidden', get_context_instance(CONTEXT_COURSE, $this->course->id));
110         // load collapsed settings for this report
111         if ($collapsed = get_user_preferences('grade_report_grader_collapsed_categories')) {
112             $this->collapsed = unserialize($collapsed);
113         } else {
114             $this->collapsed = array('aggregatesonly' => array(), 'gradesonly' => array());
115         }
117         if (empty($CFG->enableoutcomes)) {
118             $nooutcomes = false;
119         } else {
120             $nooutcomes = get_user_preferences('grade_report_shownooutcomes');
121         }
123         // if user report preference set or site report setting set use it, otherwise use course or site setting
124         $switch = $this->get_pref('aggregationposition');
125         if ($switch == '') {
126             $switch = grade_get_setting($this->courseid, 'aggregationposition', $CFG->grade_aggregationposition);
127         }
129         // Grab the grade_tree for this course
130         $this->gtree = new grade_tree($this->courseid, true, $switch, $this->collapsed, $nooutcomes);
132         $this->sortitemid = $sortitemid;
134         // base url for sorting by first/last name
136         $this->baseurl = new moodle_url('index.php', array('id' => $this->courseid));
138         $studentsperpage = $this->get_pref('studentsperpage');
139         if (!empty($studentsperpage)) {
140             $this->baseurl->params(array('perpage' => $studentsperpage, 'page' => $this->page));
141         }
143         $this->pbarurl = new moodle_url('/grade/report/grader/index.php', array('id' => $this->courseid, 'perpage' => $studentsperpage));
145         $this->setup_groups();
147         $this->setup_sortitemid();
148     }
150     /**
151      * Processes the data sent by the form (grades and feedbacks).
152      * Caller is responsible for all access control checks
153      * @param array $data form submission (with magic quotes)
154      * @return array empty array if success, array of warnings if something fails.
155      */
156     public function process_data($data) {
157         global $DB;
158         $warnings = array();
160         $separategroups = false;
161         $mygroups       = array();
162         if ($this->groupmode == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $this->context)) {
163             $separategroups = true;
164             $mygroups = groups_get_user_groups($this->course->id);
165             $mygroups = $mygroups[0]; // ignore groupings
166             // reorder the groups fro better perf bellow
167             $current = array_search($this->currentgroup, $mygroups);
168             if ($current !== false) {
169                 unset($mygroups[$current]);
170                 array_unshift($mygroups, $this->currentgroup);
171             }
172         }
174         // always initialize all arrays
175         $queue = array();
176         foreach ($data as $varname => $postedvalue) {
178             $needsupdate = false;
180             // skip, not a grade nor feedback
181             if (strpos($varname, 'grade') === 0) {
182                 $datatype = 'grade';
183             } else if (strpos($varname, 'feedback') === 0) {
184                 $datatype = 'feedback';
185             } else {
186                 continue;
187             }
189             $gradeinfo = explode("_", $varname);
190             $userid = clean_param($gradeinfo[1], PARAM_INT);
191             $itemid = clean_param($gradeinfo[2], PARAM_INT);
193             $oldvalue = $data->{'old'.$varname};
195             // was change requested?
196             if ($oldvalue == $postedvalue) { // string comparison
197                 continue;
198             }
200             if (!$gradeitem = grade_item::fetch(array('id'=>$itemid, 'courseid'=>$this->courseid))) { // we must verify course id here!
201                 print_error('invalidgradeitmeid');
202             }
204             // Pre-process grade
205             if ($datatype == 'grade') {
206                 $feedback = false;
207                 $feedbackformat = false;
208                 if ($gradeitem->gradetype == GRADE_TYPE_SCALE) {
209                     if ($postedvalue == -1) { // -1 means no grade
210                         $finalgrade = null;
211                     } else {
212                         $finalgrade = $postedvalue;
213                     }
214                 } else {
215                     $finalgrade = unformat_float($postedvalue);
216                 }
218                 $errorstr = '';
219                 // Warn if the grade is out of bounds.
220                 if (is_null($finalgrade)) {
221                     // ok
222                 } else {
223                     $bounded = $gradeitem->bounded_grade($finalgrade);
224                     if ($bounded > $finalgrade) {
225                     $errorstr = 'lessthanmin';
226                     } else if ($bounded < $finalgrade) {
227                         $errorstr = 'morethanmax';
228                     }
229                 }
230                 if ($errorstr) {
231                     $user = $DB->get_record('user', array('id' => $userid), 'id, firstname, lastname');
232                     $gradestr = new stdClass();
233                     $gradestr->username = fullname($user);
234                     $gradestr->itemname = $gradeitem->get_name();
235                     $warnings[] = get_string($errorstr, 'grades', $gradestr);
236                 }
238             } else if ($datatype == 'feedback') {
239                 $finalgrade = false;
240                 $trimmed = trim($postedvalue);
241                 if (empty($trimmed)) {
242                      $feedback = NULL;
243                 } else {
244                      $feedback = $postedvalue;
245                 }
246             }
248             // group access control
249             if ($separategroups) {
250                 // note: we can not use $this->currentgroup because it would fail badly
251                 //       when having two browser windows each with different group
252                 $sharinggroup = false;
253                 foreach($mygroups as $groupid) {
254                     if (groups_is_member($groupid, $userid)) {
255                         $sharinggroup = true;
256                         break;
257                     }
258                 }
259                 if (!$sharinggroup) {
260                     // either group membership changed or somebody is hacking grades of other group
261                     $warnings[] = get_string('errorsavegrade', 'grades');
262                     continue;
263                 }
264             }
266             $gradeitem->update_final_grade($userid, $finalgrade, 'gradebook', $feedback, FORMAT_MOODLE);
267         }
269         return $warnings;
270     }
273     /**
274      * Setting the sort order, this depends on last state
275      * all this should be in the new table class that we might need to use
276      * for displaying grades.
277      */
278     private function setup_sortitemid() {
280         global $SESSION;
282         if ($this->sortitemid) {
283             if (!isset($SESSION->gradeuserreport->sort)) {
284                 if ($this->sortitemid == 'firstname' || $this->sortitemid == 'lastname') {
285                     $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC';
286                 } else {
287                     $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC';
288                 }
289             } else {
290                 // this is the first sort, i.e. by last name
291                 if (!isset($SESSION->gradeuserreport->sortitemid)) {
292                     if ($this->sortitemid == 'firstname' || $this->sortitemid == 'lastname') {
293                         $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC';
294                     } else {
295                         $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC';
296                     }
297                 } else if ($SESSION->gradeuserreport->sortitemid == $this->sortitemid) {
298                     // same as last sort
299                     if ($SESSION->gradeuserreport->sort == 'ASC') {
300                         $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC';
301                     } else {
302                         $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC';
303                     }
304                 } else {
305                     if ($this->sortitemid == 'firstname' || $this->sortitemid == 'lastname') {
306                         $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC';
307                     } else {
308                         $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC';
309                     }
310                 }
311             }
312             $SESSION->gradeuserreport->sortitemid = $this->sortitemid;
313         } else {
314             // not requesting sort, use last setting (for paging)
316             if (isset($SESSION->gradeuserreport->sortitemid)) {
317                 $this->sortitemid = $SESSION->gradeuserreport->sortitemid;
318             }else{
319                 $this->sortitemid = 'lastname';
320             }
322             if (isset($SESSION->gradeuserreport->sort)) {
323                 $this->sortorder = $SESSION->gradeuserreport->sort;
324             } else {
325                 $this->sortorder = 'ASC';
326             }
327         }
328     }
330     /**
331      * pulls out the userids of the users to be display, and sorts them
332      */
333     public function load_users() {
334         global $CFG, $DB;
336         //limit to users with a gradeable role
337         list($gradebookrolessql, $gradebookrolesparams) = $DB->get_in_or_equal(explode(',', $this->gradebookroles), SQL_PARAMS_NAMED, 'grbr0');
339         //limit to users with an active enrollment
340         list($enrolledsql, $enrolledparams) = get_enrolled_sql($this->context);
342         //fields we need from the user table
343         $userfields = user_picture::fields('u', array('idnumber'));     
345         //if the user has clicked one of the sort asc/desc arrows
346         if (is_numeric($this->sortitemid)) {
347             $params = array_merge(array('gitemid'=>$this->sortitemid), $gradebookrolesparams, $this->groupwheresql_params, $enrolledparams);
348             // the MAX() magic is required in order to please PG
349             $sort = "MAX(g.finalgrade) $this->sortorder";
351             $sql = "SELECT $userfields
352                       FROM {user} u
353                            JOIN ($enrolledsql) je ON je.id = u.id
354                            JOIN {role_assignments} ra ON ra.userid = u.id
355                            $this->groupsql
356                            LEFT JOIN {grade_grades} g ON (g.userid = u.id AND g.itemid = :gitemid)
357                      WHERE ra.roleid $gradebookrolessql
358                            AND u.deleted = 0
359                            AND ra.contextid ".get_related_contexts_string($this->context)."
360                            $this->groupwheresql
361                   GROUP BY $userfields
362                   ORDER BY $sort";
364         } else {
365             switch($this->sortitemid) {
366                 case 'lastname':
367                     $sort = "u.lastname $this->sortorder, u.firstname $this->sortorder"; break;
368                 case 'firstname':
369                     $sort = "u.firstname $this->sortorder, u.lastname $this->sortorder"; break;
370                 case 'idnumber':
371                 default:
372                     $sort = "u.idnumber $this->sortorder"; break;
373             }
375             $params = array_merge($gradebookrolesparams, $this->groupwheresql_params, $enrolledparams);
377             $sql = "SELECT DISTINCT $userfields
378                       FROM {user} u
379                            JOIN ($enrolledsql) je ON je.id = u.id
380                            JOIN {role_assignments} ra ON u.id = ra.userid
381                            $this->groupsql
382                      WHERE ra.roleid $gradebookrolessql 
383                            AND u.deleted = 0
384                            AND ra.contextid ".get_related_contexts_string($this->context)."
385                            $this->groupwheresql
386                   ORDER BY $sort";
387         }
390         $this->users = $DB->get_records_sql($sql, $params, $this->get_pref('studentsperpage') * $this->page, $this->get_pref('studentsperpage'));
392         if (empty($this->users)) {
393             $this->userselect = '';
394             $this->users = array();
395             $this->userselect_params = array();
396         } else {
397             list($usql, $params) = $DB->get_in_or_equal(array_keys($this->users), SQL_PARAMS_NAMED, 'usid0');
398             $this->userselect = "AND g.userid $usql";
399             $this->userselect_params = $params;
400         }
402         return $this->users;
403     }
405     /**
406      * we supply the userids in this query, and get all the grades
407      * pulls out all the grades, this does not need to worry about paging
408      */
409     public function load_final_grades() {
410         global $CFG, $DB;
412         // please note that we must fetch all grade_grades fields if we want to construct grade_grade object from it!
413         $params = array_merge(array('courseid'=>$this->courseid), $this->userselect_params);
414         $sql = "SELECT g.*
415                   FROM {grade_items} gi,
416                        {grade_grades} g
417                  WHERE g.itemid = gi.id AND gi.courseid = :courseid {$this->userselect}";
419         $userids = array_keys($this->users);
422         if ($grades = $DB->get_records_sql($sql, $params)) {
423             foreach ($grades as $graderec) {
424                 if (in_array($graderec->userid, $userids) and array_key_exists($graderec->itemid, $this->gtree->get_items())) { // some items may not be present!!
425                     $this->grades[$graderec->userid][$graderec->itemid] = new grade_grade($graderec, false);
426                     $this->grades[$graderec->userid][$graderec->itemid]->grade_item =& $this->gtree->get_item($graderec->itemid); // db caching
427                 }
428             }
429         }
431         // prefil grades that do not exist yet
432         foreach ($userids as $userid) {
433             foreach ($this->gtree->get_items() as $itemid=>$unused) {
434                 if (!isset($this->grades[$userid][$itemid])) {
435                     $this->grades[$userid][$itemid] = new grade_grade();
436                     $this->grades[$userid][$itemid]->itemid = $itemid;
437                     $this->grades[$userid][$itemid]->userid = $userid;
438                     $this->grades[$userid][$itemid]->grade_item =& $this->gtree->get_item($itemid); // db caching
439                 }
440             }
441         }
442     }
444     /**
445      * Builds and returns a div with on/off toggles.
446      * @return string HTML code
447      */
448     public function get_toggles_html() {
449         global $CFG, $USER, $COURSE, $OUTPUT;
451         $html = '';
452         if ($USER->gradeediting[$this->courseid]) {
453             if (has_capability('moodle/grade:manage', $this->context) or has_capability('moodle/grade:hide', $this->context)) {
454                 $html .= $this->print_toggle('eyecons');
455             }
456             if (has_capability('moodle/grade:manage', $this->context)
457              or has_capability('moodle/grade:lock', $this->context)
458              or has_capability('moodle/grade:unlock', $this->context)) {
459                 $html .= $this->print_toggle('locks');
460             }
461             if (has_capability('moodle/grade:manage', $this->context)) {
462                 $html .= $this->print_toggle('quickfeedback');
463             }
465             if (has_capability('moodle/grade:manage', $this->context)) {
466                 $html .= $this->print_toggle('calculations');
467             }
468         }
470         if ($this->canviewhidden) {
471             $html .= $this->print_toggle('averages');
472         }
474         $html .= $this->print_toggle('ranges');
475         if (!empty($CFG->enableoutcomes)) {
476             $html .= $this->print_toggle('nooutcomes');
477         }
479         return $OUTPUT->container($html, 'grade-report-toggles');
480     }
482     /**
483     * Shortcut function for printing the grader report toggles.
484     * @param string $type The type of toggle
485     * @param bool $return Whether to return the HTML string rather than printing it
486     * @return void
487     */
488     public function print_toggle($type) {
489         global $CFG, $OUTPUT;
491         $icons = array('eyecons' => 't/hide',
492                        'calculations' => 't/calc',
493                        'locks' => 't/lock',
494                        'averages' => 't/mean',
495                        'quickfeedback' => 't/feedback',
496                        'nooutcomes' => 't/outcomes');
498         $prefname = 'grade_report_show' . $type;
500         if (array_key_exists($prefname, $CFG)) {
501             $showpref = get_user_preferences($prefname, $CFG->$prefname);
502         } else {
503             $showpref = get_user_preferences($prefname);
504         }
506         $strshow = $this->get_lang_string('show' . $type, 'grades');
507         $strhide = $this->get_lang_string('hide' . $type, 'grades');
509         $showhide = 'show';
510         $toggleaction = 1;
512         if ($showpref) {
513             $showhide = 'hide';
514             $toggleaction = 0;
515         }
517         if (array_key_exists($type, $icons)) {
518             $imagename = $icons[$type];
519         } else {
520             $imagename = "t/$type";
521         }
523         $string = ${'str' . $showhide};
525         $url = new moodle_url($this->baseurl, array('toggle' => $toggleaction, 'toggle_type' => $type));
527         $retval = $OUTPUT->container($OUTPUT->action_icon($url, new pix_icon($imagename, $string))); // TODO: this container looks wrong here
529         return $retval;
530     }
532     /**
533      * Builds and returns the rows that will make up the left part of the grader report
534      * This consists of student names and icons, links to user reports and id numbers, as well
535      * as header cells for these columns. It also includes the fillers required for the
536      * categories displayed on the right side of the report.
537      * @return array Array of html_table_row objects
538      */
539     public function get_left_rows() {
540         global $CFG, $USER, $OUTPUT;
542         $rows = array();
544         $showuserimage = $this->get_pref('showuserimage');
545         $showuseridnumber = $this->get_pref('showuseridnumber');
546         $fixedstudents = $this->is_fixed_students();
548         $strfeedback  = $this->get_lang_string("feedback");
549         $strgrade     = $this->get_lang_string('grade');
551         $arrows = $this->get_sort_arrows();
553         $colspan = 1;
555         if (has_capability('gradereport/'.$CFG->grade_profilereport.':view', $this->context)) {
556             $colspan++;
557         }
559         if ($showuseridnumber) {
560             $colspan++;
561         }
563         $levels = count($this->gtree->levels) - 1;
565         for ($i = 0; $i < $levels; $i++) {
566             $fillercell = new html_table_cell();
567             $fillercell->attributes['class'] = 'fixedcolumn cell topleft';
568             $fillercell->text = ' ';
569             $fillercell->colspan = $colspan;
570             $row = new html_table_row(array($fillercell));
571             $rows[] = $row;
572         }
574         $headerrow = new html_table_row();
575         $headerrow->attributes['class'] = 'heading';
577         $studentheader = new html_table_cell();
578         $studentheader->attributes['class'] = 'header';
579         $studentheader->scope = 'col';
580         $studentheader->header = true;
581         $studentheader->id = 'studentheader';
582         if (has_capability('gradereport/'.$CFG->grade_profilereport.':view', $this->context)) {
583             $studentheader->colspan = 2;
584         }
585         $studentheader->text = $arrows['studentname'];
587         $headerrow->cells[] = $studentheader;
589         if ($showuseridnumber) {
590             // TODO: weird, this is not used anywhere
591             $sortidnumberlink = html_writer::link(new moodle_url($this->baseurl, array('sortitemid'=>'idnumber')), get_string('idnumber'));
593             $idnumberheader = new html_table_cell();
594             $idnumberheader->attributes['class'] = 'header useridnumber';
595             $idnumberheader->scope = 'col';
596             $idnumberheader->header = true;
597             $idnumberheader->text = $arrows['idnumber'];
599             $headerrow->cells[] = $idnumberheader;
600         }
602         $rows[] = $headerrow;
604         $rows = $this->get_left_icons_row($rows, $colspan);
606         $rowclasses = array('even', 'odd');
608         foreach ($this->users as $userid => $user) {
609             $userrow = new html_table_row();
610             $userrow->id = 'fixed_user_'.$userid;
611             $userrow->attributes['class'] = 'r'.$this->rowcount++.' '.$rowclasses[$this->rowcount % 2];
613             $usercell = new html_table_cell();
614             $usercell->attributes['class'] = 'user';
615             $usercell->header = true;
616             $usercell->scope = 'row';
618             if ($showuserimage) {
619                 $usercell->text = $OUTPUT->container($OUTPUT->user_picture($user), 'userpic');
620             }
622             $usercell->text .= html_writer::link(new moodle_url('/user/view.php', array('id' => $user->id, 'course' => $this->course->id)), fullname($user));
624             $userrow->cells[] = $usercell;
626             if (has_capability('gradereport/'.$CFG->grade_profilereport.':view', $this->context)) {
627                 $userreportcell = new html_table_cell();
628                 $userreportcell->attributes['class'] = 'userreport';
629                 $userreportcell->header = true;
630                 $a = new stdClass();
631                 $a->user = fullname($user);
632                 $strgradesforuser = get_string('gradesforuser', 'grades', $a);
633                 $url = new moodle_url('/grade/report/'.$CFG->grade_profilereport.'/index.php', array('userid' => $user->id, 'id' => $this->course->id));
634                 $userreportcell->text = $OUTPUT->action_icon($url, new pix_icon('t/grades', $strgradesforuser));
635                 $userrow->cells[] = $userreportcell;
636             }
638             if ($showuseridnumber) {
639                 $idnumbercell = new html_table_cell();
640                 $idnumbercell->attributes['class'] = 'header useridnumber';
641                 $idnumbercell->header = true;
642                 $idnumbercell->scope = 'row';
643                 $idnumbercell->text = $user->idnumber;
644                 $userrow->cells[] = $idnumbercell;
645             }
647             $rows[] = $userrow;
648         }
650         $rows = $this->get_left_range_row($rows, $colspan);
651         $rows = $this->get_left_avg_row($rows, $colspan, true);
652         $rows = $this->get_left_avg_row($rows, $colspan);
654         return $rows;
655     }
657     /**
658      * Builds and returns the rows that will make up the right part of the grader report
659      * @return array Array of html_table_row objects
660      */
661     public function get_right_rows() {
662         global $CFG, $USER, $OUTPUT, $DB, $PAGE;
664         $rows = array();
665         $this->rowcount = 0;
666         $numrows = count($this->gtree->get_levels());
667         $numusers = count($this->users);
668         $gradetabindex = 1;
669         $columnstounset = array();
670         $strgrade = $this->get_lang_string('grade');
671         $strfeedback  = $this->get_lang_string("feedback");
672         $arrows = $this->get_sort_arrows();
674         $jsarguments = array(
675             'id'        => '#fixed_column',
676             'cfg'       => array('ajaxenabled'=>false),
677             'items'     => array(),
678             'users'     => array(),
679             'feedback'  => array()
680         );
681         $jsscales = array();
683         foreach ($this->gtree->get_levels() as $key=>$row) {
684             if ($key == 0) {
685                 // do not display course grade category
686                 // continue;
687             }
689             $headingrow = new html_table_row();
690             $headingrow->attributes['class'] = 'heading_name_row';
692             foreach ($row as $columnkey => $element) {
693                 $sortlink = clone($this->baseurl);
694                 if (isset($element['object']->id)) {
695                     $sortlink->param('sortitemid', $element['object']->id);
696                 }
698                 $eid    = $element['eid'];
699                 $object = $element['object'];
700                 $type   = $element['type'];
701                 $categorystate = @$element['categorystate'];
703                 if (!empty($element['colspan'])) {
704                     $colspan = $element['colspan'];
705                 } else {
706                     $colspan = 1;
707                 }
709                 if (!empty($element['depth'])) {
710                     $catlevel = 'catlevel'.$element['depth'];
711                 } else {
712                     $catlevel = '';
713                 }
715 // Element is a filler
716                 if ($type == 'filler' or $type == 'fillerfirst' or $type == 'fillerlast') {
717                     $fillercell = new html_table_cell();
718                     $fillercell->attributes['class'] = $type . ' ' . $catlevel;
719                     $fillercell->colspan = $colspan;
720                     $fillercell->text = '&nbsp;';
721                     $fillercell->header = true;
722                     $fillercell->scope = 'col';
723                     $headingrow->cells[] = $fillercell;
724                 }
725 // Element is a category
726                 else if ($type == 'category') {
727                     $categorycell = new html_table_cell();
728                     $categorycell->attributes['class'] = 'category ' . $catlevel;
729                     $categorycell->colspan = $colspan;
730                     $categorycell->text = shorten_text($element['object']->get_name());
731                     $categorycell->text .= $this->get_collapsing_icon($element);
732                     $categorycell->header = true;
733                     $categorycell->scope = 'col';
735                     // Print icons
736                     if ($USER->gradeediting[$this->courseid]) {
737                         $categorycell->text .= $this->get_icons($element);
738                     }
740                     $headingrow->cells[] = $categorycell;
741                 }
742 // Element is a grade_item
743                 else {
744                     //$itemmodule = $element['object']->itemmodule;
745                     //$iteminstance = $element['object']->iteminstance;
747                     if ($element['object']->id == $this->sortitemid) {
748                         if ($this->sortorder == 'ASC') {
749                             $arrow = $this->get_sort_arrow('up', $sortlink);
750                         } else {
751                             $arrow = $this->get_sort_arrow('down', $sortlink);
752                         }
753                     } else {
754                         $arrow = $this->get_sort_arrow('move', $sortlink);
755                     }
757                     $headerlink = $this->gtree->get_element_header($element, true, $this->get_pref('showactivityicons'), false);
759                     $itemcell = new html_table_cell();
760                     $itemcell->attributes['class'] = $type . ' ' . $catlevel . 'highlightable';
762                     if ($element['object']->is_hidden()) {
763                         $itemcell->attributes['class'] .= ' hidden';
764                     }
766                     $itemcell->colspan = $colspan;
767                     $itemcell->text = shorten_text($headerlink) . $arrow;
768                     $itemcell->header = true;
769                     $itemcell->scope = 'col';
771                     $headingrow->cells[] = $itemcell;
772                 }
773             }
774             $rows[] = $headingrow;
775         }
777         $rows = $this->get_right_icons_row($rows);
779         // Preload scale objects for items with a scaleid
780         $scaleslist = array();
781         $tabindices = array();
783         foreach ($this->gtree->get_items() as $itemid=>$item) {
784             $scale = null;
785             if (!empty($item->scaleid)) {
786                 $scaleslist[] = $item->scaleid;
787                 $jsarguments['items'][$itemid] = array('id'=>$itemid, 'name'=>$item->get_name(true), 'type'=>'scale', 'scale'=>$item->scaleid, 'decimals'=>$item->get_decimals());
788             } else {
789                 $jsarguments['items'][$itemid] = array('id'=>$itemid, 'name'=>$item->get_name(true), 'type'=>'value', 'scale'=>false, 'decimals'=>$item->get_decimals());
790             }
791             $tabindices[$item->id]['grade'] = $gradetabindex;
792             $tabindices[$item->id]['feedback'] = $gradetabindex + $numusers;
793             $gradetabindex += $numusers * 2;
794         }
795         $scalesarray = array();
797         if (!empty($scaleslist)) {
798             $scalesarray = $DB->get_records_list('scale', 'id', $scaleslist);
799         }
800         $jsscales = $scalesarray;
802         $rowclasses = array('even', 'odd');
804         foreach ($this->users as $userid => $user) {
806             if ($this->canviewhidden) {
807                 $altered = array();
808                 $unknown = array();
809             } else {
810                 $hidingaffected = grade_grade::get_hiding_affected($this->grades[$userid], $this->gtree->get_items());
811                 $altered = $hidingaffected['altered'];
812                 $unknown = $hidingaffected['unknown'];
813                 unset($hidingaffected);
814             }
817             $itemrow = new html_table_row();
818             $itemrow->id = 'user_'.$userid;
819             $itemrow->attributes['class'] = $rowclasses[$this->rowcount % 2];
821             $jsarguments['users'][$userid] = fullname($user);
823             foreach ($this->gtree->items as $itemid=>$unused) {
824                 $item =& $this->gtree->items[$itemid];
825                 $grade = $this->grades[$userid][$item->id];
827                 $itemcell = new html_table_cell();
829                 $itemcell->id = 'u'.$userid.'i'.$itemid;
831                 // Get the decimal points preference for this item
832                 $decimalpoints = $item->get_decimals();
834                 if (in_array($itemid, $unknown)) {
835                     $gradeval = null;
836                 } else if (array_key_exists($itemid, $altered)) {
837                     $gradeval = $altered[$itemid];
838                 } else {
839                     $gradeval = $grade->finalgrade;
840                 }
842                 // MDL-11274
843                 // Hide grades in the grader report if the current grader doesn't have 'moodle/grade:viewhidden'
844                 if (!$this->canviewhidden and $grade->is_hidden()) {
845                     if (!empty($CFG->grade_hiddenasdate) and $grade->get_datesubmitted() and !$item->is_category_item() and !$item->is_course_item()) {
846                         // 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
847                         $itemcell->text = html_writer::tag('span', userdate($grade->get_datesubmitted(),get_string('strftimedatetimeshort')), array('class'=>'datesubmitted'));
848                     } else {
849                         $itemcell->text = '-';
850                     }
851                     $itemrow->cells[] = $itemcell;
852                     continue;
853                 }
855                 // emulate grade element
856                 $eid = $this->gtree->get_grade_eid($grade);
857                 $element = array('eid'=>$eid, 'object'=>$grade, 'type'=>'grade');
859                 $itemcell->attributes['class'] .= ' grade';
860                 if ($item->is_category_item()) {
861                     $itemcell->attributes['class'] .= ' cat';
862                 }
863                 if ($item->is_course_item()) {
864                     $itemcell->attributes['class'] .= ' course';
865                 }
866                 if ($grade->is_overridden()) {
867                     $itemcell->attributes['class'] .= ' overridden';
868                 }
870                 if ($grade->is_excluded()) {
871                     // $itemcell->attributes['class'] .= ' excluded';
872                 }
874                 if (!empty($grade->feedback)) {
875                     //should we be truncating feedback? ie $short_feedback = shorten_text($feedback, $this->feedback_trunc_length);
876                     $jsarguments['feedback'][] = array('user'=>$userid, 'item'=>$itemid, 'content'=>wordwrap(trim(format_string($grade->feedback, $grade->feedbackformat)), 34, '<br/ >'));
877                 }
879                 if ($grade->is_excluded()) {
880                     $itemcell->text .= html_writer::tag('span', get_string('excluded', 'grades'), array('class'=>'excludedfloater'));
881                 }
883                 // Do not show any icons if no grade (no record in DB to match)
884                 if (!$item->needsupdate and $USER->gradeediting[$this->courseid]) {
885                     $itemcell->text .= $this->get_icons($element);
886                 }
888                 $hidden = '';
889                 if ($grade->is_hidden()) {
890                     $hidden = ' hidden ';
891                 }
893                 $gradepass = ' gradefail ';
894                 if ($grade->is_passed($item)) {
895                     $gradepass = ' gradepass ';
896                 } elseif (is_null($grade->is_passed($item))) {
897                     $gradepass = '';
898                 }
900                 // if in editing mode, we need to print either a text box
901                 // or a drop down (for scales)
902                 // grades in item of type grade category or course are not directly editable
903                 if ($item->needsupdate) {
904                     $itemcell->text .= html_writer::tag('span', get_string('error'), array('class'=>"gradingerror$hidden"));
906                 } else if ($USER->gradeediting[$this->courseid]) {
908                     if ($item->scaleid && !empty($scalesarray[$item->scaleid])) {
909                         $scale = $scalesarray[$item->scaleid];
910                         $gradeval = (int)$gradeval; // scales use only integers
911                         $scales = explode(",", $scale->scale);
912                         // reindex because scale is off 1
914                         // MDL-12104 some previous scales might have taken up part of the array
915                         // so this needs to be reset
916                         $scaleopt = array();
917                         $i = 0;
918                         foreach ($scales as $scaleoption) {
919                             $i++;
920                             $scaleopt[$i] = $scaleoption;
921                         }
923                         if ($this->get_pref('quickgrading') and $grade->is_editable()) {
924                             $oldval = empty($gradeval) ? -1 : $gradeval;
925                             if (empty($item->outcomeid)) {
926                                 $nogradestr = $this->get_lang_string('nograde');
927                             } else {
928                                 $nogradestr = $this->get_lang_string('nooutcome', 'grades');
929                             }
930                             $itemcell->text .= '<input type="hidden" id="oldgrade_'.$userid.'_'.$item->id.'" name="oldgrade_'.$userid.'_'.$item->id.'" value="'.$oldval.'"/>';
931                             $attributes = array('tabindex' => $tabindices[$item->id]['grade'], 'id'=>'grade_'.$userid.'_'.$item->id);
932                             $itemcell->text .= html_writer::select($scaleopt, 'grade_'.$userid.'_'.$item->id, $gradeval, array(-1=>$nogradestr), $attributes);;
933                         } elseif(!empty($scale)) {
934                             $scales = explode(",", $scale->scale);
936                             // invalid grade if gradeval < 1
937                             if ($gradeval < 1) {
938                                 $itemcell->text .= html_writer::tag('span', '-', array('class'=>"gradevalue$hidden$gradepass"));
939                             } else {
940                                 $gradeval = $grade->grade_item->bounded_grade($gradeval); //just in case somebody changes scale
941                                 $itemcell->text .= html_writer::tag('span', $scales[$gradeval-1], array('class'=>"gradevalue$hidden$gradepass"));
942                             }
943                         } else {
944                             // no such scale, throw error?
945                         }
947                     } else if ($item->gradetype != GRADE_TYPE_TEXT) { // Value type
948                         if ($this->get_pref('quickgrading') and $grade->is_editable()) {
949                             $value = format_float($gradeval, $decimalpoints);
950                             $itemcell->text .= '<input type="hidden" id="oldgrade_'.$userid.'_'.$item->id.'" name="oldgrade_'.$userid.'_'.$item->id.'" value="'.$value.'" />';
951                             $itemcell->text .= '<input size="6" tabindex="' . $tabindices[$item->id]['grade']
952                                           . '" type="text" class="text" title="'. $strgrade .'" name="grade_'
953                                           .$userid.'_' .$item->id.'" id="grade_'.$userid.'_'.$item->id.'" value="'.$value.'" />';
954                         } else {
955                             $itemcell->text .= html_writer::tag('span', format_float($gradeval, $decimalpoints), array('class'=>"gradevalue$hidden$gradepass"));
956                         }
957                     }
960                     // If quickfeedback is on, print an input element
961                     if ($this->get_pref('showquickfeedback') and $grade->is_editable()) {
963                         $itemcell->text .= '<input type="hidden" id="oldfeedback_'.$userid.'_'.$item->id.'" name="oldfeedback_'.$userid.'_'.$item->id.'" value="' . s($grade->feedback) . '" />';
964                         $itemcell->text .= '<input class="quickfeedback" tabindex="' . $tabindices[$item->id]['feedback'].'" id="feedback_'.$userid.'_'.$item->id
965                                       . '" size="6" title="' . $strfeedback . '" type="text" name="feedback_'.$userid.'_'.$item->id.'" value="' . s($grade->feedback) . '" />';
966                     }
968                 } else { // Not editing
969                     $gradedisplaytype = $item->get_displaytype();
971                     if ($item->scaleid && !empty($scalesarray[$item->scaleid])) {
972                         $itemcell->attributes['class'] .= ' grade_type_scale';
973                     } else if ($item->gradetype != GRADE_TYPE_TEXT) {
974                         $itemcell->attributes['class'] .= ' grade_type_text';
975                     }
977                     if ($this->get_pref('enableajax')) {
978                         $itemcell->attributes['class'] .= ' clickable';
979                     }
981                     if ($item->needsupdate) {
982                         $itemcell->text .= html_writer::tag('span', get_string('error'), array('class'=>"gradingerror$hidden$gradepass"));
983                     } else {
984                         $itemcell->text .= html_writer::tag('span', grade_format_gradevalue($gradeval, $item, true, $gradedisplaytype, null), array('class'=>"gradevalue$hidden$gradepass"));
985                     }
986                 }
988                 if (!empty($this->gradeserror[$item->id][$userid])) {
989                     $itemcell->text .= $this->gradeserror[$item->id][$userid];
990                 }
992                 $itemrow->cells[] = $itemcell;
993             }
994             $rows[] = $itemrow;
995         }
997         if ($this->get_pref('enableajax')) {
998             $jsarguments['cfg']['ajaxenabled'] = true;
999             $jsarguments['cfg']['scales'] = array();
1000             foreach ($jsscales as $scale) {
1001                 $jsarguments['cfg']['scales'][$scale->id] = explode(',',$scale->scale);
1002             }
1003             $jsarguments['cfg']['feedbacktrunclength'] =  $this->feedback_trunc_length;
1005             //feedbacks are now being stored in $jsarguments['feedback'] in get_right_rows()
1006             //$jsarguments['cfg']['feedback'] =  $this->feedbacks;
1007         }
1008         $jsarguments['cfg']['isediting'] = (bool)$USER->gradeediting[$this->courseid];
1009         $jsarguments['cfg']['courseid'] =  $this->courseid;
1010         $jsarguments['cfg']['studentsperpage'] =  $this->get_pref('studentsperpage');
1011         $jsarguments['cfg']['showquickfeedback'] =  (bool)$this->get_pref('showquickfeedback');
1013         $module = array(
1014             'name'      => 'gradereport_grader',
1015             'fullpath'  => '/grade/report/grader/module.js',
1016             'requires'  => array('base', 'dom', 'event', 'event-mouseenter', 'event-key', 'io', 'json-parse', 'overlay')
1017         );
1018         $PAGE->requires->js_init_call('M.gradereport_grader.init_report', $jsarguments, false, $module);
1019         $PAGE->requires->strings_for_js(array('addfeedback','feedback', 'grade'), 'grades');
1020         $PAGE->requires->strings_for_js(array('ajaxchoosescale','ajaxclicktoclose','ajaxerror','ajaxfailedupdate', 'ajaxfieldchanged'), 'gradereport_grader');
1022         $rows = $this->get_right_range_row($rows);
1023         $rows = $this->get_right_avg_row($rows, true);
1024         $rows = $this->get_right_avg_row($rows);
1026         return $rows;
1027     }
1029     /**
1030      * Depending on the style of report (fixedstudents vs traditional one-table),
1031      * arranges the rows of data in one or two tables, and returns the output of
1032      * these tables in HTML
1033      * @return string HTML
1034      */
1035     public function get_grade_table() {
1036         global $OUTPUT;
1037         $fixedstudents = $this->is_fixed_students();
1039         $leftrows = $this->get_left_rows();
1040         $rightrows = $this->get_right_rows();
1042         $html = '';
1045         if ($fixedstudents) {
1046             $fixedcolumntable = new html_table();
1047             $fixedcolumntable->id = 'fixed_column';
1048             $fixedcolumntable->data = $leftrows;
1049             $html .= $OUTPUT->container(html_writer::table($fixedcolumntable), 'left_scroller');
1051             $righttable = new html_table();
1052             $righttable->id = 'user-grades';
1053             $righttable->data = $rightrows;
1055             $html .= $OUTPUT->container(html_writer::table($righttable), 'right_scroller');
1056         } else {
1057             $fulltable = new html_table();
1058             $fulltable->attributes['class'] = 'gradestable flexible boxaligncenter generaltable';
1059             $fulltable->id = 'user-grades';
1061             // Extract rows from each side (left and right) and collate them into one row each
1062             foreach ($leftrows as $key => $row) {
1063                 $row->cells = array_merge($row->cells, $rightrows[$key]->cells);
1064                 $fulltable->data[] = $row;
1065             }
1066             $html .= html_writer::table($fulltable);
1067         }
1068         return $OUTPUT->container($html, 'gradeparent');
1069     }
1071     /**
1072      * Builds and return the row of icons for the left side of the report.
1073      * It only has one cell that says "Controls"
1074      * @param array $rows The Array of rows for the left part of the report
1075      * @param int $colspan The number of columns this cell has to span
1076      * @return array Array of rows for the left part of the report
1077      */
1078     public function get_left_icons_row($rows=array(), $colspan=1) {
1079         global $USER;
1081         if ($USER->gradeediting[$this->courseid]) {
1082             $controlsrow = new html_table_row();
1083             $controlsrow->attributes['class'] = 'controls';
1084             $controlscell = new html_table_cell();
1085             $controlscell->attributes['class'] = 'header controls';
1086             $controlscell->colspan = $colspan;
1087             $controlscell->text = $this->get_lang_string('controls','grades');
1089             $controlsrow->cells[] = $controlscell;
1090             $rows[] = $controlsrow;
1091         }
1092         return $rows;
1093     }
1095     /**
1096      * Builds and return the header for the row of ranges, for the left part of the grader report.
1097      * @param array $rows The Array of rows for the left part of the report
1098      * @param int $colspan The number of columns this cell has to span
1099      * @return array Array of rows for the left part of the report
1100      */
1101     public function get_left_range_row($rows=array(), $colspan=1) {
1102         global $CFG, $USER;
1104         if ($this->get_pref('showranges')) {
1105             $rangerow = new html_table_row();
1106             $rangerow->attributes['class'] = 'range r'.$this->rowcount++;
1107             $rangecell = new html_table_cell();
1108             $rangecell->attributes['class'] = 'header range';
1109             $rangecell->colspan = $colspan;
1110             $rangecell->header = true;
1111             $rangecell->scope = 'row';
1112             $rangecell->text = $this->get_lang_string('range','grades');
1113             $rangerow->cells[] = $rangecell;
1114             $rows[] = $rangerow;
1115         }
1117         return $rows;
1118     }
1120     /**
1121      * Builds and return the headers for the rows of averages, for the left part of the grader report.
1122      * @param array $rows The Array of rows for the left part of the report
1123      * @param int $colspan The number of columns this cell has to span
1124      * @param bool $groupavg If true, returns the row for group averages, otherwise for overall averages
1125      * @return array Array of rows for the left part of the report
1126      */
1127     public function get_left_avg_row($rows=array(), $colspan=1, $groupavg=false) {
1128         if (!$this->canviewhidden) {
1129             // totals might be affected by hiding, if user can not see hidden grades the aggregations might be altered
1130             // better not show them at all if user can not see all hideen grades
1131             return $rows;
1132         }
1134         $showaverages = $this->get_pref('showaverages');
1135         $showaveragesgroup = $this->currentgroup && $showaverages;
1136         $straveragegroup = get_string('groupavg', 'grades');
1138         if ($groupavg) {
1139             if ($showaveragesgroup) {
1140                 $groupavgrow = new html_table_row();
1141                 $groupavgrow->attributes['class'] = 'groupavg r'.$this->rowcount++;
1142                 $groupavgcell = new html_table_cell();
1143                 $groupavgcell->attributes['class'] = 'header range';
1144                 $groupavgcell->colspan = $colspan;
1145                 $groupavgcell->header = true;
1146                 $groupavgcell->scope = 'row';
1147                 $groupavgcell->text = $straveragegroup;
1148                 $groupavgrow->cells[] = $groupavgcell;
1149                 $rows[] = $groupavgrow;
1150             }
1151         } else {
1152             $straverage = get_string('overallaverage', 'grades');
1154             if ($showaverages) {
1155                 $avgrow = new html_table_row();
1156                 $avgrow->attributes['class'] = 'avg r'.$this->rowcount++;
1157                 $avgcell = new html_table_cell();
1158                 $avgcell->attributes['class'] = 'header range';
1159                 $avgcell->colspan = $colspan;
1160                 $avgcell->header = true;
1161                 $avgcell->scope = 'row';
1162                 $avgcell->text = $straverage;
1163                 $avgrow->cells[] = $avgcell;
1164                 $rows[] = $avgrow;
1165             }
1166         }
1168         return $rows;
1169     }
1171     /**
1172      * Builds and return the row of icons when editing is on, for the right part of the grader report.
1173      * @param array $rows The Array of rows for the right part of the report
1174      * @return array Array of rows for the right part of the report
1175      */
1176     public function get_right_icons_row($rows=array()) {
1177         global $USER;
1178         if ($USER->gradeediting[$this->courseid]) {
1179             $iconsrow = new html_table_row();
1180             $iconsrow->attributes['class'] = 'controls';
1182             $showuseridnumber = $this->get_pref('showuseridnumber');
1184             foreach ($this->gtree->items as $itemid=>$unused) {
1185                 // emulate grade element
1186                 $item =& $this->gtree->get_item($itemid);
1188                 $eid = $this->gtree->get_item_eid($item);
1189                 $element = $this->gtree->locate_element($eid);
1190                 $itemcell = new html_table_cell();
1191                 $itemcell->attributes['class'] = 'controls icons';
1192                 $itemcell->text = $this->get_icons($element);
1193                 $iconsrow->cells[] = $itemcell;
1194             }
1195             $rows[] = $iconsrow;
1196         }
1197         return $rows;
1198     }
1200     /**
1201      * Builds and return the row of ranges for the right part of the grader report.
1202      * @param array $rows The Array of rows for the right part of the report
1203      * @return array Array of rows for the right part of the report
1204      */
1205     public function get_right_range_row($rows=array()) {
1206         global $OUTPUT;
1208         if ($this->get_pref('showranges')) {
1209             $rangesdisplaytype   = $this->get_pref('rangesdisplaytype');
1210             $rangesdecimalpoints = $this->get_pref('rangesdecimalpoints');
1211             $rangerow = new html_table_row();
1212             $rangerow->attributes['class'] = 'heading range';
1214             foreach ($this->gtree->items as $itemid=>$unused) {
1215                 $item =& $this->gtree->items[$itemid];
1216                 $itemcell = new html_table_cell();
1217                 $itemcell->header = true;
1218                 $itemcell->attributes['class'] .= ' header range';
1220                 $hidden = '';
1221                 if ($item->is_hidden()) {
1222                     $hidden = ' hidden ';
1223                 }
1225                 $formattedrange = $item->get_formatted_range($rangesdisplaytype, $rangesdecimalpoints);
1227                 $itemcell->text = $OUTPUT->container($formattedrange, 'rangevalues'.$hidden);
1228                 $rangerow->cells[] = $itemcell;
1229             }
1230             $rows[] = $rangerow;
1231         }
1232         return $rows;
1233     }
1235     /**
1236      * Builds and return the row of averages for the right part of the grader report.
1237      * @param array $rows Whether to return only group averages or all averages.
1238      * @param bool $grouponly Whether to return only group averages or all averages.
1239      * @return array Array of rows for the right part of the report
1240      */
1241     public function get_right_avg_row($rows=array(), $grouponly=false) {
1242         global $CFG, $USER, $DB, $OUTPUT;
1244         if (!$this->canviewhidden) {
1245             // totals might be affected by hiding, if user can not see hidden grades the aggregations might be altered
1246             // better not show them at all if user can not see all hidden grades
1247             return $rows;
1248         }
1250         $showaverages = $this->get_pref('showaverages');
1251         $showaveragesgroup = $this->currentgroup && $showaverages;
1253         $averagesdisplaytype   = $this->get_pref('averagesdisplaytype');
1254         $averagesdecimalpoints = $this->get_pref('averagesdecimalpoints');
1255         $meanselection         = $this->get_pref('meanselection');
1256         $shownumberofgrades    = $this->get_pref('shownumberofgrades');
1258         $avghtml = '';
1259         $avgcssclass = 'avg';
1261         if ($grouponly) {
1262             $straverage = get_string('groupavg', 'grades');
1263             $showaverages = $this->currentgroup && $this->get_pref('showaverages');
1264             $groupsql = $this->groupsql;
1265             $groupwheresql = $this->groupwheresql;
1266             $groupwheresqlparams = $this->groupwheresql_params;
1267             $avgcssclass = 'groupavg';
1268         } else {
1269             $straverage = get_string('overallaverage', 'grades');
1270             $showaverages = $this->get_pref('showaverages');
1271             $groupsql = "";
1272             $groupwheresql = "";
1273             $groupwheresqlparams = array();
1274         }
1276         if ($shownumberofgrades) {
1277             $straverage .= ' (' . get_string('submissions', 'grades') . ') ';
1278         }
1280         $totalcount = $this->get_numusers($grouponly);
1282         //limit to users with a gradeable role
1283         list($gradebookrolessql, $gradebookrolesparams) = $DB->get_in_or_equal(explode(',', $this->gradebookroles), SQL_PARAMS_NAMED, 'grbr0');
1285         //limit to users with an active enrollment
1286         list($enrolledsql, $enrolledparams) = get_enrolled_sql($this->context);
1288         if ($showaverages) {
1289             $params = array_merge(array('courseid'=>$this->courseid), $gradebookrolesparams, $enrolledparams, $groupwheresqlparams);
1291             // find sums of all grade items in course
1292             $SQL = "SELECT g.itemid, SUM(g.finalgrade) AS sum
1293                       FROM {grade_items} gi
1294                            JOIN {grade_grades} g      ON g.itemid = gi.id
1295                            JOIN {user} u              ON u.id = g.userid
1296                            JOIN ($enrolledsql) je ON je.id = u.id
1297                            JOIN {role_assignments} ra ON ra.userid = u.id
1298                            $groupsql
1299                      WHERE gi.courseid = :courseid
1300                            AND ra.roleid $gradebookrolessql
1301                            AND ra.contextid ".get_related_contexts_string($this->context)."
1302                            AND g.finalgrade IS NOT NULL
1303                            $groupwheresql
1304                   GROUP BY g.itemid";
1305             $sumarray = array();
1306             if ($sums = $DB->get_records_sql($SQL, $params)) {
1307                 foreach ($sums as $itemid => $csum) {
1308                     $sumarray[$itemid] = $csum->sum;
1309                 }
1310             }
1312             // MDL-10875 Empty grades must be evaluated as grademin, NOT always 0
1313             // This query returns a count of ungraded grades (NULL finalgrade OR no matching record in grade_grades table)
1314             $SQL = "SELECT gi.id, COUNT(u.id) AS count
1315                       FROM {grade_items} gi
1316                            CROSS JOIN {user} u
1317                            JOIN ($enrolledsql) je ON je.id = u.id
1318                            JOIN {role_assignments} ra        ON ra.userid = u.id
1319                            LEFT OUTER JOIN  {grade_grades} g ON (g.itemid = gi.id AND g.userid = u.id AND g.finalgrade IS NOT NULL)
1320                            $groupsql
1321                      WHERE gi.courseid = :courseid
1322                            AND ra.roleid $gradebookrolessql
1323                            AND ra.contextid ".get_related_contexts_string($this->context)."
1324                            AND g.id IS NULL
1325                            $groupwheresql
1326                   GROUP BY gi.id";
1328             $ungradedcounts = $DB->get_records_sql($SQL, $params);
1330             $avgrow = new html_table_row();
1331             $avgrow->attributes['class'] = 'avg';
1333             foreach ($this->gtree->items as $itemid=>$unused) {
1334                 $item =& $this->gtree->items[$itemid];
1336                 if ($item->needsupdate) {
1337                     $avgcell = new html_table_cell();
1338                     $avgcell->text = $OUTPUT->container(get_string('error'), 'gradingerror');
1339                     $avgrow->cells[] = $avgcell;
1340                     continue;
1341                 }
1343                 if (!isset($sumarray[$item->id])) {
1344                     $sumarray[$item->id] = 0;
1345                 }
1347                 if (empty($ungradedcounts[$itemid])) {
1348                     $ungradedcount = 0;
1349                 } else {
1350                     $ungradedcount = $ungradedcounts[$itemid]->count;
1351                 }
1353                 if ($meanselection == GRADE_REPORT_MEAN_GRADED) {
1354                     $meancount = $totalcount - $ungradedcount;
1355                 } else { // Bump up the sum by the number of ungraded items * grademin
1356                     $sumarray[$item->id] += $ungradedcount * $item->grademin;
1357                     $meancount = $totalcount;
1358                 }
1360                 $decimalpoints = $item->get_decimals();
1362                 // Determine which display type to use for this average
1363                 if ($USER->gradeediting[$this->courseid]) {
1364                     $displaytype = GRADE_DISPLAY_TYPE_REAL;
1366                 } else if ($averagesdisplaytype == GRADE_REPORT_PREFERENCE_INHERIT) { // no ==0 here, please resave the report and user preferences
1367                     $displaytype = $item->get_displaytype();
1369                 } else {
1370                     $displaytype = $averagesdisplaytype;
1371                 }
1373                 // Override grade_item setting if a display preference (not inherit) was set for the averages
1374                 if ($averagesdecimalpoints == GRADE_REPORT_PREFERENCE_INHERIT) {
1375                     $decimalpoints = $item->get_decimals();
1377                 } else {
1378                     $decimalpoints = $averagesdecimalpoints;
1379                 }
1381                 if (!isset($sumarray[$item->id]) || $meancount == 0) {
1382                     $avgcell = new html_table_cell();
1383                     $avgcell->text = '-';
1384                     $avgrow->cells[] = $avgcell;
1386                 } else {
1387                     $sum = $sumarray[$item->id];
1388                     $avgradeval = $sum/$meancount;
1389                     $gradehtml = grade_format_gradevalue($avgradeval, $item, true, $displaytype, $decimalpoints);
1391                     $numberofgrades = '';
1392                     if ($shownumberofgrades) {
1393                         $numberofgrades = " ($meancount)";
1394                     }
1396                     $avgcell = new html_table_cell();
1397                     $avgcell->text = $gradehtml.$numberofgrades;
1398                     $avgrow->cells[] = $avgcell;
1399                 }
1400             }
1401             $rows[] = $avgrow;
1402         }
1403         return $rows;
1404     }
1406     /**
1407      * Given a grade_category, grade_item or grade_grade, this function
1408      * figures out the state of the object and builds then returns a div
1409      * with the icons needed for the grader report.
1410      *
1411      * @param object $object
1412      * @return string HTML
1413      */
1414     protected function get_icons($element) {
1415         global $CFG, $USER, $OUTPUT;
1417         if (!$USER->gradeediting[$this->courseid]) {
1418             return '<div class="grade_icons" />';
1419         }
1421         // Init all icons
1422         $editicon = '';
1424         if ($element['type'] != 'categoryitem' && $element['type'] != 'courseitem') {
1425             $editicon = $this->gtree->get_edit_icon($element, $this->gpr);
1426         }
1428         $editcalculationicon = '';
1429         $showhideicon        = '';
1430         $lockunlockicon      = '';
1432         if (has_capability('moodle/grade:manage', $this->context)) {
1434             if ($this->get_pref('showcalculations')) {
1435                 $editcalculationicon = $this->gtree->get_calculation_icon($element, $this->gpr);
1436             }
1438             if ($this->get_pref('showeyecons')) {
1439                $showhideicon = $this->gtree->get_hiding_icon($element, $this->gpr);
1440             }
1442             if ($this->get_pref('showlocks')) {
1443                 $lockunlockicon = $this->gtree->get_locking_icon($element, $this->gpr);
1444             }
1445         }
1447         return $OUTPUT->container($editicon.$editcalculationicon.$showhideicon.$lockunlockicon, 'grade_icons');
1448     }
1450     /**
1451      * Given a category element returns collapsing +/- icon if available
1452      * @param object $object
1453      * @return string HTML
1454      */
1455     protected function get_collapsing_icon($element) {
1456         global $OUTPUT;
1458         $icon = '';
1459         // If object is a category, display expand/contract icon
1460         if ($element['type'] == 'category') {
1461             // Load language strings
1462             $strswitchminus = $this->get_lang_string('aggregatesonly', 'grades');
1463             $strswitchplus  = $this->get_lang_string('gradesonly', 'grades');
1464             $strswitchwhole = $this->get_lang_string('fullmode', 'grades');
1466             $url = new moodle_url($this->gpr->get_return_url(null, array('target'=>$element['eid'], 'sesskey'=>sesskey())));
1468             if (in_array($element['object']->id, $this->collapsed['aggregatesonly'])) {
1469                 $url->param('action', 'switch_plus');
1470                 $icon = $OUTPUT->action_icon($url, new pix_icon('t/switch_plus', $strswitchplus));
1472             } else if (in_array($element['object']->id, $this->collapsed['gradesonly'])) {
1473                 $url->param('action', 'switch_whole');
1474                 $icon = $OUTPUT->action_icon($url, new pix_icon('t/switch_whole', $strswitchwhole));
1476             } else {
1477                 $url->param('action', 'switch_minus');
1478                 $icon = $OUTPUT->action_icon($url, new pix_icon('t/switch_minus', $strswitchminus));
1479             }
1480         }
1481         return $icon;
1482     }
1484     /**
1485      * Processes a single action against a category, grade_item or grade.
1486      * @param string $target eid ({type}{id}, e.g. c4 for category4)
1487      * @param string $action Which action to take (edit, delete etc...)
1488      * @return
1489      */
1490     public function process_action($target, $action) {
1491         // TODO: this code should be in some grade_tree static method
1492         $targettype = substr($target, 0, 1);
1493         $targetid = substr($target, 1);
1494         // TODO: end
1496         if ($collapsed = get_user_preferences('grade_report_grader_collapsed_categories')) {
1497             $collapsed = unserialize($collapsed);
1498         } else {
1499             $collapsed = array('aggregatesonly' => array(), 'gradesonly' => array());
1500         }
1502         switch ($action) {
1503             case 'switch_minus': // Add category to array of aggregatesonly
1504                 if (!in_array($targetid, $collapsed['aggregatesonly'])) {
1505                     $collapsed['aggregatesonly'][] = $targetid;
1506                     set_user_preference('grade_report_grader_collapsed_categories', serialize($collapsed));
1507                 }
1508                 break;
1510             case 'switch_plus': // Remove category from array of aggregatesonly, and add it to array of gradesonly
1511                 $key = array_search($targetid, $collapsed['aggregatesonly']);
1512                 if ($key !== false) {
1513                     unset($collapsed['aggregatesonly'][$key]);
1514                 }
1515                 if (!in_array($targetid, $collapsed['gradesonly'])) {
1516                     $collapsed['gradesonly'][] = $targetid;
1517                 }
1518                 set_user_preference('grade_report_grader_collapsed_categories', serialize($collapsed));
1519                 break;
1520             case 'switch_whole': // Remove the category from the array of collapsed cats
1521                 $key = array_search($targetid, $collapsed['gradesonly']);
1522                 if ($key !== false) {
1523                     unset($collapsed['gradesonly'][$key]);
1524                     set_user_preference('grade_report_grader_collapsed_categories', serialize($collapsed));
1525                 }
1527                 break;
1528             default:
1529                 break;
1530         }
1532         return true;
1533     }
1535     /**
1536      * Returns whether or not to display fixed students column.
1537      * Includes a browser check, because IE6 doesn't support the scrollbar.
1538      *
1539      * @return bool
1540      */
1541     public function is_fixed_students() {
1542         global $USER, $CFG;
1543         return empty($USER->screenreader) && $CFG->grade_report_fixedstudents &&
1544             (check_browser_version('MSIE', '7.0') ||
1545              check_browser_version('Firefox', '2.0') ||
1546              check_browser_version('Gecko', '2006010100') ||
1547              check_browser_version('Camino', '1.0') ||
1548              check_browser_version('Opera', '6.0') ||
1549              check_browser_version('Chrome', '6') ||
1550              check_browser_version('Safari', '300'));
1551     }
1553     /**
1554      * Refactored function for generating HTML of sorting links with matching arrows.
1555      * Returns an array with 'studentname' and 'idnumber' as keys, with HTML ready
1556      * to inject into a table header cell.
1557      * @return array An associative array of HTML sorting links+arrows
1558      */
1559     public function get_sort_arrows() {
1560         global $OUTPUT;
1561         $arrows = array();
1563         $strsortasc   = $this->get_lang_string('sortasc', 'grades');
1564         $strsortdesc  = $this->get_lang_string('sortdesc', 'grades');
1565         $strfirstname = $this->get_lang_string('firstname');
1566         $strlastname  = $this->get_lang_string('lastname');
1568         $firstlink = html_writer::link(new moodle_url($this->baseurl, array('sortitemid'=>'firstname')), $strfirstname);
1569         $lastlink = html_writer::link(new moodle_url($this->baseurl, array('sortitemid'=>'lastname')), $strlastname);
1570         $idnumberlink = html_writer::link(new moodle_url($this->baseurl, array('sortitemid'=>'idnumber')), get_string('idnumber'));
1572         $arrows['studentname'] = $lastlink;
1574         if ($this->sortitemid === 'lastname') {
1575             if ($this->sortorder == 'ASC') {
1576                 $arrows['studentname'] .= print_arrow('up', $strsortasc, true);
1577             } else {
1578                 $arrows['studentname'] .= print_arrow('down', $strsortdesc, true);
1579             }
1580         }
1582         $arrows['studentname'] .= ' ' . $firstlink;
1584         if ($this->sortitemid === 'firstname') {
1585             if ($this->sortorder == 'ASC') {
1586                 $arrows['studentname'] .= print_arrow('up', $strsortasc, true);
1587             } else {
1588                 $arrows['studentname'] .= print_arrow('down', $strsortdesc, true);
1589             }
1590         }
1592         $arrows['idnumber'] = $idnumberlink;
1594         if ('idnumber' == $this->sortitemid) {
1595             if ($this->sortorder == 'ASC') {
1596                 $arrows['idnumber'] .= print_arrow('up', $strsortasc, true);
1597             } else {
1598                 $arrows['idnumber'] .= print_arrow('down', $strsortdesc, true);
1599             }
1600         }
1602         return $arrows;
1603     }