MDL-48936 lang: Changed "My Home" to "Dashboard".
[moodle.git] / grade / report / overview / lib.php
CommitLineData
e060e33d 1<?php
e060e33d 2// This file is part of Moodle - http://moodle.org/
3//
4// Moodle is free software: you can redistribute it and/or modify
5// it under the terms of the GNU General Public License as published by
6// the Free Software Foundation, either version 3 of the License, or
7// (at your option) any later version.
8//
9// Moodle is distributed in the hope that it will be useful,
10// but WITHOUT ANY WARRANTY; without even the implied warranty of
11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12// GNU General Public License for more details.
13//
14// You should have received a copy of the GNU General Public License
15// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
8ad36f4c 16
aa330ebb 17/**
a153c9f2
AD
18 * Definition of the grade_overview_report class
19 *
20 * @package gradereport_overview
21 * @copyright 2007 Nicolas Connault
22 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
aa330ebb 23 */
24
25require_once($CFG->dirroot . '/grade/report/lib.php');
26require_once($CFG->libdir.'/tablelib.php');
27
28/**
29 * Class providing an API for the overview report building and displaying.
30 * @uses grade_report
a153c9f2 31 * @package gradereport_overview
aa330ebb 32 */
33class grade_report_overview extends grade_report {
34
35 /**
36 * The user.
37 * @var object $user
38 */
5c75a0a3 39 public $user;
aa330ebb 40
9db8d030
AD
41 /**
42 * The user's courses
43 * @var array $courses
44 */
45 public $courses;
46
aa330ebb 47 /**
48 * A flexitable to hold the data.
49 * @var object $table
50 */
5c75a0a3 51 public $table;
aa330ebb 52
60574063 53 /**
9db8d030
AD
54 * Show student ranks within each course.
55 * @var array $showrank
60574063 56 */
5c75a0a3 57 public $showrank;
60574063 58
61541a5a
AD
59 /**
60 * show course/category totals if they contain hidden items
61 */
62 var $showtotalsifcontainhidden;
63
aa330ebb 64 /**
65 * Constructor. Sets local copies of user preferences and initialises grade_tree.
66 * @param int $userid
67 * @param object $gpr grade plugin return tracking object
68 * @param string $context
69 */
5c75a0a3 70 public function __construct($userid, $gpr, $context) {
71 global $CFG, $COURSE, $DB;
72 parent::__construct($COURSE->id, $gpr, $context);
f7e21436 73
9db8d030 74 // Get the user (for full name).
5c75a0a3 75 $this->user = $DB->get_record('user', array('id' => $userid));
aa330ebb 76
9db8d030
AD
77 // Load the user's courses.
78 $this->courses = enrol_get_users_courses($this->user->id, false, 'id, shortname, showgrades');
79
80 $this->showrank = array();
81 $this->showrank['any'] = false;
5df9bc39
AD
82
83 $this->showtotalsifcontainhidden = array();
84
9db8d030
AD
85 if ($this->courses) {
86 foreach ($this->courses as $course) {
87 $this->showrank[$course->id] = grade_get_setting($course->id, 'report_overview_showrank', !empty($CFG->grade_report_overview_showrank));
88 if ($this->showrank[$course->id]) {
89 $this->showrank['any'] = true;
90 }
5df9bc39
AD
91
92 $this->showtotalsifcontainhidden[$course->id] = grade_get_setting($course->id, 'report_overview_showtotalsifcontainhidden', $CFG->grade_report_overview_showtotalsifcontainhidden);
9db8d030
AD
93 }
94 }
95
96
aa330ebb 97 // base url for sorting by first/last name
98 $this->baseurl = $CFG->wwwroot.'/grade/overview/index.php?id='.$userid;
99 $this->pbarurl = $this->baseurl;
100
101 $this->setup_table();
102 }
103
104 /**
105 * Prepares the headers and attributes of the flexitable.
106 */
5c75a0a3 107 public function setup_table() {
aa330ebb 108 /*
60574063 109 * Table has 3 columns
110 *| course | final grade | rank (optional) |
111 */
aa330ebb 112
113 // setting up table headers
9db8d030 114 if ($this->showrank['any']) {
60574063 115 $tablecolumns = array('coursename', 'grade', 'rank');
116 $tableheaders = array($this->get_lang_string('coursename', 'grades'),
117 $this->get_lang_string('grade'),
118 $this->get_lang_string('rank', 'grades'));
119 } else {
120 $tablecolumns = array('coursename', 'grade');
121 $tableheaders = array($this->get_lang_string('coursename', 'grades'),
122 $this->get_lang_string('grade'));
123 }
aa330ebb 124 $this->table = new flexible_table('grade-report-overview-'.$this->user->id);
125
126 $this->table->define_columns($tablecolumns);
127 $this->table->define_headers($tableheaders);
128 $this->table->define_baseurl($this->baseurl);
129
130 $this->table->set_attribute('cellspacing', '0');
131 $this->table->set_attribute('id', 'overview-grade');
132 $this->table->set_attribute('class', 'boxaligncenter generaltable');
133
134 $this->table->setup();
135 }
136
5c75a0a3 137 public function fill_table() {
78527462 138 global $CFG, $DB, $OUTPUT, $USER;
aa330ebb 139
9db8d030
AD
140 // Only show user's courses instead of all courses.
141 if ($this->courses) {
38cb3391 142 $numusers = $this->get_numusers(false);
60574063 143
9db8d030 144 foreach ($this->courses as $course) {
252d14db 145 if (!$course->showgrades) {
146 continue;
147 }
31eae0eb 148
d4060472 149 $coursecontext = context_course::instance($course->id);
31eae0eb
AD
150
151 if (!$course->visible && !has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
152 // The course is hidden and the user isn't allowed to see it
153 continue;
154 }
155
78527462
PAM
156 if ((!has_capability('moodle/grade:view', $coursecontext) || $this->user->id != $USER->id) &&
157 !has_capability('moodle/grade:viewall', $coursecontext)) {
158 continue;
159 }
160
01df798e 161 $courseshortname = format_string(get_course_display_name_for_list($course), true, array('context' => $coursecontext));
8ebbb06a
SH
162 $courselink = html_writer::link(new moodle_url('/grade/report/user/index.php', array('id' => $course->id, 'userid' => $this->user->id)), $courseshortname);
163 $canviewhidden = has_capability('moodle/grade:viewhidden', $coursecontext);
60574063 164
aa330ebb 165 // Get course grade_item
00006755 166 $course_item = grade_item::fetch_course_item($course->id);
167
168 // Get the stored grade
169 $course_grade = new grade_grade(array('itemid'=>$course_item->id, 'userid'=>$this->user->id));
170 $course_grade->grade_item =& $course_item;
171 $finalgrade = $course_grade->finalgrade;
172
173 if (!$canviewhidden and !is_null($finalgrade)) {
174 if ($course_grade->is_hidden()) {
175 $finalgrade = null;
00006755 176 } else {
5232d3f2
DW
177 $adjustedgrade = $this->blank_hidden_total_and_adjust_bounds($course->id,
178 $course_item,
179 $finalgrade);
180
181 // We temporarily adjust the view of this grade item - because the min and
182 // max are affected by the hidden values in the aggregation.
183 $finalgrade = $adjustedgrade['grade'];
184 $course_item->grademax = $adjustedgrade['grademax'];
185 $course_item->grademin = $adjustedgrade['grademin'];
00006755 186 }
5a59aeb1
DW
187 } else {
188 // We must use the rawgrademin / rawgrademax because it can be different for
189 // each grade_grade when items are excluded from sum of grades.
190 if (!is_null($finalgrade)) {
191 $course_item->grademin = $course_grade->rawgrademin;
192 $course_item->grademax = $course_grade->rawgrademax;
193 }
60574063 194 }
195
00006755 196 $data = array($courselink, grade_format_gradevalue($finalgrade, $course_item, true));
aa330ebb 197
9db8d030 198 if (!$this->showrank['any']) {
60574063 199 //nothing to do
200
9db8d030 201 } else if ($this->showrank[$course->id] && !is_null($finalgrade)) {
aa330ebb 202 /// find the number of users with a higher grade
00006755 203 /// please note this can not work if hidden grades involved :-( to be fixed in 2.0
204 $params = array($finalgrade, $course_item->id);
aa330ebb 205 $sql = "SELECT COUNT(DISTINCT(userid))
d24832f9 206 FROM {grade_grades}
5c75a0a3 207 WHERE finalgrade IS NOT NULL AND finalgrade > ?
208 AND itemid = ?";
209 $rank = $DB->count_records_sql($sql, $params) + 1;
aa330ebb 210
60574063 211 $data[] = "$rank/$numusers";
212
aa330ebb 213 } else {
9db8d030
AD
214 // No grade, no rank.
215 // Or this course wants rank hidden.
60574063 216 $data[] = '-';
aa330ebb 217 }
218
60574063 219 $this->table->add_data($data);
aa330ebb 220 }
aa330ebb 221 return true;
60574063 222
aa330ebb 223 } else {
c3b834b4 224 echo $OUTPUT->notification(get_string('nocourses', 'grades'));
aa330ebb 225 return false;
226 }
227 }
228
229 /**
230 * Prints or returns the HTML from the flexitable.
231 * @param bool $return Whether or not to return the data instead of printing it directly.
232 * @return string
233 */
5c75a0a3 234 public function print_table($return=false) {
aa330ebb 235 ob_start();
236 $this->table->print_html();
237 $html = ob_get_clean();
238 if ($return) {
239 return $html;
240 } else {
241 echo $html;
242 }
243 }
244
245 /**
246 * Processes the data sent by the form (grades and feedbacks).
247 * @var array $data
248 * @return bool Success or Failure (array of errors).
249 */
653a8648 250 function process_data($data) {
5c75a0a3 251 }
653a8648 252 function process_action($target, $action) {
aa330ebb 253 }
60574063 254}
aa330ebb 255
60574063 256function grade_report_overview_settings_definition(&$mform) {
257 global $CFG;
258
61541a5a 259 //show rank
60574063 260 $options = array(-1 => get_string('default', 'grades'),
261 0 => get_string('hide'),
262 1 => get_string('show'));
263
180acd64 264 if (empty($CFG->grade_report_overview_showrank)) {
60574063 265 $options[-1] = get_string('defaultprev', 'grades', $options[0]);
266 } else {
267 $options[-1] = get_string('defaultprev', 'grades', $options[1]);
268 }
269
270 $mform->addElement('select', 'report_overview_showrank', get_string('showrank', 'grades'), $options);
bf03b43f 271 $mform->addHelpButton('report_overview_showrank', 'showrank', 'grades');
61541a5a
AD
272
273 //showtotalsifcontainhidden
274 $options = array(-1 => get_string('default', 'grades'),
275 GRADE_REPORT_HIDE_TOTAL_IF_CONTAINS_HIDDEN => get_string('hide'),
276 GRADE_REPORT_SHOW_TOTAL_IF_CONTAINS_HIDDEN => get_string('hidetotalshowexhiddenitems', 'grades'),
277 GRADE_REPORT_SHOW_REAL_TOTAL_IF_CONTAINS_HIDDEN => get_string('hidetotalshowinchiddenitems', 'grades') );
278
279 if (empty($CFG->grade_report_overview_showtotalsifcontainhidden)) {
280 $options[-1] = get_string('defaultprev', 'grades', $options[0]);
281 } else {
282 $options[-1] = get_string('defaultprev', 'grades', $options[1]);
283 }
284
285 $mform->addElement('select', 'report_overview_showtotalsifcontainhidden', get_string('hidetotalifhiddenitems', 'grades'), $options);
0459cc4d 286 $mform->addHelpButton('report_overview_showtotalsifcontainhidden', 'hidetotalifhiddenitems', 'grades');
aa330ebb 287}
60574063 288
6c3ef410 289