MDL-46139 Grades: Language change "weight -> calculated weight"
[moodle.git] / grade / lib.php
CommitLineData
cf72e2dd 1<?php
cf72e2dd 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/>.
16
cf72e2dd 17/**
18 * Functions used by gradebook plugins and reports.
19 *
a153c9f2 20 * @package core_grades
cf72e2dd 21 * @copyright 2009 Petr Skoda and Nicolas Connault
22 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 */
8ad36f4c 24
63d2081e
MN
25require_once($CFG->libdir . '/gradelib.php');
26require_once($CFG->dirroot . '/grade/export/lib.php');
7a6b7acf 27
0f5660f7 28/**
29 * This class iterates over all users that are graded in a course.
b9f49659 30 * Returns detailed info about users and their grades.
cf72e2dd 31 *
32 * @author Petr Skoda <skodak@moodle.org>
33 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
0f5660f7 34 */
35class graded_users_iterator {
728ff21b
AD
36
37 /**
38 * The couse whose users we are interested in
39 */
40 protected $course;
41
42 /**
43 * An array of grade items or null if only user data was requested
44 */
45 protected $grade_items;
46
47 /**
48 * The group ID we are interested in. 0 means all groups.
49 */
50 protected $groupid;
51
52 /**
53 * A recordset of graded users
54 */
55 protected $users_rs;
56
57 /**
58 * A recordset of user grades (grade_grade instances)
59 */
60 protected $grades_rs;
61
62 /**
63 * Array used when moving to next user while iterating through the grades recordset
64 */
65 protected $gradestack;
66
67 /**
68 * The first field of the users table by which the array of users will be sorted
69 */
70 protected $sortfield1;
71
72 /**
73 * Should sortfield1 be ASC or DESC
74 */
75 protected $sortorder1;
76
77 /**
78 * The second field of the users table by which the array of users will be sorted
79 */
80 protected $sortfield2;
81
82 /**
83 * Should sortfield2 be ASC or DESC
84 */
85 protected $sortorder2;
0f5660f7 86
78ab98bc
AD
87 /**
88 * Should users whose enrolment has been suspended be ignored?
89 */
90 protected $onlyactive = false;
91
61c8e0d7
FM
92 /**
93 * Enable user custom fields
94 */
95 protected $allowusercustomfields = false;
96
38c1dd19
RT
97 /**
98 * List of suspended users in course. This includes users whose enrolment status is suspended
99 * or enrolment has expired or not started.
100 */
101 protected $suspendedusers = array();
102
0f5660f7 103 /**
104 * Constructor
cf72e2dd 105 *
106 * @param object $course A course object
107 * @param array $grade_items array of grade items, if not specified only user info returned
108 * @param int $groupid iterate only group users if present
d08bba83 109 * @param string $sortfield1 The first field of the users table by which the array of users will be sorted
110 * @param string $sortorder1 The order in which the first sorting field will be sorted (ASC or DESC)
111 * @param string $sortfield2 The second field of the users table by which the array of users will be sorted
112 * @param string $sortorder2 The order in which the second sorting field will be sorted (ASC or DESC)
0f5660f7 113 */
728ff21b 114 public function __construct($course, $grade_items=null, $groupid=0,
cf72e2dd 115 $sortfield1='lastname', $sortorder1='ASC',
116 $sortfield2='firstname', $sortorder2='ASC') {
0f5660f7 117 $this->course = $course;
118 $this->grade_items = $grade_items;
119 $this->groupid = $groupid;
d08bba83 120 $this->sortfield1 = $sortfield1;
121 $this->sortorder1 = $sortorder1;
122 $this->sortfield2 = $sortfield2;
123 $this->sortorder2 = $sortorder2;
0f5660f7 124
125 $this->gradestack = array();
126 }
127
128 /**
129 * Initialise the iterator
728ff21b 130 *
0f5660f7 131 * @return boolean success
132 */
d24832f9 133 public function init() {
134 global $CFG, $DB;
0f5660f7 135
136 $this->close();
137
63d2081e 138 export_verify_grades($this->course->id);
0f5660f7 139 $course_item = grade_item::fetch_course_item($this->course->id);
140 if ($course_item->needsupdate) {
4e829d48 141 // Can not calculate all final grades - sorry.
0f5660f7 142 return false;
143 }
144
d4060472 145 $coursecontext = context_course::instance($this->course->id);
656d17c2 146
4e829d48
MN
147 list($relatedctxsql, $relatedctxparams) = $DB->get_in_or_equal($coursecontext->get_parent_context_ids(true), SQL_PARAMS_NAMED, 'relatedctx');
148 list($gradebookroles_sql, $params) = $DB->get_in_or_equal(explode(',', $CFG->gradebookroles), SQL_PARAMS_NAMED, 'grbr');
78ab98bc 149 list($enrolledsql, $enrolledparams) = get_enrolled_sql($coursecontext, '', 0, $this->onlyactive);
656d17c2 150
4e829d48 151 $params = array_merge($params, $enrolledparams, $relatedctxparams);
0f5660f7 152
153 if ($this->groupid) {
d24832f9 154 $groupsql = "INNER JOIN {groups_members} gm ON gm.userid = u.id";
e58fcb35 155 $groupwheresql = "AND gm.groupid = :groupid";
d24832f9 156 // $params contents: gradebookroles
e58fcb35 157 $params['groupid'] = $this->groupid;
0f5660f7 158 } else {
159 $groupsql = "";
160 $groupwheresql = "";
161 }
162
345674ca 163 if (empty($this->sortfield1)) {
4e829d48 164 // We must do some sorting even if not specified.
345674ca 165 $ofields = ", u.id AS usrt";
166 $order = "usrt ASC";
167
168 } else {
169 $ofields = ", u.$this->sortfield1 AS usrt1";
170 $order = "usrt1 $this->sortorder1";
171 if (!empty($this->sortfield2)) {
0febb12d 172 $ofields .= ", u.$this->sortfield2 AS usrt2";
345674ca 173 $order .= ", usrt2 $this->sortorder2";
174 }
175 if ($this->sortfield1 != 'id' and $this->sortfield2 != 'id') {
4e829d48
MN
176 // User order MUST be the same in both queries,
177 // must include the only unique user->id if not already present.
345674ca 178 $ofields .= ", u.id AS usrt";
179 $order .= ", usrt ASC";
180 }
181 }
182
293f42b6
CF
183 $userfields = 'u.*';
184 $customfieldssql = '';
61c8e0d7
FM
185 if ($this->allowusercustomfields && !empty($CFG->grade_export_customprofilefields)) {
186 $customfieldscount = 0;
187 $customfieldsarray = grade_helper::get_user_profile_fields($this->course->id, $this->allowusercustomfields);
188 foreach ($customfieldsarray as $field) {
189 if (!empty($field->customid)) {
293f42b6 190 $customfieldssql .= "
61c8e0d7
FM
191 LEFT JOIN (SELECT * FROM {user_info_data}
192 WHERE fieldid = :cf$customfieldscount) cf$customfieldscount
193 ON u.id = cf$customfieldscount.userid";
c1735baf 194 $userfields .= ", cf$customfieldscount.data AS customfield_{$field->shortname}";
61c8e0d7
FM
195 $params['cf'.$customfieldscount] = $field->customid;
196 $customfieldscount++;
293f42b6
CF
197 }
198 }
199 }
200
293f42b6 201 $users_sql = "SELECT $userfields $ofields
d24832f9 202 FROM {user} u
656d17c2 203 JOIN ($enrolledsql) je ON je.id = u.id
293f42b6 204 $groupsql $customfieldssql
656d17c2
AD
205 JOIN (
206 SELECT DISTINCT ra.userid
207 FROM {role_assignments} ra
208 WHERE ra.roleid $gradebookroles_sql
4e829d48 209 AND ra.contextid $relatedctxsql
656d17c2
AD
210 ) rainner ON rainner.userid = u.id
211 WHERE u.deleted = 0
345674ca 212 $groupwheresql
213 ORDER BY $order";
d24832f9 214 $this->users_rs = $DB->get_recordset_sql($users_sql, $params);
0f5660f7 215
38c1dd19
RT
216 if (!$this->onlyactive) {
217 $context = context_course::instance($this->course->id);
218 $this->suspendedusers = get_suspended_userids($context);
219 } else {
220 $this->suspendedusers = array();
221 }
222
0f5660f7 223 if (!empty($this->grade_items)) {
224 $itemids = array_keys($this->grade_items);
cf717dc2 225 list($itemidsql, $grades_params) = $DB->get_in_or_equal($itemids, SQL_PARAMS_NAMED, 'items');
d24832f9 226 $params = array_merge($params, $grades_params);
0f5660f7 227
345674ca 228 $grades_sql = "SELECT g.* $ofields
d24832f9 229 FROM {grade_grades} g
656d17c2
AD
230 JOIN {user} u ON g.userid = u.id
231 JOIN ($enrolledsql) je ON je.id = u.id
0f5660f7 232 $groupsql
656d17c2
AD
233 JOIN (
234 SELECT DISTINCT ra.userid
235 FROM {role_assignments} ra
236 WHERE ra.roleid $gradebookroles_sql
4e829d48 237 AND ra.contextid $relatedctxsql
4f82032a 238 ) rainner ON rainner.userid = u.id
656d17c2
AD
239 WHERE u.deleted = 0
240 AND g.itemid $itemidsql
241 $groupwheresql
345674ca 242 ORDER BY $order, g.itemid ASC";
d24832f9 243 $this->grades_rs = $DB->get_recordset_sql($grades_sql, $params);
345674ca 244 } else {
245 $this->grades_rs = false;
0f5660f7 246 }
345674ca 247
0f5660f7 248 return true;
249 }
250
251 /**
252 * Returns information about the next user
253 * @return mixed array of user info, all grades and feedback or null when no more users found
254 */
728ff21b 255 public function next_user() {
03cedd62 256 if (!$this->users_rs) {
0f5660f7 257 return false; // no users present
258 }
259
5c75a0a3 260 if (!$this->users_rs->valid()) {
345674ca 261 if ($current = $this->_pop()) {
262 // this is not good - user or grades updated between the two reads above :-(
263 }
264
0f5660f7 265 return false; // no more users
5c75a0a3 266 } else {
267 $user = $this->users_rs->current();
268 $this->users_rs->next();
0f5660f7 269 }
270
345674ca 271 // find grades of this user
0f5660f7 272 $grade_records = array();
273 while (true) {
274 if (!$current = $this->_pop()) {
275 break; // no more grades
276 }
277
5c75a0a3 278 if (empty($current->userid)) {
279 break;
280 }
281
345674ca 282 if ($current->userid != $user->id) {
283 // grade of the next user, we have all for this user
0f5660f7 284 $this->_push($current);
285 break;
286 }
287
288 $grade_records[$current->itemid] = $current;
289 }
290
291 $grades = array();
292 $feedbacks = array();
293
d08bba83 294 if (!empty($this->grade_items)) {
345674ca 295 foreach ($this->grade_items as $grade_item) {
6189c7b4
FM
296 if (!isset($feedbacks[$grade_item->id])) {
297 $feedbacks[$grade_item->id] = new stdClass();
298 }
345674ca 299 if (array_key_exists($grade_item->id, $grade_records)) {
300 $feedbacks[$grade_item->id]->feedback = $grade_records[$grade_item->id]->feedback;
301 $feedbacks[$grade_item->id]->feedbackformat = $grade_records[$grade_item->id]->feedbackformat;
302 unset($grade_records[$grade_item->id]->feedback);
303 unset($grade_records[$grade_item->id]->feedbackformat);
304 $grades[$grade_item->id] = new grade_grade($grade_records[$grade_item->id], false);
305 } else {
306 $feedbacks[$grade_item->id]->feedback = '';
307 $feedbacks[$grade_item->id]->feedbackformat = FORMAT_MOODLE;
cf72e2dd 308 $grades[$grade_item->id] =
309 new grade_grade(array('userid'=>$user->id, 'itemid'=>$grade_item->id), false);
345674ca 310 }
0f5660f7 311 }
312 }
313
38c1dd19
RT
314 // Set user suspended status.
315 $user->suspendedenrolment = isset($this->suspendedusers[$user->id]);
ace9051c 316 $result = new stdClass();
0f5660f7 317 $result->user = $user;
318 $result->grades = $grades;
319 $result->feedbacks = $feedbacks;
0f5660f7 320 return $result;
321 }
322
323 /**
728ff21b 324 * Close the iterator, do not forget to call this function
0f5660f7 325 */
728ff21b 326 public function close() {
caffc55a 327 if ($this->users_rs) {
d24832f9 328 $this->users_rs->close();
caffc55a 329 $this->users_rs = null;
0f5660f7 330 }
caffc55a 331 if ($this->grades_rs) {
d24832f9 332 $this->grades_rs->close();
caffc55a 333 $this->grades_rs = null;
0f5660f7 334 }
335 $this->gradestack = array();
336 }
337
78ab98bc
AD
338 /**
339 * Should all enrolled users be exported or just those with an active enrolment?
340 *
341 * @param bool $onlyactive True to limit the export to users with an active enrolment
342 */
343 public function require_active_enrolment($onlyactive = true) {
344 if (!empty($this->users_rs)) {
345 debugging('Calling require_active_enrolment() has no effect unless you call init() again', DEBUG_DEVELOPER);
346 }
347 $this->onlyactive = $onlyactive;
348 }
349
61c8e0d7
FM
350 /**
351 * Allow custom fields to be included
352 *
353 * @param bool $allow Whether to allow custom fields or not
354 * @return void
355 */
356 public function allow_user_custom_fields($allow = true) {
357 if ($allow) {
358 $this->allowusercustomfields = true;
359 } else {
360 $this->allowusercustomfields = false;
361 }
362 }
cf72e2dd 363
0f5660f7 364 /**
728ff21b 365 * Add a grade_grade instance to the grade stack
cf72e2dd 366 *
367 * @param grade_grade $grade Grade object
368 *
369 * @return void
0f5660f7 370 */
728ff21b 371 private function _push($grade) {
0f5660f7 372 array_push($this->gradestack, $grade);
373 }
374
cf72e2dd 375
0f5660f7 376 /**
728ff21b 377 * Remove a grade_grade instance from the grade stack
cf72e2dd 378 *
728ff21b 379 * @return grade_grade current grade object
0f5660f7 380 */
728ff21b 381 private function _pop() {
d24832f9 382 global $DB;
0f5660f7 383 if (empty($this->gradestack)) {
8de7c8a7 384 if (empty($this->grades_rs) || !$this->grades_rs->valid()) {
cf72e2dd 385 return null; // no grades present
0f5660f7 386 }
387
7ce5df86
AD
388 $current = $this->grades_rs->current();
389
390 $this->grades_rs->next();
0f5660f7 391
7ce5df86 392 return $current;
0f5660f7 393 } else {
394 return array_pop($this->gradestack);
395 }
396 }
397}
398
d08bba83 399/**
400 * Print a selection popup form of the graded users in a course.
401 *
4d5059d4
SH
402 * @deprecated since 2.0
403 *
cf72e2dd 404 * @param int $course id of the course
d08bba83 405 * @param string $actionpage The page receiving the data from the popoup form
cf72e2dd 406 * @param int $userid id of the currently selected user (or 'all' if they are all selected)
407 * @param int $groupid id of requested group, 0 means all
408 * @param int $includeall bool include all option
409 * @param bool $return If true, will return the HTML, otherwise, will print directly
d08bba83 410 * @return null
411 */
7ac88172 412function print_graded_users_selector($course, $actionpage, $userid=0, $groupid=0, $includeall=true, $return=false) {
714b4745 413 global $CFG, $USER, $OUTPUT;
4d5059d4
SH
414 return $OUTPUT->render(grade_get_graded_users_select(substr($actionpage, 0, strpos($actionpage, '/')), $course, $userid, $groupid, $includeall));
415}
345674ca 416
4d5059d4 417function grade_get_graded_users_select($report, $course, $userid, $groupid, $includeall) {
4e829d48 418 global $USER, $CFG;
f9510667 419
879c99bb 420 if (is_null($userid)) {
421 $userid = $USER->id;
422 }
38c1dd19
RT
423 $coursecontext = context_course::instance($course->id);
424 $defaultgradeshowactiveenrol = !empty($CFG->grade_report_showonlyactiveenrol);
425 $showonlyactiveenrol = get_user_preferences('grade_report_showonlyactiveenrol', $defaultgradeshowactiveenrol);
426 $showonlyactiveenrol = $showonlyactiveenrol || !has_capability('moodle/course:viewsuspendedusers', $coursecontext);
d08bba83 427 $menu = array(); // Will be a list of userid => user name
38c1dd19 428 $menususpendedusers = array(); // Suspended users go to a separate optgroup.
772229f3 429 $gui = new graded_users_iterator($course, null, $groupid);
38c1dd19 430 $gui->require_active_enrolment($showonlyactiveenrol);
d08bba83 431 $gui->init();
10f5c046 432 $label = get_string('selectauser', 'grades');
7ac88172 433 if ($includeall) {
879c99bb 434 $menu[0] = get_string('allusers', 'grades');
10f5c046 435 $label = get_string('selectalloroneuser', 'grades');
d08bba83 436 }
d08bba83 437 while ($userdata = $gui->next_user()) {
438 $user = $userdata->user;
38c1dd19
RT
439 $userfullname = fullname($user);
440 if ($user->suspendedenrolment) {
441 $menususpendedusers[$user->id] = $userfullname;
442 } else {
443 $menu[$user->id] = $userfullname;
444 }
d08bba83 445 }
d08bba83 446 $gui->close();
447
7ac88172 448 if ($includeall) {
38c1dd19
RT
449 $menu[0] .= " (" . (count($menu) + count($menususpendedusers) - 1) . ")";
450 }
451
452 if (!empty($menususpendedusers)) {
453 $menu[] = array(get_string('suspendedusers') => $menususpendedusers);
879c99bb 454 }
4d5059d4 455 $select = new single_select(new moodle_url('/grade/report/'.$report.'/index.php', array('id'=>$course->id)), 'userid', $menu, $userid);
f8dab966
PS
456 $select->label = $label;
457 $select->formid = 'choosegradeuser';
4d5059d4 458 return $select;
d08bba83 459}
460
0610812a 461/**
462 * Print grading plugin selection popup form.
463 *
cf72e2dd 464 * @param array $plugin_info An array of plugins containing information for the selector
0610812a 465 * @param boolean $return return as string
cf72e2dd 466 *
0610812a 467 * @return nothing or string if $return true
468 */
f1a3e072 469function print_grade_plugin_selector($plugin_info, $active_type, $active_plugin, $return=false) {
714b4745 470 global $CFG, $OUTPUT, $PAGE;
dc482cfa 471
472 $menu = array();
473 $count = 0;
474 $active = '';
475
476 foreach ($plugin_info as $plugin_type => $plugins) {
477 if ($plugin_type == 'strings') {
478 continue;
479 }
480
7981d537 481 $first_plugin = reset($plugins);
dc482cfa 482
f1a3e072
PS
483 $sectionname = $plugin_info['strings'][$plugin_type];
484 $section = array();
d4dcfc6b 485
f1a3e072 486 foreach ($plugins as $plugin) {
d4dcfc6b 487 $link = $plugin->link->out(false);
f1a3e072
PS
488 $section[$link] = $plugin->string;
489 $count++;
490 if ($plugin_type === $active_type and $plugin->id === $active_plugin) {
491 $active = $link;
dc482cfa 492 }
493 }
f1a3e072
PS
494
495 if ($section) {
496 $menu[] = array($sectionname=>$section);
497 }
dc482cfa 498 }
499
cf72e2dd 500 // finally print/return the popup form
dc482cfa 501 if ($count > 1) {
f1a3e072 502 $select = new url_select($menu, $active, null, 'choosepluginreport');
29bea634 503 $select->set_label(get_string('gradereport', 'grades'), array('class' => 'accesshide'));
7981d537 504 if ($return) {
f1a3e072 505 return $OUTPUT->render($select);
7981d537 506 } else {
f1a3e072 507 echo $OUTPUT->render($select);
7981d537 508 }
dc482cfa 509 } else {
510 // only one option - no plugin selector needed
511 return '';
512 }
513}
514
515/**
516 * Print grading plugin selection tab-based navigation.
517 *
cf72e2dd 518 * @param string $active_type type of plugin on current page - import, export, report or edit
519 * @param string $active_plugin active plugin type - grader, user, cvs, ...
520 * @param array $plugin_info Array of plugins
dc482cfa 521 * @param boolean $return return as string
cf72e2dd 522 *
dc482cfa 523 * @return nothing or string if $return true
524 */
b827784e 525function grade_print_tabs($active_type, $active_plugin, $plugin_info, $return=false) {
dc482cfa 526 global $CFG, $COURSE;
1c1f64a2 527
e1513ca9 528 if (!isset($currenttab)) { //TODO: this is weird
dc482cfa 529 $currenttab = '';
530 }
531
532 $tabs = array();
533 $top_row = array();
534 $bottom_row = array();
535 $inactive = array($active_plugin);
536 $activated = array();
537
538 $count = 0;
539 $active = '';
540
541 foreach ($plugin_info as $plugin_type => $plugins) {
542 if ($plugin_type == 'strings') {
543 continue;
544 }
545
546 // If $plugins is actually the definition of a child-less parent link:
cf72e2dd 547 if (!empty($plugins->id)) {
548 $string = $plugins->string;
549 if (!empty($plugin_info[$active_type]->parent)) {
550 $string = $plugin_info[$active_type]->parent->string;
27eef3bb 551 }
552
cf72e2dd 553 $top_row[] = new tabobject($plugin_type, $plugins->link, $string);
dc482cfa 554 continue;
555 }
556
557 $first_plugin = reset($plugins);
cf72e2dd 558 $url = $first_plugin->link;
dc482cfa 559
560 if ($plugin_type == 'report') {
561 $url = $CFG->wwwroot.'/grade/report/index.php?id='.$COURSE->id;
562 }
563
564 $top_row[] = new tabobject($plugin_type, $url, $plugin_info['strings'][$plugin_type]);
565
566 if ($active_type == $plugin_type) {
567 foreach ($plugins as $plugin) {
cf72e2dd 568 $bottom_row[] = new tabobject($plugin->id, $plugin->link, $plugin->string);
569 if ($plugin->id == $active_plugin) {
570 $inactive = array($plugin->id);
dc482cfa 571 }
572 }
573 }
574 }
575
576 $tabs[] = $top_row;
577 $tabs[] = $bottom_row;
578
579 if ($return) {
580 return print_tabs($tabs, $active_type, $inactive, $activated, true);
581 } else {
582 print_tabs($tabs, $active_type, $inactive, $activated);
583 }
584}
585
cf72e2dd 586/**
587 * grade_get_plugin_info
588 *
589 * @param int $courseid The course id
590 * @param string $active_type type of plugin on current page - import, export, report or edit
591 * @param string $active_plugin active plugin type - grader, user, cvs, ...
592 *
593 * @return array
594 */
dc482cfa 595function grade_get_plugin_info($courseid, $active_type, $active_plugin) {
f7fcf4cd 596 global $CFG, $SITE;
cbff94ba 597
d4060472 598 $context = context_course::instance($courseid);
cbff94ba 599
dc482cfa 600 $plugin_info = array();
6e2f3121 601 $count = 0;
3af29899 602 $active = '';
dc482cfa 603 $url_prefix = $CFG->wwwroot . '/grade/';
604
605 // Language strings
4d5059d4 606 $plugin_info['strings'] = grade_helper::get_plugin_strings();
b827784e 607
4d5059d4
SH
608 if ($reports = grade_helper::get_plugins_reports($courseid)) {
609 $plugin_info['report'] = $reports;
b827784e 610 }
c46aeeab 611
f7fcf4cd
AD
612 //showing grade categories and items make no sense if we're not within a course
613 if ($courseid!=$SITE->id) {
614 if ($edittree = grade_helper::get_info_edit_structure($courseid)) {
615 $plugin_info['edittree'] = $edittree;
616 }
04678d8e 617 }
b827784e 618
4d5059d4
SH
619 if ($scale = grade_helper::get_info_scales($courseid)) {
620 $plugin_info['scale'] = array('view'=>$scale);
cbff94ba 621 }
dc482cfa 622
4d5059d4
SH
623 if ($outcomes = grade_helper::get_info_outcomes($courseid)) {
624 $plugin_info['outcome'] = $outcomes;
cbff94ba 625 }
cbff94ba 626
4d5059d4
SH
627 if ($letters = grade_helper::get_info_letters($courseid)) {
628 $plugin_info['letter'] = $letters;
cbff94ba 629 }
4d5059d4
SH
630
631 if ($imports = grade_helper::get_plugins_import($courseid)) {
632 $plugin_info['import'] = $imports;
281ffa4a 633 }
c46aeeab 634
4d5059d4
SH
635 if ($exports = grade_helper::get_plugins_export($courseid)) {
636 $plugin_info['export'] = $exports;
281ffa4a 637 }
281ffa4a 638
4d5059d4
SH
639 foreach ($plugin_info as $plugin_type => $plugins) {
640 if (!empty($plugins->id) && $active_plugin == $plugins->id) {
641 $plugin_info['strings']['active_plugin_str'] = $plugins->string;
642 break;
281ffa4a 643 }
4d5059d4
SH
644 foreach ($plugins as $plugin) {
645 if (is_a($plugin, 'grade_plugin_info')) {
646 if ($active_plugin == $plugin->id) {
647 $plugin_info['strings']['active_plugin_str'] = $plugin->string;
648 }
3af29899 649 }
281ffa4a 650 }
cbff94ba 651 }
c46aeeab 652
f7fcf4cd
AD
653 //hide course settings if we're not in a course
654 if ($courseid!=$SITE->id) {
655 if ($setting = grade_helper::get_info_manage_settings($courseid)) {
656 $plugin_info['settings'] = array('course'=>$setting);
657 }
281ffa4a 658 }
cbff94ba 659
4d5059d4
SH
660 // Put preferences last
661 if ($preferences = grade_helper::get_plugins_report_preferences($courseid)) {
662 $plugin_info['preferences'] = $preferences;
27eef3bb 663 }
664
dc482cfa 665 foreach ($plugin_info as $plugin_type => $plugins) {
cf72e2dd 666 if (!empty($plugins->id) && $active_plugin == $plugins->id) {
667 $plugin_info['strings']['active_plugin_str'] = $plugins->string;
dc482cfa 668 break;
78ad5f3f 669 }
dc482cfa 670 foreach ($plugins as $plugin) {
cf72e2dd 671 if (is_a($plugin, 'grade_plugin_info')) {
672 if ($active_plugin == $plugin->id) {
673 $plugin_info['strings']['active_plugin_str'] = $plugin->string;
674 }
78ad5f3f 675 }
78ad5f3f 676 }
dc482cfa 677 }
78ad5f3f 678
dc482cfa 679 return $plugin_info;
680}
284abb09 681
cf72e2dd 682/**
683 * A simple class containing info about grade plugins.
684 * Can be subclassed for special rules
685 *
a153c9f2 686 * @package core_grades
cf72e2dd 687 * @copyright 2009 Nicolas Connault
688 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
689 */
690class grade_plugin_info {
691 /**
692 * A unique id for this plugin
693 *
694 * @var mixed
695 */
696 public $id;
697 /**
698 * A URL to access this plugin
699 *
700 * @var mixed
701 */
702 public $link;
703 /**
704 * The name of this plugin
705 *
706 * @var mixed
707 */
708 public $string;
709 /**
710 * Another grade_plugin_info object, parent of the current one
711 *
712 * @var mixed
713 */
714 public $parent;
715
716 /**
717 * Constructor
718 *
719 * @param int $id A unique id for this plugin
720 * @param string $link A URL to access this plugin
721 * @param string $string The name of this plugin
722 * @param object $parent Another grade_plugin_info object, parent of the current one
723 *
724 * @return void
725 */
726 public function __construct($id, $link, $string, $parent=null) {
727 $this->id = $id;
728 $this->link = $link;
729 $this->string = $string;
730 $this->parent = $parent;
731 }
732}
733
de0300ea 734/**
735 * Prints the page headers, breadcrumb trail, page heading, (optional) dropdown navigation menu and
736 * (optional) navigation tabs for any gradebook page. All gradebook pages MUST use these functions
737 * in favour of the usual print_header(), print_header_simple(), print_heading() etc.
738 * !IMPORTANT! Use of tabs.php file in gradebook pages is forbidden unless tabs are switched off at
739 * the site level for the gradebook ($CFG->grade_navmethod = GRADE_NAVMETHOD_DROPDOWN).
740 *
cf72e2dd 741 * @param int $courseid Course id
742 * @param string $active_type The type of the current page (report, settings,
743 * import, export, scales, outcomes, letters)
744 * @param string $active_plugin The plugin of the current page (grader, fullview etc...)
745 * @param string $heading The heading of the page. Tries to guess if none is given
de0300ea 746 * @param boolean $return Whether to return (true) or echo (false) the HTML generated by this function
cf72e2dd 747 * @param string $bodytags Additional attributes that will be added to the <body> tag
748 * @param string $buttons Additional buttons to display on the page
5625d33d 749 * @param boolean $shownavigation should the gradebook navigation drop down (or tabs) be shown?
de0300ea 750 *
751 * @return string HTML code or nothing if $return == false
752 */
cf72e2dd 753function print_grade_page_head($courseid, $active_type, $active_plugin=null,
34a2777c 754 $heading = false, $return=false,
2821c495 755 $buttons=false, $shownavigation=true) {
4d5059d4 756 global $CFG, $OUTPUT, $PAGE;
c46aeeab 757
dc482cfa 758 $plugin_info = grade_get_plugin_info($courseid, $active_type, $active_plugin);
c46aeeab 759
dc482cfa 760 // Determine the string of the active plugin
761 $stractive_plugin = ($active_plugin) ? $plugin_info['strings']['active_plugin_str'] : $heading;
762 $stractive_type = $plugin_info['strings'][$active_type];
e0724506 763
cf72e2dd 764 if (empty($plugin_info[$active_type]->id) || !empty($plugin_info[$active_type]->parent)) {
4d5059d4
SH
765 $title = $PAGE->course->fullname.': ' . $stractive_type . ': ' . $stractive_plugin;
766 } else {
767 $title = $PAGE->course->fullname.': ' . $stractive_plugin;
c4c97a6d 768 }
769
367a75fa
SH
770 if ($active_type == 'report') {
771 $PAGE->set_pagelayout('report');
772 } else {
773 $PAGE->set_pagelayout('admin');
774 }
4d5059d4 775 $PAGE->set_title(get_string('grades') . ': ' . $stractive_type);
f3df5e14 776 $PAGE->set_heading($title);
4d5059d4
SH
777 if ($buttons instanceof single_button) {
778 $buttons = $OUTPUT->render($buttons);
779 }
f3df5e14 780 $PAGE->set_button($buttons);
4d5059d4
SH
781 grade_extend_settings($plugin_info, $courseid);
782
f3df5e14 783 $returnval = $OUTPUT->header();
784 if (!$return) {
785 echo $returnval;
786 }
dc482cfa 787
788 // Guess heading if not given explicitly
789 if (!$heading) {
790 $heading = $stractive_plugin;
791 }
792
2821c495
AD
793 if ($shownavigation) {
794 if ($CFG->grade_navmethod == GRADE_NAVMETHOD_COMBO || $CFG->grade_navmethod == GRADE_NAVMETHOD_DROPDOWN) {
795 $returnval .= print_grade_plugin_selector($plugin_info, $active_type, $active_plugin, $return);
796 }
5625d33d
AD
797
798 if ($return) {
799 $returnval .= $OUTPUT->heading($heading);
800 } else {
e59a1dd6 801 echo $OUTPUT->heading($heading);
5625d33d
AD
802 }
803
2821c495
AD
804 if ($CFG->grade_navmethod == GRADE_NAVMETHOD_COMBO || $CFG->grade_navmethod == GRADE_NAVMETHOD_TABS) {
805 $returnval .= grade_print_tabs($active_type, $active_plugin, $plugin_info, $return);
806 }
8354e716 807 }
dc482cfa 808
809 if ($return) {
810 return $returnval;
6e2f3121 811 }
cbff94ba 812}
813
0610812a 814/**
7a6b7acf 815 * Utility class used for return tracking when using edit and other forms in grade plugins
cf72e2dd 816 *
a153c9f2 817 * @package core_grades
cf72e2dd 818 * @copyright 2009 Nicolas Connault
819 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
0610812a 820 */
3af29899 821class grade_plugin_return {
d24832f9 822 public $type;
823 public $plugin;
824 public $courseid;
825 public $userid;
826 public $page;
281ffa4a 827
0610812a 828 /**
829 * Constructor
cf72e2dd 830 *
0610812a 831 * @param array $params - associative array with return parameters, if null parameter are taken from _GET or _POST
832 */
cf72e2dd 833 public function grade_plugin_return($params = null) {
3af29899 834 if (empty($params)) {
835 $this->type = optional_param('gpr_type', null, PARAM_SAFEDIR);
aff24313 836 $this->plugin = optional_param('gpr_plugin', null, PARAM_PLUGIN);
3af29899 837 $this->courseid = optional_param('gpr_courseid', null, PARAM_INT);
838 $this->userid = optional_param('gpr_userid', null, PARAM_INT);
839 $this->page = optional_param('gpr_page', null, PARAM_INT);
a983b6ec 840
a983b6ec 841 } else {
3af29899 842 foreach ($params as $key=>$value) {
4cc977a6 843 if (property_exists($this, $key)) {
3af29899 844 $this->$key = $value;
845 }
cbff94ba 846 }
847 }
6cd8c592 848 }
849
0610812a 850 /**
851 * Returns return parameters as options array suitable for buttons.
852 * @return array options
853 */
d24832f9 854 public function get_options() {
7a6b7acf 855 if (empty($this->type)) {
3af29899 856 return array();
865e9a82 857 }
6cd8c592 858
3af29899 859 $params = array();
6cd8c592 860
7a6b7acf 861 if (!empty($this->plugin)) {
862 $params['plugin'] = $this->plugin;
863 }
6cd8c592 864
3af29899 865 if (!empty($this->courseid)) {
866 $params['id'] = $this->courseid;
6cd8c592 867 }
9c61ba4d 868
3af29899 869 if (!empty($this->userid)) {
870 $params['userid'] = $this->userid;
9c61ba4d 871 }
9c61ba4d 872
3af29899 873 if (!empty($this->page)) {
874 $params['page'] = $this->page;
cbff94ba 875 }
865e9a82 876
3af29899 877 return $params;
cbff94ba 878 }
cbff94ba 879
0610812a 880 /**
881 * Returns return url
cf72e2dd 882 *
0610812a 883 * @param string $default default url when params not set
cf72e2dd 884 * @param array $extras Extra URL parameters
885 *
0610812a 886 * @return string url
887 */
d24832f9 888 public function get_return_url($default, $extras=null) {
3af29899 889 global $CFG;
cbff94ba 890
3af29899 891 if (empty($this->type) or empty($this->plugin)) {
892 return $default;
cbff94ba 893 }
894
65dd61bd 895 $url = $CFG->wwwroot.'/grade/'.$this->type.'/'.$this->plugin.'/index.php';
896 $glue = '?';
cbff94ba 897
3af29899 898 if (!empty($this->courseid)) {
899 $url .= $glue.'id='.$this->courseid;
900 $glue = '&amp;';
cbff94ba 901 }
cbff94ba 902
3af29899 903 if (!empty($this->userid)) {
904 $url .= $glue.'userid='.$this->userid;
905 $glue = '&amp;';
cbff94ba 906 }
7e2d7c92 907
3af29899 908 if (!empty($this->page)) {
909 $url .= $glue.'page='.$this->page;
65dd61bd 910 $glue = '&amp;';
911 }
912
913 if (!empty($extras)) {
cf72e2dd 914 foreach ($extras as $key=>$value) {
65dd61bd 915 $url .= $glue.$key.'='.$value;
916 $glue = '&amp;';
7a6b7acf 917 }
cbff94ba 918 }
cbff94ba 919
3af29899 920 return $url;
cbff94ba 921 }
cbff94ba 922
0610812a 923 /**
924 * Returns string with hidden return tracking form elements.
925 * @return string
926 */
d24832f9 927 public function get_form_fields() {
7a6b7acf 928 if (empty($this->type)) {
3af29899 929 return '';
cbff94ba 930 }
cbff94ba 931
3af29899 932 $result = '<input type="hidden" name="gpr_type" value="'.$this->type.'" />';
7a6b7acf 933
934 if (!empty($this->plugin)) {
935 $result .= '<input type="hidden" name="gpr_plugin" value="'.$this->plugin.'" />';
936 }
0ca5abd6 937
3af29899 938 if (!empty($this->courseid)) {
939 $result .= '<input type="hidden" name="gpr_courseid" value="'.$this->courseid.'" />';
cbff94ba 940 }
cbff94ba 941
3af29899 942 if (!empty($this->userid)) {
943 $result .= '<input type="hidden" name="gpr_userid" value="'.$this->userid.'" />';
cbff94ba 944 }
cbff94ba 945
3af29899 946 if (!empty($this->page)) {
947 $result .= '<input type="hidden" name="gpr_page" value="'.$this->page.'" />';
cbff94ba 948 }
949 }
cbff94ba 950
0610812a 951 /**
952 * Add hidden elements into mform
cf72e2dd 953 *
954 * @param object &$mform moodle form object
955 *
0610812a 956 * @return void
957 */
d24832f9 958 public function add_mform_elements(&$mform) {
7a6b7acf 959 if (empty($this->type)) {
3af29899 960 return;
cbff94ba 961 }
cbff94ba 962
3af29899 963 $mform->addElement('hidden', 'gpr_type', $this->type);
964 $mform->setType('gpr_type', PARAM_SAFEDIR);
cbff94ba 965
7a6b7acf 966 if (!empty($this->plugin)) {
967 $mform->addElement('hidden', 'gpr_plugin', $this->plugin);
aff24313 968 $mform->setType('gpr_plugin', PARAM_PLUGIN);
7a6b7acf 969 }
97033c86 970
3af29899 971 if (!empty($this->courseid)) {
972 $mform->addElement('hidden', 'gpr_courseid', $this->courseid);
973 $mform->setType('gpr_courseid', PARAM_INT);
cbff94ba 974 }
cbff94ba 975
3af29899 976 if (!empty($this->userid)) {
977 $mform->addElement('hidden', 'gpr_userid', $this->userid);
978 $mform->setType('gpr_userid', PARAM_INT);
cbff94ba 979 }
cbff94ba 980
3af29899 981 if (!empty($this->page)) {
982 $mform->addElement('hidden', 'gpr_page', $this->page);
983 $mform->setType('gpr_page', PARAM_INT);
cbff94ba 984 }
985 }
281ffa4a 986
0610812a 987 /**
988 * Add return tracking params into url
cf72e2dd 989 *
1c1f64a2 990 * @param moodle_url $url A URL
cf72e2dd 991 *
6ef4878b 992 * @return string $url with return tracking params
0610812a 993 */
1c1f64a2 994 public function add_url_params(moodle_url $url) {
7a6b7acf 995 if (empty($this->type)) {
3af29899 996 return $url;
cbff94ba 997 }
5609f9e6 998
1c1f64a2 999 $url->param('gpr_type', $this->type);
cbff94ba 1000
7a6b7acf 1001 if (!empty($this->plugin)) {
1c1f64a2 1002 $url->param('gpr_plugin', $this->plugin);
7a6b7acf 1003 }
cbff94ba 1004
3af29899 1005 if (!empty($this->courseid)) {
1c1f64a2 1006 $url->param('gpr_courseid' ,$this->courseid);
cbff94ba 1007 }
cbff94ba 1008
3af29899 1009 if (!empty($this->userid)) {
1c1f64a2 1010 $url->param('gpr_userid', $this->userid);
cbff94ba 1011 }
0a8a95c9 1012
3af29899 1013 if (!empty($this->page)) {
1c1f64a2 1014 $url->param('gpr_page', $this->page);
0a8a95c9 1015 }
5a412dbf 1016
3af29899 1017 return $url;
5a412dbf 1018 }
5a412dbf 1019}
7a6b7acf 1020
826c5f86 1021/**
1022 * Function central to gradebook for building and printing the navigation (breadcrumb trail).
cf72e2dd 1023 *
826c5f86 1024 * @param string $path The path of the calling script (using __FILE__?)
1025 * @param string $pagename The language string to use as the last part of the navigation (non-link)
cf72e2dd 1026 * @param mixed $id Either a plain integer (assuming the key is 'id') or
1027 * an array of keys and values (e.g courseid => $courseid, itemid...)
1028 *
826c5f86 1029 * @return string
1030 */
1031function grade_build_nav($path, $pagename=null, $id=null) {
f3df5e14 1032 global $CFG, $COURSE, $PAGE;
826c5f86 1033
1034 $strgrades = get_string('grades', 'grades');
1035
1036 // Parse the path and build navlinks from its elements
1037 $dirroot_length = strlen($CFG->dirroot) + 1; // Add 1 for the first slash
1038 $path = substr($path, $dirroot_length);
1039 $path = str_replace('\\', '/', $path);
1040
1041 $path_elements = explode('/', $path);
1042
1043 $path_elements_count = count($path_elements);
1044
826c5f86 1045 // First link is always 'grade'
a6855934 1046 $PAGE->navbar->add($strgrades, new moodle_url('/grade/index.php', array('id'=>$COURSE->id)));
826c5f86 1047
f3df5e14 1048 $link = null;
826c5f86 1049 $numberofelements = 3;
1050
1051 // Prepare URL params string
f3df5e14 1052 $linkparams = array();
826c5f86 1053 if (!is_null($id)) {
1054 if (is_array($id)) {
1055 foreach ($id as $idkey => $idvalue) {
f3df5e14 1056 $linkparams[$idkey] = $idvalue;
826c5f86 1057 }
1058 } else {
f3df5e14 1059 $linkparams['id'] = $id;
826c5f86 1060 }
1061 }
1062
1063 $navlink4 = null;
1064
0f78c4de 1065 // Remove file extensions from filenames
1066 foreach ($path_elements as $key => $filename) {
1067 $path_elements[$key] = str_replace('.php', '', $filename);
1068 }
1069
826c5f86 1070 // Second level links
1071 switch ($path_elements[1]) {
1072 case 'edit': // No link
1073 if ($path_elements[3] != 'index.php') {
1074 $numberofelements = 4;
1075 }
1076 break;
1077 case 'import': // No link
1078 break;
1079 case 'export': // No link
1080 break;
1081 case 'report':
1082 // $id is required for this link. Do not print it if $id isn't given
1083 if (!is_null($id)) {
a6855934 1084 $link = new moodle_url('/grade/report/index.php', $linkparams);
826c5f86 1085 }
1086
1087 if ($path_elements[2] == 'grader') {
1088 $numberofelements = 4;
1089 }
1090 break;
1091
1092 default:
1093 // If this element isn't among the ones already listed above, it isn't supported, throw an error.
cf72e2dd 1094 debugging("grade_build_nav() doesn't support ". $path_elements[1] .
1095 " as the second path element after 'grade'.");
826c5f86 1096 return false;
1097 }
f3df5e14 1098 $PAGE->navbar->add(get_string($path_elements[1], 'grades'), $link);
826c5f86 1099
1100 // Third level links
1101 if (empty($pagename)) {
1102 $pagename = get_string($path_elements[2], 'grades');
1103 }
1104
1105 switch ($numberofelements) {
1106 case 3:
f3df5e14 1107 $PAGE->navbar->add($pagename, $link);
826c5f86 1108 break;
1109 case 4:
826c5f86 1110 if ($path_elements[2] == 'grader' AND $path_elements[3] != 'index.php') {
b5e7b2bf 1111 $PAGE->navbar->add(get_string('pluginname', 'gradereport_grader'), new moodle_url('/grade/report/grader/index.php', $linkparams));
826c5f86 1112 }
f3df5e14 1113 $PAGE->navbar->add($pagename);
826c5f86 1114 break;
1115 }
826c5f86 1116
f3df5e14 1117 return '';
d4795a07 1118}
7a6b7acf 1119
e98871a2 1120/**
6cc3e350 1121 * General structure representing grade items in course
cf72e2dd 1122 *
a153c9f2 1123 * @package core_grades
cf72e2dd 1124 * @copyright 2009 Nicolas Connault
1125 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
e98871a2 1126 */
6cc3e350 1127class grade_structure {
d24832f9 1128 public $context;
e98871a2 1129
d24832f9 1130 public $courseid;
e98871a2 1131
73ca5f01 1132 /**
1133 * Reference to modinfo for current course (for performance, to save
1134 * retrieving it from courseid every time). Not actually set except for
1135 * the grade_tree type.
1136 * @var course_modinfo
1137 */
1138 public $modinfo;
1139
e98871a2 1140 /**
1141 * 1D array of grade items only
1142 */
d24832f9 1143 public $items;
e98871a2 1144
6391ebe7 1145 /**
6cc3e350 1146 * Returns icon of element
cf72e2dd 1147 *
1148 * @param array &$element An array representing an element in the grade_tree
1149 * @param bool $spacerifnone return spacer if no icon found
1150 *
6cc3e350 1151 * @return string icon or spacer
6391ebe7 1152 */
d24832f9 1153 public function get_element_icon(&$element, $spacerifnone=false) {
6b608f8f 1154 global $CFG, $OUTPUT;
559276b1 1155 require_once $CFG->libdir.'/filelib.php';
6cc3e350 1156
1157 switch ($element['type']) {
1158 case 'item':
1159 case 'courseitem':
1160 case 'categoryitem':
cf72e2dd 1161 $is_course = $element['object']->is_course_item();
1162 $is_category = $element['object']->is_category_item();
1163 $is_scale = $element['object']->gradetype == GRADE_TYPE_SCALE;
1164 $is_value = $element['object']->gradetype == GRADE_TYPE_VALUE;
0077f571 1165 $is_outcome = !empty($element['object']->outcomeid);
cf72e2dd 1166
6cc3e350 1167 if ($element['object']->is_calculated()) {
dc482cfa 1168 $strcalc = get_string('calculatedgrade', 'grades');
b5d0cafc 1169 return '<img src="'.$OUTPUT->pix_url('i/calc') . '" class="icon itemicon" title="'.
cf72e2dd 1170 s($strcalc).'" alt="'.s($strcalc).'"/>';
6cc3e350 1171
cf72e2dd 1172 } else if (($is_course or $is_category) and ($is_scale or $is_value)) {
6cc3e350 1173 if ($category = $element['object']->get_item_category()) {
1174 switch ($category->aggregation) {
1175 case GRADE_AGGREGATE_MEAN:
1176 case GRADE_AGGREGATE_MEDIAN:
1177 case GRADE_AGGREGATE_WEIGHTED_MEAN:
1426edac 1178 case GRADE_AGGREGATE_WEIGHTED_MEAN2:
6cc3e350 1179 case GRADE_AGGREGATE_EXTRACREDIT_MEAN:
dc482cfa 1180 $stragg = get_string('aggregation', 'grades');
b5d0cafc 1181 return '<img src="'.$OUTPUT->pix_url('i/agg_mean') . '" ' .
cf72e2dd 1182 'class="icon itemicon" title="'.s($stragg).'" alt="'.s($stragg).'"/>';
0758a08e 1183 case GRADE_AGGREGATE_SUM:
dc482cfa 1184 $stragg = get_string('aggregation', 'grades');
b5d0cafc 1185 return '<img src="'.$OUTPUT->pix_url('i/agg_sum') . '" ' .
cf72e2dd 1186 'class="icon itemicon" title="'.s($stragg).'" alt="'.s($stragg).'"/>';
6cc3e350 1187 }
1188 }
1189
1190 } else if ($element['object']->itemtype == 'mod') {
0077f571
AD
1191 //prevent outcomes being displaying the same icon as the activity they are attached to
1192 if ($is_outcome) {
1193 $stroutcome = s(get_string('outcome', 'grades'));
1194 return '<img src="'.$OUTPUT->pix_url('i/outcomes') . '" ' .
1195 'class="icon itemicon" title="'.$stroutcome.
1196 '" alt="'.$stroutcome.'"/>';
1197 } else {
1198 $strmodname = get_string('modulename', $element['object']->itemmodule);
1199 return '<img src="'.$OUTPUT->pix_url('icon',
e63f88c9 1200 $element['object']->itemmodule) . '" ' .
cf72e2dd 1201 'class="icon itemicon" title="' .s($strmodname).
1202 '" alt="' .s($strmodname).'"/>';
0077f571 1203 }
6cc3e350 1204 } else if ($element['object']->itemtype == 'manual') {
1205 if ($element['object']->is_outcome_item()) {
dc482cfa 1206 $stroutcome = get_string('outcome', 'grades');
b5d0cafc 1207 return '<img src="'.$OUTPUT->pix_url('i/outcomes') . '" ' .
cf72e2dd 1208 'class="icon itemicon" title="'.s($stroutcome).
1209 '" alt="'.s($stroutcome).'"/>';
6cc3e350 1210 } else {
dc482cfa 1211 $strmanual = get_string('manualitem', 'grades');
0cddd851 1212 return '<img src="'.$OUTPUT->pix_url('i/manual_item') . '" '.
cf72e2dd 1213 'class="icon itemicon" title="'.s($strmanual).
1214 '" alt="'.s($strmanual).'"/>';
6cc3e350 1215 }
1216 }
1217 break;
1218
1219 case 'category':
dc482cfa 1220 $strcat = get_string('category', 'grades');
0cddd851 1221 return '<img src="'.$OUTPUT->pix_url('i/folder') . '" class="icon itemicon" ' .
cf72e2dd 1222 'title="'.s($strcat).'" alt="'.s($strcat).'" />';
6cc3e350 1223 }
1224
1225 if ($spacerifnone) {
b11681e0 1226 return $OUTPUT->spacer().' ';
6cc3e350 1227 } else {
1228 return '';
1229 }
1230 }
6391ebe7 1231
e98871a2 1232 /**
6cc3e350 1233 * Returns name of element optionally with icon and link
cf72e2dd 1234 *
1235 * @param array &$element An array representing an element in the grade_tree
1236 * @param bool $withlink Whether or not this header has a link
1237 * @param bool $icon Whether or not to display an icon with this header
1238 * @param bool $spacerifnone return spacer if no icon found
1239 *
1240 * @return string header
e98871a2 1241 */
d24832f9 1242 public function get_element_header(&$element, $withlink=false, $icon=true, $spacerifnone=false) {
6cc3e350 1243 $header = '';
1244
1245 if ($icon) {
1246 $header .= $this->get_element_icon($element, $spacerifnone);
1247 }
1248
dc482cfa 1249 $header .= $element['object']->get_name();
6cc3e350 1250
cf72e2dd 1251 if ($element['type'] != 'item' and $element['type'] != 'categoryitem' and
1252 $element['type'] != 'courseitem') {
6cc3e350 1253 return $header;
1254 }
1255
73ca5f01 1256 if ($withlink) {
1257 $url = $this->get_activity_link($element);
1258 if ($url) {
ace9051c 1259 $a = new stdClass();
45a639d5 1260 $a->name = get_string('modulename', $element['object']->itemmodule);
dc482cfa 1261 $title = get_string('linktoactivity', 'grades', $a);
6cc3e350 1262
73ca5f01 1263 $header = html_writer::link($url, $header, array('title' => $title));
46d1af82 1264 }
6cc3e350 1265 }
1266
1267 return $header;
1268 }
1269
73ca5f01 1270 private function get_activity_link($element) {
1271 global $CFG;
eff314b0
DM
1272 /** @var array static cache of the grade.php file existence flags */
1273 static $hasgradephp = array();
73ca5f01 1274
1275 $itemtype = $element['object']->itemtype;
1276 $itemmodule = $element['object']->itemmodule;
1277 $iteminstance = $element['object']->iteminstance;
25ab1d50 1278 $itemnumber = $element['object']->itemnumber;
73ca5f01 1279
1280 // Links only for module items that have valid instance, module and are
1281 // called from grade_tree with valid modinfo
1282 if ($itemtype != 'mod' || !$iteminstance || !$itemmodule || !$this->modinfo) {
1283 return null;
1284 }
1285
1286 // Get $cm efficiently and with visibility information using modinfo
1287 $instances = $this->modinfo->get_instances();
1288 if (empty($instances[$itemmodule][$iteminstance])) {
1289 return null;
1290 }
1291 $cm = $instances[$itemmodule][$iteminstance];
1292
1293 // Do not add link if activity is not visible to the current user
1294 if (!$cm->uservisible) {
1295 return null;
1296 }
1297
eff314b0
DM
1298 if (!array_key_exists($itemmodule, $hasgradephp)) {
1299 if (file_exists($CFG->dirroot . '/mod/' . $itemmodule . '/grade.php')) {
1300 $hasgradephp[$itemmodule] = true;
1301 } else {
1302 $hasgradephp[$itemmodule] = false;
1303 }
1304 }
1305
73ca5f01 1306 // If module has grade.php, link to that, otherwise view.php
eff314b0 1307 if ($hasgradephp[$itemmodule]) {
c97933ff
MG
1308 $args = array('id' => $cm->id, 'itemnumber' => $itemnumber);
1309 if (isset($element['userid'])) {
1310 $args['userid'] = $element['userid'];
1311 }
1312 return new moodle_url('/mod/' . $itemmodule . '/grade.php', $args);
73ca5f01 1313 } else {
1314 return new moodle_url('/mod/' . $itemmodule . '/view.php', array('id' => $cm->id));
1315 }
1316 }
1317
bb17ac1e
DM
1318 /**
1319 * Returns URL of a page that is supposed to contain detailed grade analysis
1320 *
bb17ac1e
DM
1321 * At the moment, only activity modules are supported. The method generates link
1322 * to the module's file grade.php with the parameters id (cmid), itemid, itemnumber,
eff314b0 1323 * gradeid and userid. If the grade.php does not exist, null is returned.
bb17ac1e
DM
1324 *
1325 * @return moodle_url|null URL or null if unable to construct it
1326 */
1327 public function get_grade_analysis_url(grade_grade $grade) {
eff314b0
DM
1328 global $CFG;
1329 /** @var array static cache of the grade.php file existence flags */
1330 static $hasgradephp = array();
bb17ac1e
DM
1331
1332 if (empty($grade->grade_item) or !($grade->grade_item instanceof grade_item)) {
1333 throw new coding_exception('Passed grade without the associated grade item');
1334 }
1335 $item = $grade->grade_item;
1336
1337 if (!$item->is_external_item()) {
1338 // at the moment, only activity modules are supported
1339 return null;
1340 }
1341 if ($item->itemtype !== 'mod') {
1342 throw new coding_exception('Unknown external itemtype: '.$item->itemtype);
1343 }
1344 if (empty($item->iteminstance) or empty($item->itemmodule) or empty($this->modinfo)) {
1345 return null;
1346 }
1347
eff314b0
DM
1348 if (!array_key_exists($item->itemmodule, $hasgradephp)) {
1349 if (file_exists($CFG->dirroot . '/mod/' . $item->itemmodule . '/grade.php')) {
1350 $hasgradephp[$item->itemmodule] = true;
1351 } else {
1352 $hasgradephp[$item->itemmodule] = false;
1353 }
1354 }
1355
1356 if (!$hasgradephp[$item->itemmodule]) {
1357 return null;
1358 }
1359
bb17ac1e
DM
1360 $instances = $this->modinfo->get_instances();
1361 if (empty($instances[$item->itemmodule][$item->iteminstance])) {
1362 return null;
1363 }
1364 $cm = $instances[$item->itemmodule][$item->iteminstance];
1365 if (!$cm->uservisible) {
1366 return null;
1367 }
1368
1369 $url = new moodle_url('/mod/'.$item->itemmodule.'/grade.php', array(
1370 'id' => $cm->id,
1371 'itemid' => $item->id,
1372 'itemnumber' => $item->itemnumber,
1373 'gradeid' => $grade->id,
1374 'userid' => $grade->userid,
1375 ));
1376
1377 return $url;
1378 }
1379
1380 /**
1381 * Returns an action icon leading to the grade analysis page
1382 *
1383 * @param grade_grade $grade
1384 * @return string
1385 */
1386 public function get_grade_analysis_icon(grade_grade $grade) {
1387 global $OUTPUT;
1388
1389 $url = $this->get_grade_analysis_url($grade);
1390 if (is_null($url)) {
1391 return '';
1392 }
1393
c97933ff 1394 return $OUTPUT->action_icon($url, new pix_icon('t/preview',
bb17ac1e
DM
1395 get_string('gradeanalysis', 'core_grades')));
1396 }
1397
6cc3e350 1398 /**
1399 * Returns the grade eid - the grade may not exist yet.
cf72e2dd 1400 *
1401 * @param grade_grade $grade_grade A grade_grade object
1402 *
6cc3e350 1403 * @return string eid
1404 */
d24832f9 1405 public function get_grade_eid($grade_grade) {
6cc3e350 1406 if (empty($grade_grade->id)) {
1407 return 'n'.$grade_grade->itemid.'u'.$grade_grade->userid;
1408 } else {
1409 return 'g'.$grade_grade->id;
1410 }
1411 }
1412
1413 /**
1414 * Returns the grade_item eid
cf72e2dd 1415 * @param grade_item $grade_item A grade_item object
6cc3e350 1416 * @return string eid
1417 */
d24832f9 1418 public function get_item_eid($grade_item) {
6cc3e350 1419 return 'i'.$grade_item->id;
1420 }
1421
cf72e2dd 1422 /**
1423 * Given a grade_tree element, returns an array of parameters
1424 * used to build an icon for that element.
1425 *
1426 * @param array $element An array representing an element in the grade_tree
1427 *
1428 * @return array
1429 */
1430 public function get_params_for_iconstr($element) {
9ecd4386 1431 $strparams = new stdClass();
1432 $strparams->category = '';
1433 $strparams->itemname = '';
1434 $strparams->itemmodule = '';
cf72e2dd 1435
9ecd4386 1436 if (!method_exists($element['object'], 'get_name')) {
1437 return $strparams;
1438 }
345674ca 1439
b285c5aa 1440 $strparams->itemname = html_to_text($element['object']->get_name());
9ecd4386 1441
1442 // If element name is categorytotal, get the name of the parent category
1443 if ($strparams->itemname == get_string('categorytotal', 'grades')) {
1444 $parent = $element['object']->get_parent_category();
1445 $strparams->category = $parent->get_name() . ' ';
1446 } else {
1447 $strparams->category = '';
1448 }
1449
1450 $strparams->itemmodule = null;
1451 if (isset($element['object']->itemmodule)) {
1452 $strparams->itemmodule = $element['object']->itemmodule;
345674ca 1453 }
9ecd4386 1454 return $strparams;
1455 }
1456
6cc3e350 1457 /**
1458 * Return edit icon for give element
cf72e2dd 1459 *
1460 * @param array $element An array representing an element in the grade_tree
1461 * @param object $gpr A grade_plugin_return object
1462 *
6cc3e350 1463 * @return string
1464 */
d24832f9 1465 public function get_edit_icon($element, $gpr) {
6b608f8f 1466 global $CFG, $OUTPUT;
6cc3e350 1467
1468 if (!has_capability('moodle/grade:manage', $this->context)) {
1469 if ($element['type'] == 'grade' and has_capability('moodle/grade:edit', $this->context)) {
1470 // oki - let them override grade
1471 } else {
1472 return '';
1473 }
1474 }
1475
05aba805 1476 static $strfeedback = null;
1477 static $streditgrade = null;
1478 if (is_null($streditgrade)) {
1479 $streditgrade = get_string('editgrade', 'grades');
1480 $strfeedback = get_string('feedback');
6cc3e350 1481 }
1482
9ecd4386 1483 $strparams = $this->get_params_for_iconstr($element);
6ef4878b 1484
6cc3e350 1485 $object = $element['object'];
6cc3e350 1486
1487 switch ($element['type']) {
1488 case 'item':
1489 case 'categoryitem':
1490 case 'courseitem':
9ecd4386 1491 $stredit = get_string('editverbose', 'grades', $strparams);
6cc3e350 1492 if (empty($object->outcomeid) || empty($CFG->enableoutcomes)) {
a6855934 1493 $url = new moodle_url('/grade/edit/tree/item.php',
1c1f64a2 1494 array('courseid' => $this->courseid, 'id' => $object->id));
6cc3e350 1495 } else {
a6855934 1496 $url = new moodle_url('/grade/edit/tree/outcomeitem.php',
1c1f64a2 1497 array('courseid' => $this->courseid, 'id' => $object->id));
6cc3e350 1498 }
6cc3e350 1499 break;
1500
1501 case 'category':
9ecd4386 1502 $stredit = get_string('editverbose', 'grades', $strparams);
a6855934 1503 $url = new moodle_url('/grade/edit/tree/category.php',
1c1f64a2 1504 array('courseid' => $this->courseid, 'id' => $object->id));
6cc3e350 1505 break;
1506
1507 case 'grade':
05aba805 1508 $stredit = $streditgrade;
6cc3e350 1509 if (empty($object->id)) {
a6855934 1510 $url = new moodle_url('/grade/edit/tree/grade.php',
1c1f64a2 1511 array('courseid' => $this->courseid, 'itemid' => $object->itemid, 'userid' => $object->userid));
6cc3e350 1512 } else {
a6855934 1513 $url = new moodle_url('/grade/edit/tree/grade.php',
1c1f64a2 1514 array('courseid' => $this->courseid, 'id' => $object->id));
6cc3e350 1515 }
6cc3e350 1516 if (!empty($object->feedback)) {
1517 $feedback = addslashes_js(trim(format_string($object->feedback, $object->feedbackformat)));
6cc3e350 1518 }
1519 break;
1520
1521 default:
1522 $url = null;
1523 }
1524
1525 if ($url) {
c63923bd 1526 return $OUTPUT->action_icon($gpr->add_url_params($url), new pix_icon('t/edit', $stredit));
6cc3e350 1527
1528 } else {
1529 return '';
1530 }
1531 }
1532
1533 /**
1534 * Return hiding icon for give element
cf72e2dd 1535 *
1536 * @param array $element An array representing an element in the grade_tree
1537 * @param object $gpr A grade_plugin_return object
1538 *
6cc3e350 1539 * @return string
1540 */
d24832f9 1541 public function get_hiding_icon($element, $gpr) {
5d3b9994 1542 global $CFG, $OUTPUT;
6cc3e350 1543
39873128
TH
1544 if (!$element['object']->can_control_visibility()) {
1545 return '';
1546 }
1547
cf72e2dd 1548 if (!has_capability('moodle/grade:manage', $this->context) and
1549 !has_capability('moodle/grade:hide', $this->context)) {
6cc3e350 1550 return '';
1551 }
1552
345674ca 1553 $strparams = $this->get_params_for_iconstr($element);
9ecd4386 1554 $strshow = get_string('showverbose', 'grades', $strparams);
345674ca 1555 $strhide = get_string('hideverbose', 'grades', $strparams);
6cc3e350 1556
a6855934 1557 $url = new moodle_url('/grade/edit/tree/action.php', array('id' => $this->courseid, 'sesskey' => sesskey(), 'eid' => $element['eid']));
8ae8bf8a 1558 $url = $gpr->add_url_params($url);
1c1f64a2 1559
6cc3e350 1560 if ($element['object']->is_hidden()) {
8ae8bf8a 1561 $type = 'show';
6cc3e350 1562 $tooltip = $strshow;
1563
cf72e2dd 1564 // Change the icon and add a tooltip showing the date
1565 if ($element['type'] != 'category' and $element['object']->get_hidden() > 1) {
8ae8bf8a 1566 $type = 'hiddenuntil';
cf72e2dd 1567 $tooltip = get_string('hiddenuntildate', 'grades',
1568 userdate($element['object']->get_hidden()));
6cc3e350 1569 }
1570
8ae8bf8a 1571 $url->param('action', 'show');
b9cc756e 1572
a377cc53 1573 $hideicon = $OUTPUT->action_icon($url, new pix_icon('t/'.$type, $tooltip, 'moodle', array('alt'=>$strshow, 'class'=>'smallicon')));
6cc3e350 1574
1575 } else {
8ae8bf8a 1576 $url->param('action', 'hide');
c63923bd 1577 $hideicon = $OUTPUT->action_icon($url, new pix_icon('t/hide', $strhide));
6cc3e350 1578 }
1c1f64a2 1579
8ae8bf8a 1580 return $hideicon;
6cc3e350 1581 }
1582
1583 /**
2673c733 1584 * Return locking icon for given element
cf72e2dd 1585 *
1586 * @param array $element An array representing an element in the grade_tree
1587 * @param object $gpr A grade_plugin_return object
1588 *
6cc3e350 1589 * @return string
1590 */
d24832f9 1591 public function get_locking_icon($element, $gpr) {
6b608f8f 1592 global $CFG, $OUTPUT;
6cc3e350 1593
345674ca 1594 $strparams = $this->get_params_for_iconstr($element);
9ecd4386 1595 $strunlock = get_string('unlockverbose', 'grades', $strparams);
1596 $strlock = get_string('lockverbose', 'grades', $strparams);
d24832f9 1597
a6855934 1598 $url = new moodle_url('/grade/edit/tree/action.php', array('id' => $this->courseid, 'sesskey' => sesskey(), 'eid' => $element['eid']));
8ae8bf8a 1599 $url = $gpr->add_url_params($url);
1c1f64a2 1600
2673c733 1601 // Don't allow an unlocking action for a grade whose grade item is locked: just print a state icon
1602 if ($element['type'] == 'grade' && $element['object']->grade_item->is_locked()) {
1603 $strparamobj = new stdClass();
1604 $strparamobj->itemname = $element['object']->grade_item->itemname;
1605 $strnonunlockable = get_string('nonunlockableverbose', 'grades', $strparamobj);
1c1f64a2 1606
0cddd851
FM
1607 $action = html_writer::tag('span', $OUTPUT->pix_icon('t/locked', $strnonunlockable),
1608 array('class' => 'action-icon'));
8ae8bf8a 1609
cf72e2dd 1610 } else if ($element['object']->is_locked()) {
8ae8bf8a 1611 $type = 'unlock';
6cc3e350 1612 $tooltip = $strunlock;
1613
cf72e2dd 1614 // Change the icon and add a tooltip showing the date
1615 if ($element['type'] != 'category' and $element['object']->get_locktime() > 1) {
8ae8bf8a 1616 $type = 'locktime';
cf72e2dd 1617 $tooltip = get_string('locktimedate', 'grades',
1618 userdate($element['object']->get_locktime()));
6cc3e350 1619 }
1620
8ae8bf8a
PS
1621 if (!has_capability('moodle/grade:manage', $this->context) and !has_capability('moodle/grade:unlock', $this->context)) {
1622 $action = '';
1623 } else {
1624 $url->param('action', 'unlock');
c63923bd 1625 $action = $OUTPUT->action_icon($url, new pix_icon('t/'.$type, $tooltip, 'moodle', array('alt'=>$strunlock, 'class'=>'smallicon')));
6cc3e350 1626 }
6cc3e350 1627
1628 } else {
8ae8bf8a
PS
1629 if (!has_capability('moodle/grade:manage', $this->context) and !has_capability('moodle/grade:lock', $this->context)) {
1630 $action = '';
1631 } else {
1632 $url->param('action', 'lock');
c63923bd 1633 $action = $OUTPUT->action_icon($url, new pix_icon('t/lock', $strlock));
6cc3e350 1634 }
6cc3e350 1635 }
8ae8bf8a 1636
6cc3e350 1637 return $action;
1638 }
1639
1640 /**
1641 * Return calculation icon for given element
cf72e2dd 1642 *
1643 * @param array $element An array representing an element in the grade_tree
1644 * @param object $gpr A grade_plugin_return object
1645 *
6cc3e350 1646 * @return string
1647 */
d24832f9 1648 public function get_calculation_icon($element, $gpr) {
666e8458 1649 global $CFG, $OUTPUT;
6cc3e350 1650 if (!has_capability('moodle/grade:manage', $this->context)) {
1651 return '';
1652 }
1653
6cc3e350 1654 $type = $element['type'];
1655 $object = $element['object'];
1656
1657 if ($type == 'item' or $type == 'courseitem' or $type == 'categoryitem') {
345674ca 1658 $strparams = $this->get_params_for_iconstr($element);
9ecd4386 1659 $streditcalculation = get_string('editcalculationverbose', 'grades', $strparams);
6cc3e350 1660
cf72e2dd 1661 $is_scale = $object->gradetype == GRADE_TYPE_SCALE;
1662 $is_value = $object->gradetype == GRADE_TYPE_VALUE;
1663
6cc3e350 1664 // show calculation icon only when calculation possible
cf72e2dd 1665 if (!$object->is_external_item() and ($is_scale or $is_value)) {
6cc3e350 1666 if ($object->is_calculated()) {
666e8458 1667 $icon = 't/calc';
6cc3e350 1668 } else {
666e8458 1669 $icon = 't/calc_off';
6cc3e350 1670 }
cf72e2dd 1671
a6855934 1672 $url = new moodle_url('/grade/edit/tree/calculation.php', array('courseid' => $this->courseid, 'id' => $object->id));
8ae8bf8a 1673 $url = $gpr->add_url_params($url);
0cddd851 1674 return $OUTPUT->action_icon($url, new pix_icon($icon, $streditcalculation));
6cc3e350 1675 }
1676 }
1677
1c1f64a2 1678 return '';
6cc3e350 1679 }
1680}
1681
1682/**
1683 * Flat structure similar to grade tree.
cf72e2dd 1684 *
1685 * @uses grade_structure
a153c9f2 1686 * @package core_grades
cf72e2dd 1687 * @copyright 2009 Nicolas Connault
1688 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
6cc3e350 1689 */
1690class grade_seq extends grade_structure {
1691
6cc3e350 1692 /**
1693 * 1D array of elements
1694 */
d24832f9 1695 public $elements;
e98871a2 1696
1697 /**
1698 * Constructor, retrieves and stores array of all grade_category and grade_item
1699 * objects for the given courseid. Full objects are instantiated. Ordering sequence is fixed if needed.
cf72e2dd 1700 *
1701 * @param int $courseid The course id
1702 * @param bool $category_grade_last category grade item is the last child
1703 * @param bool $nooutcomes Whether or not outcomes should be included
e98871a2 1704 */
d24832f9 1705 public function grade_seq($courseid, $category_grade_last=false, $nooutcomes=false) {
e98871a2 1706 global $USER, $CFG;
1707
1708 $this->courseid = $courseid;
d4060472 1709 $this->context = context_course::instance($courseid);
e98871a2 1710
1711 // get course grade tree
1712 $top_element = grade_category::fetch_course_tree($courseid, true);
1713
6391ebe7 1714 $this->elements = grade_seq::flatten($top_element, $category_grade_last, $nooutcomes);
1715
1716 foreach ($this->elements as $key=>$unused) {
b89a70ce 1717 $this->items[$this->elements[$key]['object']->id] =& $this->elements[$key]['object'];
6391ebe7 1718 }
e98871a2 1719 }
1720
1721 /**
1722 * Static recursive helper - makes the grade_item for category the last children
cf72e2dd 1723 *
1724 * @param array &$element The seed of the recursion
1725 * @param bool $category_grade_last category grade item is the last child
1726 * @param bool $nooutcomes Whether or not outcomes should be included
1727 *
1728 * @return array
e98871a2 1729 */
d24832f9 1730 public function flatten(&$element, $category_grade_last, $nooutcomes) {
e98871a2 1731 if (empty($element['children'])) {
1732 return array();
1733 }
1734 $children = array();
1735
1736 foreach ($element['children'] as $sortorder=>$unused) {
cf72e2dd 1737 if ($nooutcomes and $element['type'] != 'category' and
1738 $element['children'][$sortorder]['object']->is_outcome_item()) {
e98871a2 1739 continue;
1740 }
1741 $children[] = $element['children'][$sortorder];
1742 }
1743 unset($element['children']);
1744
1745 if ($category_grade_last and count($children) > 1) {
1746 $cat_item = array_shift($children);
1747 array_push($children, $cat_item);
1748 }
1749
1750 $result = array();
1751 foreach ($children as $child) {
e0724506 1752 if ($child['type'] == 'category') {
6391ebe7 1753 $result = $result + grade_seq::flatten($child, $category_grade_last, $nooutcomes);
e98871a2 1754 } else {
1755 $child['eid'] = 'i'.$child['object']->id;
6391ebe7 1756 $result[$child['object']->id] = $child;
e98871a2 1757 }
1758 }
1759
1760 return $result;
1761 }
1762
1763 /**
1764 * Parses the array in search of a given eid and returns a element object with
1765 * information about the element it has found.
cf72e2dd 1766 *
1767 * @param int $eid Gradetree Element ID
1768 *
e98871a2 1769 * @return object element
1770 */
d24832f9 1771 public function locate_element($eid) {
e98871a2 1772 // it is a grade - construct a new object
1773 if (strpos($eid, 'n') === 0) {
1774 if (!preg_match('/n(\d+)u(\d+)/', $eid, $matches)) {
1775 return null;
1776 }
1777
1778 $itemid = $matches[1];
1779 $userid = $matches[2];
1780
1781 //extra security check - the grade item must be in this tree
1782 if (!$item_el = $this->locate_element('i'.$itemid)) {
1783 return null;
1784 }
1785
1786 // $gradea->id may be null - means does not exist yet
1787 $grade = new grade_grade(array('itemid'=>$itemid, 'userid'=>$userid));
1788
1789 $grade->grade_item =& $item_el['object']; // this may speedup grade_grade methods!
1790 return array('eid'=>'n'.$itemid.'u'.$userid,'object'=>$grade, 'type'=>'grade');
1791
1792 } else if (strpos($eid, 'g') === 0) {
cf72e2dd 1793 $id = (int) substr($eid, 1);
e98871a2 1794 if (!$grade = grade_grade::fetch(array('id'=>$id))) {
1795 return null;
1796 }
1797 //extra security check - the grade item must be in this tree
1798 if (!$item_el = $this->locate_element('i'.$grade->itemid)) {
1799 return null;
1800 }
1801 $grade->grade_item =& $item_el['object']; // this may speedup grade_grade methods!
1802 return array('eid'=>'g'.$id,'object'=>$grade, 'type'=>'grade');
1803 }
1804
1805 // it is a category or item
6391ebe7 1806 foreach ($this->elements as $element) {
6cc3e350 1807 if ($element['eid'] == $eid) {
1808 return $element;
1809 }
e98871a2 1810 }
6cc3e350 1811
1812 return null;
e98871a2 1813 }
e98871a2 1814}
1815
7a6b7acf 1816/**
1817 * This class represents a complete tree of categories, grade_items and final grades,
1818 * organises as an array primarily, but which can also be converted to other formats.
1819 * It has simple method calls with complex implementations, allowing for easy insertion,
1820 * deletion and moving of items and categories within the tree.
cf72e2dd 1821 *
1822 * @uses grade_structure
a153c9f2 1823 * @package core_grades
cf72e2dd 1824 * @copyright 2009 Nicolas Connault
1825 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
7a6b7acf 1826 */
6cc3e350 1827class grade_tree extends grade_structure {
7a6b7acf 1828
1829 /**
1830 * The basic representation of the tree as a hierarchical, 3-tiered array.
1831 * @var object $top_element
1832 */
d24832f9 1833 public $top_element;
7a6b7acf 1834
7a6b7acf 1835 /**
1836 * 2D array of grade items and categories
cf72e2dd 1837 * @var array $levels
7a6b7acf 1838 */
d24832f9 1839 public $levels;
7a6b7acf 1840
b89a70ce 1841 /**
1842 * Grade items
cf72e2dd 1843 * @var array $items
b89a70ce 1844 */
d24832f9 1845 public $items;
b89a70ce 1846
7a6b7acf 1847 /**
1848 * Constructor, retrieves and stores a hierarchical array of all grade_category and grade_item
e98871a2 1849 * objects for the given courseid. Full objects are instantiated. Ordering sequence is fixed if needed.
cf72e2dd 1850 *
1851 * @param int $courseid The Course ID
1852 * @param bool $fillers include fillers and colspans, make the levels var "rectangular"
1853 * @param bool $category_grade_last category grade item is the last child
4faf5f99 1854 * @param array $collapsed array of collapsed categories
cf72e2dd 1855 * @param bool $nooutcomes Whether or not outcomes should be included
7a6b7acf 1856 */
cf72e2dd 1857 public function grade_tree($courseid, $fillers=true, $category_grade_last=false,
1858 $collapsed=null, $nooutcomes=false) {
73ca5f01 1859 global $USER, $CFG, $COURSE, $DB;
7a6b7acf 1860
1861 $this->courseid = $courseid;
7a6b7acf 1862 $this->levels = array();
d4060472 1863 $this->context = context_course::instance($courseid);
7a6b7acf 1864
73ca5f01 1865 if (!empty($COURSE->id) && $COURSE->id == $this->courseid) {
1866 $course = $COURSE;
1867 } else {
1868 $course = $DB->get_record('course', array('id' => $this->courseid));
1869 }
1870 $this->modinfo = get_fast_modinfo($course);
1871
7a6b7acf 1872 // get course grade tree
1873 $this->top_element = grade_category::fetch_course_tree($courseid, true);
1874
4faf5f99 1875 // collapse the categories if requested
1876 if (!empty($collapsed)) {
1877 grade_tree::category_collapse($this->top_element, $collapsed);
1878 }
1879
aea4df41 1880 // no otucomes if requested
1881 if (!empty($nooutcomes)) {
1882 grade_tree::no_outcomes($this->top_element);
1883 }
1884
4faf5f99 1885 // move category item to last position in category
7a6b7acf 1886 if ($category_grade_last) {
1887 grade_tree::category_grade_last($this->top_element);
1888 }
1889
1890 if ($fillers) {
1891 // inject fake categories == fillers
1892 grade_tree::inject_fillers($this->top_element, 0);
1893 // add colspans to categories and fillers
1894 grade_tree::inject_colspans($this->top_element);
1895 }
1896
1897 grade_tree::fill_levels($this->levels, $this->top_element, 0);
d297269d 1898
7a6b7acf 1899 }
1900
4faf5f99 1901 /**
1902 * Static recursive helper - removes items from collapsed categories
cf72e2dd 1903 *
1904 * @param array &$element The seed of the recursion
4faf5f99 1905 * @param array $collapsed array of collapsed categories
cf72e2dd 1906 *
4faf5f99 1907 * @return void
1908 */
d24832f9 1909 public function category_collapse(&$element, $collapsed) {
4faf5f99 1910 if ($element['type'] != 'category') {
1911 return;
1912 }
1913 if (empty($element['children']) or count($element['children']) < 2) {
1914 return;
1915 }
1916
384960dd 1917 if (in_array($element['object']->id, $collapsed['aggregatesonly'])) {
4faf5f99 1918 $category_item = reset($element['children']); //keep only category item
1919 $element['children'] = array(key($element['children'])=>$category_item);
1920
1921 } else {
384960dd 1922 if (in_array($element['object']->id, $collapsed['gradesonly'])) { // Remove category item
1923 reset($element['children']);
1924 $first_key = key($element['children']);
1925 unset($element['children'][$first_key]);
1926 }
1927 foreach ($element['children'] as $sortorder=>$child) { // Recurse through the element's children
4faf5f99 1928 grade_tree::category_collapse($element['children'][$sortorder], $collapsed);
1929 }
1930 }
1931 }
7a6b7acf 1932
aea4df41 1933 /**
1934 * Static recursive helper - removes all outcomes
cf72e2dd 1935 *
1936 * @param array &$element The seed of the recursion
1937 *
aea4df41 1938 * @return void
1939 */
d24832f9 1940 public function no_outcomes(&$element) {
aea4df41 1941 if ($element['type'] != 'category') {
1942 return;
1943 }
1944 foreach ($element['children'] as $sortorder=>$child) {
1945 if ($element['children'][$sortorder]['type'] == 'item'
1946 and $element['children'][$sortorder]['object']->is_outcome_item()) {
1947 unset($element['children'][$sortorder]);
1948
d4795a07 1949 } else if ($element['children'][$sortorder]['type'] == 'category') {
aea4df41 1950 grade_tree::no_outcomes($element['children'][$sortorder]);
1951 }
1952 }
1953 }
1954
7a6b7acf 1955 /**
1956 * Static recursive helper - makes the grade_item for category the last children
cf72e2dd 1957 *
1958 * @param array &$element The seed of the recursion
1959 *
7a6b7acf 1960 * @return void
1961 */
d24832f9 1962 public function category_grade_last(&$element) {
7a6b7acf 1963 if (empty($element['children'])) {
1964 return;
1965 }
1966 if (count($element['children']) < 2) {
1967 return;
1968 }
3e0e2436 1969 $first_item = reset($element['children']);
4a3dfd9a 1970 if ($first_item['type'] == 'categoryitem' or $first_item['type'] == 'courseitem') {
3e0e2436 1971 // the category item might have been already removed
1972 $order = key($element['children']);
1973 unset($element['children'][$order]);
1974 $element['children'][$order] =& $first_item;
1975 }
206f9953 1976 foreach ($element['children'] as $sortorder => $child) {
7a6b7acf 1977 grade_tree::category_grade_last($element['children'][$sortorder]);
1978 }
1979 }
1980
1981 /**
1982 * Static recursive helper - fills the levels array, useful when accessing tree elements of one level
cf72e2dd 1983 *
1984 * @param array &$levels The levels of the grade tree through which to recurse
1985 * @param array &$element The seed of the recursion
1986 * @param int $depth How deep are we?
7a6b7acf 1987 * @return void
1988 */
d24832f9 1989 public function fill_levels(&$levels, &$element, $depth) {
7a6b7acf 1990 if (!array_key_exists($depth, $levels)) {
1991 $levels[$depth] = array();
1992 }
1993
1994 // prepare unique identifier
1995 if ($element['type'] == 'category') {
1996 $element['eid'] = 'c'.$element['object']->id;
1997 } else if (in_array($element['type'], array('item', 'courseitem', 'categoryitem'))) {
1998 $element['eid'] = 'i'.$element['object']->id;
b89a70ce 1999 $this->items[$element['object']->id] =& $element['object'];
7a6b7acf 2000 }
2001
2002 $levels[$depth][] =& $element;
2003 $depth++;
2004 if (empty($element['children'])) {
2005 return;
2006 }
2007 $prev = 0;
2008 foreach ($element['children'] as $sortorder=>$child) {
2009 grade_tree::fill_levels($levels, $element['children'][$sortorder], $depth);
2010 $element['children'][$sortorder]['prev'] = $prev;
2011 $element['children'][$sortorder]['next'] = 0;
2012 if ($prev) {
2013 $element['children'][$prev]['next'] = $sortorder;
2014 }
2015 $prev = $sortorder;
2016 }
2017 }
2018
2019 /**
2020 * Static recursive helper - makes full tree (all leafes are at the same level)
cf72e2dd 2021 *
2022 * @param array &$element The seed of the recursion
2023 * @param int $depth How deep are we?
2024 *
2025 * @return int
7a6b7acf 2026 */
d24832f9 2027 public function inject_fillers(&$element, $depth) {
7a6b7acf 2028 $depth++;
2029
2030 if (empty($element['children'])) {
2031 return $depth;
2032 }
2033 $chdepths = array();
2034 $chids = array_keys($element['children']);
2035 $last_child = end($chids);
2036 $first_child = reset($chids);
2037
2038 foreach ($chids as $chid) {
2039 $chdepths[$chid] = grade_tree::inject_fillers($element['children'][$chid], $depth);
2040 }
2041 arsort($chdepths);
2042
2043 $maxdepth = reset($chdepths);
2044 foreach ($chdepths as $chid=>$chd) {
2045 if ($chd == $maxdepth) {
2046 continue;
2047 }
2048 for ($i=0; $i < $maxdepth-$chd; $i++) {
2049 if ($chid == $first_child) {
2050 $type = 'fillerfirst';
2051 } else if ($chid == $last_child) {
2052 $type = 'fillerlast';
2053 } else {
2054 $type = 'filler';
2055 }
2056 $oldchild =& $element['children'][$chid];
cf72e2dd 2057 $element['children'][$chid] = array('object'=>'filler', 'type'=>$type,
2058 'eid'=>'', 'depth'=>$element['object']->depth,
2059 'children'=>array($oldchild));
7a6b7acf 2060 }
2061 }
2062
2063 return $maxdepth;
2064 }
2065
2066 /**
2067 * Static recursive helper - add colspan information into categories
cf72e2dd 2068 *
2069 * @param array &$element The seed of the recursion
2070 *
2071 * @return int
7a6b7acf 2072 */
d24832f9 2073 public function inject_colspans(&$element) {
7a6b7acf 2074 if (empty($element['children'])) {
2075 return 1;
2076 }
2077 $count = 0;
2078 foreach ($element['children'] as $key=>$child) {
2079 $count += grade_tree::inject_colspans($element['children'][$key]);
2080 }
2081 $element['colspan'] = $count;
2082 return $count;
2083 }
2084
2085 /**
2086 * Parses the array in search of a given eid and returns a element object with
2087 * information about the element it has found.
cf72e2dd 2088 * @param int $eid Gradetree Element ID
7a6b7acf 2089 * @return object element
2090 */
d24832f9 2091 public function locate_element($eid) {
d3c3da1b 2092 // it is a grade - construct a new object
2093 if (strpos($eid, 'n') === 0) {
2094 if (!preg_match('/n(\d+)u(\d+)/', $eid, $matches)) {
2095 return null;
2096 }
2097
2098 $itemid = $matches[1];
2099 $userid = $matches[2];
2100
2101 //extra security check - the grade item must be in this tree
2102 if (!$item_el = $this->locate_element('i'.$itemid)) {
2103 return null;
2104 }
2105
2106 // $gradea->id may be null - means does not exist yet
2107 $grade = new grade_grade(array('itemid'=>$itemid, 'userid'=>$userid));
2108
2109 $grade->grade_item =& $item_el['object']; // this may speedup grade_grade methods!
2110 return array('eid'=>'n'.$itemid.'u'.$userid,'object'=>$grade, 'type'=>'grade');
2111
2112 } else if (strpos($eid, 'g') === 0) {
cf72e2dd 2113 $id = (int) substr($eid, 1);
7a6b7acf 2114 if (!$grade = grade_grade::fetch(array('id'=>$id))) {
2115 return null;
2116 }
2117 //extra security check - the grade item must be in this tree
2118 if (!$item_el = $this->locate_element('i'.$grade->itemid)) {
2119 return null;
2120 }
2121 $grade->grade_item =& $item_el['object']; // this may speedup grade_grade methods!
2122 return array('eid'=>'g'.$id,'object'=>$grade, 'type'=>'grade');
2123 }
2124
2125 // it is a category or item
2126 foreach ($this->levels as $row) {
2127 foreach ($row as $element) {
2128 if ($element['type'] == 'filler') {
2129 continue;
2130 }
2131 if ($element['eid'] == $eid) {
2132 return $element;
2133 }
2134 }
2135 }
2136
2137 return null;
2138 }
d24832f9 2139
b244b9b7 2140 /**
2141 * Returns a well-formed XML representation of the grade-tree using recursion.
cf72e2dd 2142 *
2143 * @param array $root The current element in the recursion. If null, starts at the top of the tree.
2144 * @param string $tabs The control character to use for tabs
2145 *
b244b9b7 2146 * @return string $xml
2147 */
cf72e2dd 2148 public function exporttoxml($root=null, $tabs="\t") {
b244b9b7 2149 $xml = null;
2150 $first = false;
2151 if (is_null($root)) {
2152 $root = $this->top_element;
2153 $xml = '<?xml version="1.0" encoding="UTF-8" ?>' . "\n";
2154 $xml .= "<gradetree>\n";
2155 $first = true;
2156 }
d24832f9 2157
b244b9b7 2158 $type = 'undefined';
2159 if (strpos($root['object']->table, 'grade_categories') !== false) {
2160 $type = 'category';
cf72e2dd 2161 } else if (strpos($root['object']->table, 'grade_items') !== false) {
b244b9b7 2162 $type = 'item';
cf72e2dd 2163 } else if (strpos($root['object']->table, 'grade_outcomes') !== false) {
b244b9b7 2164 $type = 'outcome';
2165 }
d24832f9 2166
b244b9b7 2167 $xml .= "$tabs<element type=\"$type\">\n";
2168 foreach ($root['object'] as $var => $value) {
2169 if (!is_object($value) && !is_array($value) && !empty($value)) {
2170 $xml .= "$tabs\t<$var>$value</$var>\n";
2171 }
2172 }
2173
2174 if (!empty($root['children'])) {
2175 $xml .= "$tabs\t<children>\n";
2176 foreach ($root['children'] as $sortorder => $child) {
2177 $xml .= $this->exportToXML($child, $tabs."\t\t");
2178 }
2179 $xml .= "$tabs\t</children>\n";
2180 }
d24832f9 2181
b244b9b7 2182 $xml .= "$tabs</element>\n";
2183
2184 if ($first) {
2185 $xml .= "</gradetree>";
2186 }
d24832f9 2187
b244b9b7 2188 return $xml;
2189 }
d24832f9 2190
b244b9b7 2191 /**
2192 * Returns a JSON representation of the grade-tree using recursion.
cf72e2dd 2193 *
b244b9b7 2194 * @param array $root The current element in the recursion. If null, starts at the top of the tree.
2195 * @param string $tabs Tab characters used to indent the string nicely for humans to enjoy
cf72e2dd 2196 *
2197 * @return string
b244b9b7 2198 */
cf72e2dd 2199 public function exporttojson($root=null, $tabs="\t") {
b244b9b7 2200 $json = null;
2201 $first = false;
2202 if (is_null($root)) {
2203 $root = $this->top_element;
2204 $first = true;
2205 }
d24832f9 2206
b244b9b7 2207 $name = '';
2208
2209
2210 if (strpos($root['object']->table, 'grade_categories') !== false) {
2211 $name = $root['object']->fullname;
2212 if ($name == '?') {
d24832f9 2213 $name = $root['object']->get_name();
b244b9b7 2214 }
cf72e2dd 2215 } else if (strpos($root['object']->table, 'grade_items') !== false) {
b244b9b7 2216 $name = $root['object']->itemname;
cf72e2dd 2217 } else if (strpos($root['object']->table, 'grade_outcomes') !== false) {
b244b9b7 2218 $name = $root['object']->itemname;
2219 }
d24832f9 2220
b244b9b7 2221 $json .= "$tabs {\n";
2222 $json .= "$tabs\t \"type\": \"{$root['type']}\",\n";
2223 $json .= "$tabs\t \"name\": \"$name\",\n";
2224
2225 foreach ($root['object'] as $var => $value) {
2226 if (!is_object($value) && !is_array($value) && !empty($value)) {
2227 $json .= "$tabs\t \"$var\": \"$value\",\n";
2228 }
2229 }
d24832f9 2230
b244b9b7 2231 $json = substr($json, 0, strrpos($json, ','));
d24832f9 2232
b244b9b7 2233 if (!empty($root['children'])) {
2234 $json .= ",\n$tabs\t\"children\": [\n";
2235 foreach ($root['children'] as $sortorder => $child) {
2236 $json .= $this->exportToJSON($child, $tabs."\t\t");
2237 }
2238 $json = substr($json, 0, strrpos($json, ','));
2239 $json .= "\n$tabs\t]\n";
d24832f9 2240 }
b244b9b7 2241
2242 if ($first) {
2243 $json .= "\n}";
2244 } else {
2245 $json .= "\n$tabs},\n";
2246 }
d24832f9 2247
b244b9b7 2248 return $json;
2249 }
d24832f9 2250
cf72e2dd 2251 /**
2252 * Returns the array of levels
2253 *
2254 * @return array
2255 */
d24832f9 2256 public function get_levels() {
2257 return $this->levels;
2258 }
2259
cf72e2dd 2260 /**
2261 * Returns the array of grade items
2262 *
2263 * @return array
2264 */
d24832f9 2265 public function get_items() {
2266 return $this->items;
2267 }
2268
cf72e2dd 2269 /**
2270 * Returns a specific Grade Item
2271 *
2272 * @param int $itemid The ID of the grade_item object
2273 *
2274 * @return grade_item
2275 */
d24832f9 2276 public function get_item($itemid) {
2277 if (array_key_exists($itemid, $this->items)) {
2278 return $this->items[$itemid];
2279 } else {
2280 return false;
2281 }
2282 }
7a6b7acf 2283}
eef00ade 2284
2285/**
2286 * Local shortcut function for creating an edit/delete button for a grade_* object.
4d27bc79 2287 * @param string $type 'edit' or 'delete'
eef00ade 2288 * @param int $courseid The Course ID
2289 * @param grade_* $object The grade_* object
2290 * @return string html
2291 */
2292function grade_button($type, $courseid, $object) {
2293 global $CFG, $OUTPUT;
2294 if (preg_match('/grade_(.*)/', get_class($object), $matches)) {
2295 $objectidstring = $matches[1] . 'id';
2296 } else {
2297 throw new coding_exception('grade_button() only accepts grade_* objects as third parameter!');
2298 }
2299
2300 $strdelete = get_string('delete');
2301 $stredit = get_string('edit');
2302
eef00ade 2303 if ($type == 'delete') {
8ae8bf8a 2304 $url = new moodle_url('index.php', array('id' => $courseid, $objectidstring => $object->id, 'action' => 'delete', 'sesskey' => sesskey()));
eef00ade 2305 } else if ($type == 'edit') {
8ae8bf8a 2306 $url = new moodle_url('edit.php', array('courseid' => $courseid, 'id' => $object->id));
eef00ade 2307 }
2308
fa9c0aab 2309 return $OUTPUT->action_icon($url, new pix_icon('t/'.$type, ${'str'.$type}, '', array('class' => 'iconsmall')));
eef00ade 2310
2311}
4d5059d4
SH
2312
2313/**
2314 * This method adds settings to the settings block for the grade system and its
2315 * plugins
2316 *
2317 * @global moodle_page $PAGE
2318 */
2319function grade_extend_settings($plugininfo, $courseid) {
2320 global $PAGE;
2321
2322 $gradenode = $PAGE->settingsnav->prepend(get_string('gradeadministration', 'grades'), null, navigation_node::TYPE_CONTAINER);
2323
2324 $strings = array_shift($plugininfo);
2325
2326 if ($reports = grade_helper::get_plugins_reports($courseid)) {
2327 foreach ($reports as $report) {
2328 $gradenode->add($report->string, $report->link, navigation_node::TYPE_SETTING, null, $report->id, new pix_icon('i/report', ''));
2329 }
2330 }
2331
2332 if ($imports = grade_helper::get_plugins_import($courseid)) {
2333 $importnode = $gradenode->add($strings['import'], null, navigation_node::TYPE_CONTAINER);
2334 foreach ($imports as $import) {
11f87187 2335 $importnode->add($import->string, $import->link, navigation_node::TYPE_SETTING, null, $import->id, new pix_icon('i/import', ''));
4d5059d4
SH
2336 }
2337 }
2338
2339 if ($exports = grade_helper::get_plugins_export($courseid)) {
2340 $exportnode = $gradenode->add($strings['export'], null, navigation_node::TYPE_CONTAINER);
2341 foreach ($exports as $export) {
11f87187 2342 $exportnode->add($export->string, $export->link, navigation_node::TYPE_SETTING, null, $export->id, new pix_icon('i/export', ''));
4d5059d4
SH
2343 }
2344 }
2345
2346 if ($setting = grade_helper::get_info_manage_settings($courseid)) {
2347 $gradenode->add(get_string('coursegradesettings', 'grades'), $setting->link, navigation_node::TYPE_SETTING, null, $setting->id, new pix_icon('i/settings', ''));
2348 }
2349
2350 if ($preferences = grade_helper::get_plugins_report_preferences($courseid)) {
2351 $preferencesnode = $gradenode->add(get_string('myreportpreferences', 'grades'), null, navigation_node::TYPE_CONTAINER);
2352 foreach ($preferences as $preference) {
2353 $preferencesnode->add($preference->string, $preference->link, navigation_node::TYPE_SETTING, null, $preference->id, new pix_icon('i/settings', ''));
2354 }
2355 }
2356
2357 if ($letters = grade_helper::get_info_letters($courseid)) {
2358 $letters = array_shift($letters);
2359 $gradenode->add($strings['letter'], $letters->link, navigation_node::TYPE_SETTING, null, $letters->id, new pix_icon('i/settings', ''));
2360 }
2361
2362 if ($outcomes = grade_helper::get_info_outcomes($courseid)) {
2363 $outcomes = array_shift($outcomes);
2364 $gradenode->add($strings['outcome'], $outcomes->link, navigation_node::TYPE_SETTING, null, $outcomes->id, new pix_icon('i/outcomes', ''));
2365 }
2366
2367 if ($scales = grade_helper::get_info_scales($courseid)) {
2368 $gradenode->add($strings['scale'], $scales->link, navigation_node::TYPE_SETTING, null, $scales->id, new pix_icon('i/scales', ''));
2369 }
2370
2371 if ($categories = grade_helper::get_info_edit_structure($courseid)) {
2372 $categoriesnode = $gradenode->add(get_string('categoriesanditems','grades'), null, navigation_node::TYPE_CONTAINER);
2373 foreach ($categories as $category) {
2374 $categoriesnode->add($category->string, $category->link, navigation_node::TYPE_SETTING, null, $category->id, new pix_icon('i/report', ''));
2375 }
2376 }
2377
2378 if ($gradenode->contains_active_node()) {
2379 // If the gradenode is active include the settings base node (gradeadministration) in
2380 // the navbar, typcially this is ignored.
2381 $PAGE->navbar->includesettingsbase = true;
2382
2383 // If we can get the course admin node make sure it is closed by default
2384 // as in this case the gradenode will be opened
2385 if ($coursenode = $PAGE->settingsnav->get('courseadmin', navigation_node::TYPE_COURSE)){
2386 $coursenode->make_inactive();
2387 $coursenode->forceopen = false;
2388 }
2389 }
2390}
2391
2392/**
2393 * Grade helper class
2394 *
2395 * This class provides several helpful functions that work irrespective of any
2396 * current state.
2397 *
2398 * @copyright 2010 Sam Hemelryk
2399 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2400 */
2401abstract class grade_helper {
2402 /**
2403 * Cached manage settings info {@see get_info_settings}
2404 * @var grade_plugin_info|false
2405 */
2406 protected static $managesetting = null;
2407 /**
2408 * Cached grade report plugins {@see get_plugins_reports}
2409 * @var array|false
2410 */
2411 protected static $gradereports = null;
2412 /**
2413 * Cached grade report plugins preferences {@see get_info_scales}
2414 * @var array|false
2415 */
2416 protected static $gradereportpreferences = null;
2417 /**
2418 * Cached scale info {@see get_info_scales}
2419 * @var grade_plugin_info|false
2420 */
2421 protected static $scaleinfo = null;
2422 /**
2423 * Cached outcome info {@see get_info_outcomes}
2424 * @var grade_plugin_info|false
2425 */
2426 protected static $outcomeinfo = null;
2427 /**
2428 * Cached info on edit structure {@see get_info_edit_structure}
2429 * @var array|false
2430 */
2431 protected static $edittree = null;
2432 /**
2433 * Cached leftter info {@see get_info_letters}
2434 * @var grade_plugin_info|false
2435 */
2436 protected static $letterinfo = null;
2437 /**
2438 * Cached grade import plugins {@see get_plugins_import}
2439 * @var array|false
2440 */
2441 protected static $importplugins = null;
2442 /**
2443 * Cached grade export plugins {@see get_plugins_export}
2444 * @var array|false
2445 */
2446 protected static $exportplugins = null;
2447 /**
2448 * Cached grade plugin strings
2449 * @var array
2450 */
2451 protected static $pluginstrings = null;
2452
2453 /**
2454 * Gets strings commonly used by the describe plugins
2455 *
2456 * report => get_string('view'),
2457 * edittree => get_string('edittree', 'grades'),
2458 * scale => get_string('scales'),
2459 * outcome => get_string('outcomes', 'grades'),
2460 * letter => get_string('letters', 'grades'),
2461 * export => get_string('export', 'grades'),
2462 * import => get_string('import'),
2463 * preferences => get_string('mypreferences', 'grades'),
2464 * settings => get_string('settings')
2465 *
2466 * @return array
2467 */
2468 public static function get_plugin_strings() {
2469 if (self::$pluginstrings === null) {
2470 self::$pluginstrings = array(
2471 'report' => get_string('view'),
2472 'edittree' => get_string('edittree', 'grades'),
2473 'scale' => get_string('scales'),
2474 'outcome' => get_string('outcomes', 'grades'),
2475 'letter' => get_string('letters', 'grades'),
2476 'export' => get_string('export', 'grades'),
2477 'import' => get_string('import'),
2478 'preferences' => get_string('mypreferences', 'grades'),
2479 'settings' => get_string('settings')
2480 );
2481 }
2482 return self::$pluginstrings;
2483 }
2484 /**
2485 * Get grade_plugin_info object for managing settings if the user can
2486 *
2487 * @param int $courseid
2488 * @return grade_plugin_info
2489 */
2490 public static function get_info_manage_settings($courseid) {
2491 if (self::$managesetting !== null) {
2492 return self::$managesetting;
2493 }
d4060472 2494 $context = context_course::instance($courseid);
25e500f6 2495 if (has_capability('moodle/grade:manage', $context)) {
4d5059d4
SH
2496 self::$managesetting = new grade_plugin_info('coursesettings', new moodle_url('/grade/edit/settings/index.php', array('id'=>$courseid)), get_string('course'));
2497 } else {
2498 self::$managesetting = false;
2499 }
2500 return self::$managesetting;
2501 }
2502 /**
2503 * Returns an array of plugin reports as grade_plugin_info objects
2504 *
2505 * @param int $courseid
2506 * @return array
2507 */
2508 public static function get_plugins_reports($courseid) {
f7fcf4cd 2509 global $SITE;
cf717dc2 2510
4d5059d4
SH
2511 if (self::$gradereports !== null) {
2512 return self::$gradereports;
2513 }
d4060472 2514 $context = context_course::instance($courseid);
4d5059d4
SH
2515 $gradereports = array();
2516 $gradepreferences = array();
bd3b3bba 2517 foreach (core_component::get_plugin_list('gradereport') as $plugin => $plugindir) {
f7fcf4cd
AD
2518 //some reports make no sense if we're not within a course
2519 if ($courseid==$SITE->id && ($plugin=='grader' || $plugin=='user')) {
2520 continue;
2521 }
2522
4d5059d4
SH
2523 // Remove ones we can't see
2524 if (!has_capability('gradereport/'.$plugin.':view', $context)) {
2525 continue;
2526 }
2527
b5e7b2bf 2528 $pluginstr = get_string('pluginname', 'gradereport_'.$plugin);
4d5059d4
SH
2529 $url = new moodle_url('/grade/report/'.$plugin.'/index.php', array('id'=>$courseid));
2530 $gradereports[$plugin] = new grade_plugin_info($plugin, $url, $pluginstr);
2531
2532 // Add link to preferences tab if such a page exists
2533 if (file_exists($plugindir.'/preferences.php')) {
2534 $url = new moodle_url('/grade/report/'.$plugin.'/preferences.php', array('id'=>$courseid));
2535 $gradepreferences[$plugin] = new grade_plugin_info($plugin, $url, $pluginstr);
2536 }
2537 }
2538 if (count($gradereports) == 0) {
2539 $gradereports = false;
2540 $gradepreferences = false;
2541 } else if (count($gradepreferences) == 0) {
2542 $gradepreferences = false;
2543 asort($gradereports);
2544 } else {
2545 asort($gradereports);
2546 asort($gradepreferences);
2547 }
2548 self::$gradereports = $gradereports;
2549 self::$gradereportpreferences = $gradepreferences;
2550 return self::$gradereports;
2551 }
2552 /**
2553 * Returns an array of grade plugin report preferences for plugin reports that
2554 * support preferences
2555 * @param int $courseid
2556 * @return array
2557 */
2558 public static function get_plugins_report_preferences($courseid) {
2559 if (self::$gradereportpreferences !== null) {
2560 return self::$gradereportpreferences;
2561 }
2562 self::get_plugins_reports($courseid);
2563 return self::$gradereportpreferences;
2564 }
2565 /**
2566 * Get information on scales
2567 * @param int $courseid
2568 * @return grade_plugin_info
2569 */
2570 public static function get_info_scales($courseid) {
2571 if (self::$scaleinfo !== null) {
2572 return self::$scaleinfo;
2573 }
d4060472 2574 if (has_capability('moodle/course:managescales', context_course::instance($courseid))) {
4d5059d4
SH
2575 $url = new moodle_url('/grade/edit/scale/index.php', array('id'=>$courseid));
2576 self::$scaleinfo = new grade_plugin_info('scale', $url, get_string('view'));
2577 } else {
2578 self::$scaleinfo = false;
2579 }
2580 return self::$scaleinfo;
2581 }
2582 /**
2583 * Get information on outcomes
2584 * @param int $courseid
2585 * @return grade_plugin_info
2586 */
2587 public static function get_info_outcomes($courseid) {
f7fcf4cd 2588 global $CFG, $SITE;
4d5059d4
SH
2589
2590 if (self::$outcomeinfo !== null) {
2591 return self::$outcomeinfo;
2592 }
d4060472 2593 $context = context_course::instance($courseid);
4d5059d4
SH
2594 $canmanage = has_capability('moodle/grade:manage', $context);
2595 $canupdate = has_capability('moodle/course:update', $context);
2596 if (!empty($CFG->enableoutcomes) && ($canmanage || $canupdate)) {
2597 $outcomes = array();
2598 if ($canupdate) {
f7fcf4cd
AD
2599 if ($courseid!=$SITE->id) {
2600 $url = new moodle_url('/grade/edit/outcome/course.php', array('id'=>$courseid));
2601 $outcomes['course'] = new grade_plugin_info('course', $url, get_string('outcomescourse', 'grades'));
2602 }
4d5059d4
SH
2603 $url = new moodle_url('/grade/edit/outcome/index.php', array('id'=>$courseid));
2604 $outcomes['edit'] = new grade_plugin_info('edit', $url, get_string('editoutcomes', 'grades'));
c46aeeab
DC
2605 $url = new moodle_url('/grade/edit/outcome/import.php', array('courseid'=>$courseid));
2606 $outcomes['import'] = new grade_plugin_info('import', $url, get_string('importoutcomes', 'grades'));
4d5059d4 2607 } else {
f7fcf4cd
AD
2608 if ($courseid!=$SITE->id) {
2609 $url = new moodle_url('/grade/edit/outcome/course.php', array('id'=>$courseid));
2610 $outcomes['edit'] = new grade_plugin_info('edit', $url, get_string('outcomescourse', 'grades'));
2611 }
4d5059d4
SH
2612 }
2613 self::$outcomeinfo = $outcomes;
2614 } else {
2615 self::$outcomeinfo = false;
2616 }
2617 return self::$outcomeinfo;
2618 }
2619 /**
2620 * Get information on editing structures
2621 * @param int $courseid
2622 * @return array
2623 */
2624 public static function get_info_edit_structure($courseid) {
2625 if (self::$edittree !== null) {
2626 return self::$edittree;
2627 }
d4060472 2628 if (has_capability('moodle/grade:manage', context_course::instance($courseid))) {
4d5059d4
SH
2629 $url = new moodle_url('/grade/edit/tree/index.php', array('sesskey'=>sesskey(), 'showadvanced'=>'0', 'id'=>$courseid));
2630 self::$edittree = array(
2631 'simpleview' => new grade_plugin_info('simpleview', $url, get_string('simpleview', 'grades')),
2632 'fullview' => new grade_plugin_info('fullview', new moodle_url($url, array('showadvanced'=>'1')), get_string('fullview', 'grades'))
2633 );
2634 } else {
2635 self::$edittree = false;
2636 }
2637 return self::$edittree;
2638 }
2639 /**
2640 * Get information on letters
2641 * @param int $courseid
4d27bc79 2642 * @return array
4d5059d4
SH
2643 */
2644 public static function get_info_letters($courseid) {
a8dfc483 2645 global $SITE;
4d5059d4
SH
2646 if (self::$letterinfo !== null) {
2647 return self::$letterinfo;
2648 }
d4060472 2649 $context = context_course::instance($courseid);
4d5059d4
SH
2650 $canmanage = has_capability('moodle/grade:manage', $context);
2651 $canmanageletters = has_capability('moodle/grade:manageletters', $context);
2652 if ($canmanage || $canmanageletters) {
a8dfc483
AA
2653 // Redirect to system context when report is accessed from admin settings MDL-31633
2654 if ($context->instanceid == $SITE->id) {
2655 $param = array('edit' => 1);
2656 } else {
2657 $param = array('edit' => 1,'id' => $context->id);
2658 }
4d5059d4 2659 self::$letterinfo = array(
54caa598 2660 'view' => new grade_plugin_info('view', new moodle_url('/grade/edit/letter/index.php', array('id'=>$context->id)), get_string('view')),
a8dfc483 2661 'edit' => new grade_plugin_info('edit', new moodle_url('/grade/edit/letter/index.php', $param), get_string('edit'))
4d5059d4
SH
2662 );
2663 } else {
2664 self::$letterinfo = false;
2665 }
2666 return self::$letterinfo;
2667 }
2668 /**
2669 * Get information import plugins
2670 * @param int $courseid
2671 * @return array
2672 */
2673 public static function get_plugins_import($courseid) {
2674 global $CFG;
2675
2676 if (self::$importplugins !== null) {
2677 return self::$importplugins;
2678 }
2679 $importplugins = array();
d4060472 2680 $context = context_course::instance($courseid);
4d5059d4
SH
2681
2682 if (has_capability('moodle/grade:import', $context)) {
bd3b3bba 2683 foreach (core_component::get_plugin_list('gradeimport') as $plugin => $plugindir) {
4d5059d4
SH
2684 if (!has_capability('gradeimport/'.$plugin.':view', $context)) {
2685 continue;
2686 }
b5e7b2bf 2687 $pluginstr = get_string('pluginname', 'gradeimport_'.$plugin);
4d5059d4
SH
2688 $url = new moodle_url('/grade/import/'.$plugin.'/index.php', array('id'=>$courseid));
2689 $importplugins[$plugin] = new grade_plugin_info($plugin, $url, $pluginstr);
2690 }
2691
2692
2693 if ($CFG->gradepublishing) {
2694 $url = new moodle_url('/grade/import/keymanager.php', array('id'=>$courseid));
2695 $importplugins['keymanager'] = new grade_plugin_info('keymanager', $url, get_string('keymanager', 'grades'));
2696 }
2697 }
2698
2699 if (count($importplugins) > 0) {
2700 asort($importplugins);
2701 self::$importplugins = $importplugins;
2702 } else {
2703 self::$importplugins = false;
2704 }
2705 return self::$importplugins;
2706 }
2707 /**
2708 * Get information export plugins
2709 * @param int $courseid
2710 * @return array
2711 */
2712 public static function get_plugins_export($courseid) {
2713 global $CFG;
2714
2715 if (self::$exportplugins !== null) {
2716 return self::$exportplugins;
2717 }
d4060472 2718 $context = context_course::instance($courseid);
4d5059d4
SH
2719 $exportplugins = array();
2720 if (has_capability('moodle/grade:export', $context)) {
bd3b3bba 2721 foreach (core_component::get_plugin_list('gradeexport') as $plugin => $plugindir) {
4d5059d4
SH
2722 if (!has_capability('gradeexport/'.$plugin.':view', $context)) {
2723 continue;
2724 }
b5e7b2bf 2725 $pluginstr = get_string('pluginname', 'gradeexport_'.$plugin);
4d5059d4
SH
2726 $url = new moodle_url('/grade/export/'.$plugin.'/index.php', array('id'=>$courseid));
2727 $exportplugins[$plugin] = new grade_plugin_info($plugin, $url, $pluginstr);
2728 }
2729
2730 if ($CFG->gradepublishing) {
2731 $url = new moodle_url('/grade/export/keymanager.php', array('id'=>$courseid));
2732 $exportplugins['keymanager'] = new grade_plugin_info('keymanager', $url, get_string('keymanager', 'grades'));
2733 }
2734 }
2735 if (count($exportplugins) > 0) {
2736 asort($exportplugins);
2737 self::$exportplugins = $exportplugins;
2738 } else {
2739 self::$exportplugins = false;
2740 }
2741 return self::$exportplugins;
2742 }
293f42b6 2743
61c8e0d7
FM
2744 /**
2745 * Returns the value of a field from a user record
2746 *
2747 * @param stdClass $user object
2748 * @param stdClass $field object
2749 * @return string value of the field
2750 */
2751 public static function get_user_field_value($user, $field) {
2752 if (!empty($field->customid)) {
2753 $fieldname = 'customfield_' . $field->shortname;
2754 if (!empty($user->{$fieldname}) || is_numeric($user->{$fieldname})) {
2755 $fieldvalue = $user->{$fieldname};
2756 } else {
2757 $fieldvalue = $field->default;
2758 }
2759 } else {
2760 $fieldvalue = $user->{$field->shortname};
2761 }
2762 return $fieldvalue;
2763 }
2764
2765 /**
2766 * Returns an array of user profile fields to be included in export
2767 *
2768 * @param int $courseid
2769 * @param bool $includecustomfields
2770 * @return array An array of stdClass instances with customid, shortname, datatype, default and fullname fields
2771 */
2772 public static function get_user_profile_fields($courseid, $includecustomfields = false) {
2773 global $CFG, $DB;
2774
2775 // Gets the fields that have to be hidden
2776 $hiddenfields = array_map('trim', explode(',', $CFG->hiddenuserfields));
2777 $context = context_course::instance($courseid);
2778 $canseehiddenfields = has_capability('moodle/course:viewhiddenuserfields', $context);
2779 if ($canseehiddenfields) {
2780 $hiddenfields = array();
2781 }
2782
2783 $fields = array();
2784 require_once($CFG->dirroot.'/user/lib.php'); // Loads user_get_default_fields()
2785 require_once($CFG->dirroot.'/user/profile/lib.php'); // Loads constants, such as PROFILE_VISIBLE_ALL
2786 $userdefaultfields = user_get_default_fields();
2787
2788 // Sets the list of profile fields
2789 $userprofilefields = array_map('trim', explode(',', $CFG->grade_export_userprofilefields));
2790 if (!empty($userprofilefields)) {
2791 foreach ($userprofilefields as $field) {
2792 $field = trim($field);
2793 if (in_array($field, $hiddenfields) || !in_array($field, $userdefaultfields)) {
2794 continue;
2795 }
293f42b6 2796 $obj = new stdClass();
61c8e0d7 2797 $obj->customid = 0;
293f42b6 2798 $obj->shortname = $field;
61c8e0d7 2799 $obj->fullname = get_string($field);
293f42b6
CF
2800 $fields[] = $obj;
2801 }
2802 }
293f42b6 2803
61c8e0d7
FM
2804 // Sets the list of custom profile fields
2805 $customprofilefields = array_map('trim', explode(',', $CFG->grade_export_customprofilefields));
2806 if ($includecustomfields && !empty($customprofilefields)) {
2807 list($wherefields, $whereparams) = $DB->get_in_or_equal($customprofilefields);
2808 $customfields = $DB->get_records_sql("SELECT f.*
2809 FROM {user_info_field} f
2810 JOIN {user_info_category} c ON f.categoryid=c.id
2811 WHERE f.shortname $wherefields
2812 ORDER BY c.sortorder ASC, f.sortorder ASC", $whereparams);
2813 if (!is_array($customfields)) {
2814 continue;
2815 }
2816
2817 foreach ($customfields as $field) {
2818 // Make sure we can display this custom field
2819 if (!in_array($field->shortname, $customprofilefields)) {
2820 continue;
2821 } else if (in_array($field->shortname, $hiddenfields)) {
2822 continue;
2823 } else if ($field->visible != PROFILE_VISIBLE_ALL && !$canseehiddenfields) {
2824 continue;
2825 }
2826
2827 $obj = new stdClass();
2828 $obj->customid = $field->id;
2829 $obj->shortname = $field->shortname;
2830 $obj->fullname = format_string($field->name);
2831 $obj->datatype = $field->datatype;
2832 $obj->default = $field->defaultdata;
2833 $fields[] = $obj;
2834 }
2835 }
2836
2837 return $fields;
2838 }
293f42b6 2839}
61c8e0d7 2840