merged fix for MDL-11064, users can't see teacher's profile
[moodle.git] / grade / report / lib.php
CommitLineData
eea6690a 1<?php // $Id$
38b9e8a8 2/**
eea6690a 3 * File containing the grade_report class.
4 * @package gradebook
38b9e8a8 5 */
eea6690a 6
7require_once($CFG->libdir.'/gradelib.php');
8
9/**
10 * An abstract class containing variables and methods used by all or most reports.
11 * @abstract
12 * @package gradebook
13 */
14class grade_report {
15 /**
16 * The courseid.
17 * @var int $courseid
18 */
19 var $courseid;
20
d30c4481 21 /** Grade plugin return tracking object.
22 var $gpr;
23
eea6690a 24 /**
25 * The context.
26 * @var int $context
27 */
28 var $context;
29
30 /**
31 * The grade_tree object.
32 * @var object $gtree
33 */
34 var $gtree;
35
36 /**
37 * User preferences related to this report.
e50ce569 38 * @var array $prefs
eea6690a 39 */
e50ce569 40 var $prefs = array();
eea6690a 41
42 /**
43 * The roles for this report.
44 * @var string $gradebookroles
45 */
46 var $gradebookroles;
47
48 /**
49 * base url for sorting by first/last name.
50 * @var string $baseurl
51 */
52 var $baseurl;
53
54 /**
55 * base url for paging.
56 * @var string $pbarurl
57 */
58 var $pbarurl;
59
60 /**
61 * Current page (for paging).
62 * @var int $page
63 */
64 var $page;
65
388234f4 66 /**
67 * Array of cached language strings (using get_string() all the time takes a long time!).
68 * @var array $lang_strings
69 */
70 var $lang_strings = array();
71
90d3960c 72//// GROUP VARIABLES (including SQL)
73
74 /**
75 * The current group being displayed.
76 * @var int $currentgroup
77 */
78 var $currentgroup;
79
80 /**
81 * A HTML select element used to select the current group.
82 * @var string $group_selector
83 */
84 var $group_selector;
85
86 /**
87 * An SQL fragment used to add linking information to the group tables.
88 * @var string $groupsql
89 */
90 var $groupsql;
91
92 /**
93 * An SQL constraint to append to the queries used by this object to build the report.
94 * @var string $groupwheresql
95 */
96 var $groupwheresql;
97
98
eea6690a 99 /**
100 * Constructor. Sets local copies of user preferences and initialises grade_tree.
101 * @param int $courseid
d30c4481 102 * @param object $gpr grade plugin return tracking object
eea6690a 103 * @param string $context
104 * @param int $page The current page being viewed (when report is paged)
105 */
d30c4481 106 function grade_report($courseid, $gpr, $context, $page=null) {
eea6690a 107 global $CFG;
108
4faf5f99 109 $this->courseid = $courseid;
110 $this->gpr = $gpr;
111 $this->context = $context;
112 $this->page = $page;
eea6690a 113
114 // roles to be displayed in the gradebook
115 $this->gradebookroles = $CFG->gradebookroles;
116
4faf5f99 117 // init gtree in child class
38b9e8a8 118 }
119
eea6690a 120 /**
121 * Given the name of a user preference (without grade_report_ prefix), locally saves then returns
122 * the value of that preference. If the preference has already been fetched before,
123 * the saved value is returned. If the preference is not set at the User level, the $CFG equivalent
124 * is given (site default).
501e0e34 125 * @static (Can be called statically, but then doesn't benefit from caching)
eea6690a 126 * @param string $pref The name of the preference (do not include the grade_report_ prefix)
8c5a416e 127 * @param int $objectid An optional itemid or categoryid to check for a more fine-grained preference
eea6690a 128 * @return mixed The value of the preference
129 */
8c5a416e 130 function get_pref($pref, $objectid=null) {
eea6690a 131 global $CFG;
501e0e34 132 $fullprefname = 'grade_report_' . $pref;
38b9e8a8 133
e50ce569 134 $retval = null;
135
438a5aa9 136 if (!isset($this) OR get_class($this) != 'grade_report') {
8c5a416e 137 if (!empty($objectid)) {
138 $retval = get_user_preferences($fullprefname . $objectid, grade_report::get_pref($pref));
bb384a8e 139 } else {
e50ce569 140 $retval = get_user_preferences($fullprefname, $CFG->$fullprefname);
bb384a8e 141 }
501e0e34 142 } else {
8c5a416e 143 if (empty($this->prefs[$pref.$objectid])) {
e50ce569 144
8c5a416e 145 if (!empty($objectid)) {
146 $retval = get_user_preferences($fullprefname . $objectid);
e50ce569 147 if (empty($retval)) {
148 // No item pref found, we are returning the global preference
149 $retval = $this->get_pref($pref);
8c5a416e 150 $objectid = null;
e50ce569 151 }
501e0e34 152 } else {
e50ce569 153 $retval = get_user_preferences($fullprefname, $CFG->$fullprefname);
501e0e34 154 }
8c5a416e 155 $this->prefs[$pref.$objectid] = $retval;
e50ce569 156 } else {
8c5a416e 157 $retval = $this->prefs[$pref.$objectid];
501e0e34 158 }
eea6690a 159 }
e50ce569 160
161 return $retval;
eea6690a 162 }
bb384a8e 163
eea6690a 164 /**
501e0e34 165 * Uses set_user_preferences() to update the value of a user preference. If 'default' is given as the value,
166 * the preference will be removed in favour of a higher-level preference.
167 * @static
eea6690a 168 * @param string $pref_name The name of the preference.
169 * @param mixed $pref_value The value of the preference.
bb384a8e 170 * @param int $itemid An optional itemid to which the preference will be assigned
eea6690a 171 * @return bool Success or failure.
172 * TODO print visual feedback
173 */
501e0e34 174 function set_pref($pref, $pref_value='default', $itemid=null) {
bb384a8e 175 $fullprefname = 'grade_report_' . $pref;
501e0e34 176 if ($pref_value == 'default') {
177 return unset_user_preference($fullprefname.$itemid);
178 } else {
179 return set_user_preference($fullprefname.$itemid, $pref_value);
eea6690a 180 }
38b9e8a8 181 }
38b9e8a8 182
eea6690a 183 /**
184 * Handles form data sent by this report for this report. Abstract method to implement in all children.
185 * @abstract
186 * @param array $data
187 * @return mixed True or array of errors
188 */
189 function process_data($data) {
190 // Implement in children classes
191 }
38b9e8a8 192
eea6690a 193 /**
194 * Processes a single action against a category, grade_item or grade.
195 * @param string $target Sortorder
196 * @param string $action Which action to take (edit, delete etc...)
197 * @return
eea6690a 198 */
199 function process_action($target, $action) {
2cc773f5 200 //implement if needed
eea6690a 201 }
202
388234f4 203 /**
204 * First checks the cached language strings, then returns match if found, or uses get_string()
205 * to get it from the DB, caches it then returns it.
206 * @param string $strcode
207 * @param string $section Optional language section
208 * @return string
209 */
210 function get_lang_string($strcode, $section=null) {
211 if (empty($this->lang_strings[$strcode])) {
212 $this->lang_strings[$strcode] = get_string($strcode, $section);
213 }
214 return $this->lang_strings[$strcode];
215 }
216
bb384a8e 217 /**
218 * Computes then returns the percentage value of the grade value within the given range.
219 * @param float $gradeval
220 * @param float $grademin
221 * @param float $grademx
222 * @return float $percentage
223 */
224 function grade_to_percentage($gradeval, $grademin, $grademax) {
225 if ($grademin >= $grademax) {
226 debugging("The minimum grade ($grademin) was higher than or equal to the maximum grade ($grademax)!!! Cannot proceed with computation.");
227 }
228 $offset_value = $gradeval - $grademin;
229 $offset_max = $grademax - $grademin;
230 $factor = 100 / $offset_max;
231 $percentage = $offset_value * $factor;
232 return $percentage;
233 }
32b97bb2 234
235 /**
236 * Fetches and returns an array of grade letters indexed by their grade boundaries, as stored in preferences.
237 * @return array
238 */
239 function get_grade_letters() {
240 $letters = array();
241 for ($i = 1; $i <= 10; $i++) {
242 $boundary = grade_report::get_pref('gradeboundary' . $i);
243 $letter = grade_report::get_pref('gradeletter' . $i);
244 if (!is_null($boundary) && $boundary != -1 && !empty($letter)) {
245 $letters[$boundary] = $letter;
246 }
247 }
248 return $letters;
249 }
90d3960c 250
251 /**
252 * Fetches and returns a count of all the users that will be shown on this page.
253 * @return int Count of users
254 */
255 function get_numusers() {
256 global $CFG;
257
258 $countsql = "SELECT COUNT(DISTINCT u.id)
259 FROM {$CFG->prefix}grade_grades g RIGHT OUTER JOIN
260 {$CFG->prefix}user u ON u.id = g.userid
261 LEFT JOIN {$CFG->prefix}role_assignments ra ON u.id = ra.userid
262 $this->groupsql
263 WHERE ra.roleid in ($this->gradebookroles)
264 $this->groupwheresql
265 AND ra.contextid ".get_related_contexts_string($this->context);
266 return count_records_sql($countsql);
267 }
268
269 /**
270 * Sets up this object's group variables, mainly to restrict the selection of users to display.
271 */
272 function setup_groups() {
273 global $CFG;
274
275 /// find out current groups mode
276 $course = get_record('course', 'id', $this->courseid);
277 $groupmode = $course->groupmode;
278 ob_start();
279 $this->currentgroup = setup_and_print_groups($course, $groupmode, $this->pbarurl);
280 $this->group_selector = ob_get_clean();
281
282 // update paging after group
8c40e091 283 $this->baseurl .= 'group='.$this->currentgroup.'&amp;';
284 $this->pbarurl .= 'group='.$this->currentgroup.'&amp;';
90d3960c 285
286 if ($this->currentgroup) {
287 $this->groupsql = " LEFT JOIN {$CFG->prefix}groups_members gm ON gm.userid = u.id ";
288 $this->groupwheresql = " AND gm.groupid = $this->currentgroup ";
289 }
290 }
2e3987a9 291
292 /**
293 * Returns an arrow icon inside an <a> tag, for the purpose of sorting a column.
294 * @param string $direction
295 * @param string $sort_link
296 * @param string HTML
297 */
298 function get_sort_arrow($direction='move', $sort_link=null) {
859c7259 299 $matrix = array('up' => 'asc', 'down' => 'desc', 'move' => 'desc');
2e3987a9 300 $strsort = $this->get_lang_string('sort' . $matrix[$direction]);
301 $arrow = print_arrow($direction, $strsort, true);
302 $html = '<a href="'.$sort_link .'">' . $arrow . '</a>';
303 return $html;
304 }
305
306 /**
307 * Builds and returns a HTML link to the grade or view page of the module given.
308 * If no itemmodule is given, only the name of the category/item is returned, no link.
309 * @param string $modulename The shortname of the module, will become the visible header
310 * @param string $itemmodule The name of the module type (e.g. assignment, quiz...)
311 * @param int $iteminstance The instance number of the module
312 * @return string HTML
313 */
314 function get_module_link($modulename, $itemmodule=null, $iteminstance=null) {
315 global $CFG, $COURSE;
316
317 $link = null;
318 if (!is_null($itemmodule) AND !is_null($iteminstance)) {
1815b45c 319 // Add module icon if toggle is enabled
320 if ($this->get_pref('showactivityicons')) {
321 $modulename = '<img src="' . $CFG->modpixpath . '/' . $itemmodule
322 . '/icon.gif" class="icon activity" alt="' . $modulename . '" />' . $modulename;
323 }
324
2e3987a9 325 $coursemodule = get_coursemodule_from_instance($itemmodule, $iteminstance, $COURSE->id);
326
327 $dir = $CFG->dirroot . "/mod/$itemmodule/";
328 $url = $CFG->wwwroot . "/mod/$itemmodule/";
329
330 if (file_exists($dir . 'grade.php')) {
331 $url .= 'grade.php';
332 } else {
333 $url .= 'view.php';
334 }
335
336 $url .= "?id=$coursemodule->id";
337 return '<a href="' . $url . '">' . $modulename . '</a>';
338 }
339
340 return $modulename;
341 }
38b9e8a8 342}
eea6690a 343?>