MDL-11859 student rank and showing of hidden grade items are now configurable + fixed...
[moodle.git] / grade / report / user / lib.php
CommitLineData
f7998fbc 1<?php // $Id$
8ad36f4c 2
3///////////////////////////////////////////////////////////////////////////
4// //
5// NOTICE OF COPYRIGHT //
6// //
7// Moodle - Modular Object-Oriented Dynamic Learning Environment //
8// http://moodle.com //
9// //
10// Copyright (C) 1999 onwards Martin Dougiamas http://moodle.com //
11// //
12// This program is free software; you can redistribute it and/or modify //
13// it under the terms of the GNU General Public License as published by //
14// the Free Software Foundation; either version 2 of the License, or //
15// (at your option) any later version. //
16// //
17// This program is distributed in the hope that it will be useful, //
18// but WITHOUT ANY WARRANTY; without even the implied warranty of //
19// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the //
20// GNU General Public License for more details: //
21// //
22// http://www.gnu.org/copyleft/gpl.html //
23// //
24///////////////////////////////////////////////////////////////////////////
f7998fbc 25/**
26 * File in which the user_report class is defined.
27 * @package gradebook
28 */
29
30require_once($CFG->dirroot . '/grade/report/lib.php');
31require_once($CFG->libdir.'/tablelib.php');
32
33/**
34 * Class providing an API for the user report building and displaying.
35 * @uses grade_report
36 * @package gradebook
37 */
38class grade_report_user extends grade_report {
39
40 /**
41 * The user.
42 * @var object $user
43 */
44 var $user;
45
46 /**
47 * A flexitable to hold the data.
48 * @var object $table
49 */
50 var $table;
51
e0724506 52 /**
53 * Flat structure similar to grade tree
54 */
55 var $gseq;
56
f7998fbc 57 /**
58 * Constructor. Sets local copies of user preferences and initialises grade_tree.
59 * @param int $courseid
d30c4481 60 * @param object $gpr grade plugin return tracking object
f7998fbc 61 * @param string $context
62 * @param int $userid The id of the user
63 */
d30c4481 64 function grade_report_user($courseid, $gpr, $context, $userid) {
f7998fbc 65 global $CFG;
d30c4481 66 parent::grade_report($courseid, $gpr, $context);
f7998fbc 67
e0724506 68 $switch = grade_get_setting($this->courseid, 'aggregationposition', $CFG->grade_aggregationposition);
69
4faf5f99 70 // Grab the grade_tree for this course
e0724506 71 $this->gseq = new grade_seq($this->courseid, $switch);
4faf5f99 72
f7998fbc 73 // get the user (for full name)
74 $this->user = get_record('user', 'id', $userid);
75
76 // base url for sorting by first/last name
77 $this->baseurl = $CFG->wwwroot.'/grade/report?id='.$courseid.'&amp;userid='.$userid;
90d3960c 78 $this->pbarurl = $this->baseurl;
f7998fbc 79
e0724506 80 // always setup groups - no user preference here
81 $this->setup_groups();
f7998fbc 82
90d3960c 83 $this->setup_table();
f7998fbc 84 }
85
86 /**
87 * Prepares the headers and attributes of the flexitable.
88 */
89 function setup_table() {
02973505 90 global $CFG;
f7998fbc 91 /*
02973505 92 * Table has 5-6 columns
93 *| pic | itemname/description | grade (grade_final) | percentage | rank (optional) | feedback |
f7998fbc 94 */
95
96 // setting up table headers
02973505 97 if (!empty($CFG->grade_userreport_showrank)) {
98 // TODO: this is broken if hidden grades present!!
99 $tablecolumns = array('itemname', 'category', 'grade', 'percentage', 'rank', 'feedback');
100 $tableheaders = array($this->get_lang_string('gradeitem', 'grades'), $this->get_lang_string('category'), $this->get_lang_string('grade'),
101 $this->get_lang_string('percent', 'grades'), $this->get_lang_string('rank', 'grades'),
102 $this->get_lang_string('feedback'));
103 } else {
104 $tablecolumns = array('itemname', 'category', 'grade', 'percentage', 'feedback');
105 $tableheaders = array($this->get_lang_string('gradeitem', 'grades'), $this->get_lang_string('category'), $this->get_lang_string('grade'),
106 $this->get_lang_string('percent', 'grades'), $this->get_lang_string('feedback'));
107 }
f7998fbc 108
109 $this->table = new flexible_table('grade-report-user-'.$this->courseid);
110
111 $this->table->define_columns($tablecolumns);
112 $this->table->define_headers($tableheaders);
113 $this->table->define_baseurl($this->baseurl);
114
115 $this->table->set_attribute('cellspacing', '0');
116 $this->table->set_attribute('id', 'user-grade');
117 $this->table->set_attribute('class', 'boxaligncenter generaltable');
118
119 // not sure tables should be sortable or not, because if we allow it then sorted resutls distort grade category structure and sortorder
120 $this->table->set_control_variables(array(
121 TABLE_VAR_SORT => 'ssort',
122 TABLE_VAR_HIDE => 'shide',
123 TABLE_VAR_SHOW => 'sshow',
124 TABLE_VAR_IFIRST => 'sifirst',
125 TABLE_VAR_ILAST => 'silast',
126 TABLE_VAR_PAGE => 'spage'
127 ));
128
129 $this->table->setup();
130 }
131
132 function fill_table() {
133 global $CFG;
6ef84f6f 134 $numusers = $this->get_numusers(false); // total course users
6391ebe7 135 $items =& $this->gseq->items;
136 $grades = array();
f7998fbc 137
b89a70ce 138 $canviewhidden = has_capability('moodle/grade:viewhidden', get_context_instance(CONTEXT_COURSE, $this->courseid));
f7998fbc 139
6391ebe7 140 foreach ($items as $key=>$unused) {
141 $grade_item =& $items[$key];
e0724506 142 $grade_grade = new grade_grade(array('itemid'=>$grade_item->id, 'userid'=>$this->user->id));
6391ebe7 143 $grades[$key] = $grade_grade;
144 $grades[$key]->grade_item =& $grade_item;
145 }
146
b89a70ce 147 if ($canviewhidden) {
d297269d 148 $altered = array();
149 $unknown = array();
b89a70ce 150 } else {
151 $hiding_affected = grade_grade::get_hiding_affected($grades, $items);
d297269d 152 $altered = $hiding_affected['altered'];
153 $unknown = $hiding_affected['unknown'];
154 unset($hiding_affected);
b89a70ce 155 }
6391ebe7 156
d297269d 157 foreach ($items as $itemid=>$unused) {
158 $grade_item =& $items[$itemid];
159 $grade_grade =& $grades[$itemid];
160
02973505 161 if (empty($CFG->grade_userreport_showhiddenitems) and !$canviewhidden and $grade_item->is_hidden()) {
162 continue;
163 }
164
d297269d 165 if (in_array($itemid, $unknown)) {
166 $gradeval = null;
167 } else if (array_key_exists($itemid, $altered)) {
168 $gradeval = $altered[$itemid];
169 } else {
170 $gradeval = $grade_grade->finalgrade;
171 }
6391ebe7 172
173 $data = array();
f7998fbc 174
e0724506 175 /// prints grade item name
176 if ($grade_item->is_course_item() or $grade_item->is_category_item()) {
6391ebe7 177 $data[] = '<div class="catname">'.$grade_item->get_name().'</div>';
e0724506 178 } else {
6391ebe7 179 $data[] = '<div class="itemname">'.$this->get_module_link($grade_item->get_name(), $grade_item->itemmodule, $grade_item->iteminstance).'</div>';
e0724506 180 }
f7998fbc 181
e0724506 182 /// prints category
183 $cat = $grade_item->get_parent_category();
6391ebe7 184 $data[] = $cat->get_name();
4c8d9481 185
e0724506 186 /// prints the grade
e0724506 187 if ($grade_grade->is_excluded()) {
188 $excluded = get_string('excluded', 'grades').' ';
189 } else {
190 $excluded = '';
191 }
f7998fbc 192
b89a70ce 193 if ($grade_item->needsupdate) {
194 $data[] = '<span class="gradingerror">'.get_string('error').'</span>';
195
d297269d 196 } else if (!empty($CFG->grade_hiddenasdate) and !is_null($grade_grade->finalgrade) and !$canviewhidden and $grade_grade->is_hidden()
197 and !$grade_item->is_category_item() and !$grade_item->is_course_item()) {
198 // 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
199 $data[] = $excluded . '<div class="gradeddate">'.get_string('gradedon', 'grades', userdate($grade_grade->timemodified, get_string('strftimedatetimeshort'))).'</div>';
6391ebe7 200
e0724506 201 } else {
d297269d 202 $data[] = $excluded . grade_format_gradevalue($gradeval, $grade_item, true);
e0724506 203 }
204
205 /// prints percentage
b89a70ce 206 if ($grade_item->needsupdate) {
207 $data[] = '<span class="gradingerror">'.get_string('error').'</span>';
23207a1a 208
6391ebe7 209 } else {
d297269d 210 $data[] = grade_format_gradevalue($gradeval, $grade_item, true, GRADE_DISPLAY_TYPE_PERCENTAGE);
e0724506 211 }
6391ebe7 212
e0724506 213 /// prints rank
02973505 214 if (!empty($CFG->grade_userreport_showrank)) {
215 // TODO: this is broken if hidden grades present!!
216 if ($grade_item->needsupdate) {
217 $data[] = '<span class="gradingerror">'.get_string('error').'</span>';
218
219 } else if (is_null($gradeval)) {
220 // no grade, no rank
221 $data[] = '-';
222
223 } else {
224 /// find the number of users with a higher grade
225 $sql = "SELECT COUNT(DISTINCT(userid))
226 FROM {$CFG->prefix}grade_grades
227 WHERE finalgrade > {$grade_grade->finalgrade}
228 AND itemid = {$grade_item->id}";
229 $rank = count_records_sql($sql) + 1;
230
231 $data[] = "$rank/$numusers";
232 }
f7998fbc 233 }
234
e0724506 235 /// prints notes
6391ebe7 236 if (empty($grade_grade->feedback)) {
237 $data[] = '&nbsp;';
238
d297269d 239 } else if (!$canviewhidden and $grade_grade->is_hidden()) {
e0724506 240 $data[] = '&nbsp;';
6391ebe7 241
242 } else {
243 $data[] = format_text($grade_grade->feedback, $grade_grade->feedbackformat);
e0724506 244 }
6391ebe7 245
e0724506 246 $this->table->add_data($data);
f7998fbc 247 }
e0724506 248
249 return true;
f7998fbc 250 }
251
252 /**
253 * Prints or returns the HTML from the flexitable.
254 * @param bool $return Whether or not to return the data instead of printing it directly.
255 * @return string
256 */
257 function print_table($return=false) {
258 ob_start();
259 $this->table->print_html();
260 $html = ob_get_clean();
261 if ($return) {
262 return $html;
263 } else {
264 echo $html;
265 }
266 }
267
268 /**
269 * Processes the data sent by the form (grades and feedbacks).
270 * @var array $data
271 * @return bool Success or Failure (array of errors).
272 */
273 function process_data($data) {
274 }
275
f7998fbc 276}
277?>