MDL-49324 grade: Ensure report appears in breadcrumbs
[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 }
9901bdf7 311 $grades[$grade_item->id]->grade_item = $grade_item;
0f5660f7 312 }
313 }
314
38c1dd19
RT
315 // Set user suspended status.
316 $user->suspendedenrolment = isset($this->suspendedusers[$user->id]);
ace9051c 317 $result = new stdClass();
0f5660f7 318 $result->user = $user;
319 $result->grades = $grades;
320 $result->feedbacks = $feedbacks;
0f5660f7 321 return $result;
322 }
323
324 /**
728ff21b 325 * Close the iterator, do not forget to call this function
0f5660f7 326 */
728ff21b 327 public function close() {
caffc55a 328 if ($this->users_rs) {
d24832f9 329 $this->users_rs->close();
caffc55a 330 $this->users_rs = null;
0f5660f7 331 }
caffc55a 332 if ($this->grades_rs) {
d24832f9 333 $this->grades_rs->close();
caffc55a 334 $this->grades_rs = null;
0f5660f7 335 }
336 $this->gradestack = array();
337 }
338
78ab98bc
AD
339 /**
340 * Should all enrolled users be exported or just those with an active enrolment?
341 *
342 * @param bool $onlyactive True to limit the export to users with an active enrolment
343 */
344 public function require_active_enrolment($onlyactive = true) {
345 if (!empty($this->users_rs)) {
346 debugging('Calling require_active_enrolment() has no effect unless you call init() again', DEBUG_DEVELOPER);
347 }
348 $this->onlyactive = $onlyactive;
349 }
350
61c8e0d7
FM
351 /**
352 * Allow custom fields to be included
353 *
354 * @param bool $allow Whether to allow custom fields or not
355 * @return void
356 */
357 public function allow_user_custom_fields($allow = true) {
358 if ($allow) {
359 $this->allowusercustomfields = true;
360 } else {
361 $this->allowusercustomfields = false;
362 }
363 }
cf72e2dd 364
0f5660f7 365 /**
728ff21b 366 * Add a grade_grade instance to the grade stack
cf72e2dd 367 *
368 * @param grade_grade $grade Grade object
369 *
370 * @return void
0f5660f7 371 */
728ff21b 372 private function _push($grade) {
0f5660f7 373 array_push($this->gradestack, $grade);
374 }
375
cf72e2dd 376
0f5660f7 377 /**
728ff21b 378 * Remove a grade_grade instance from the grade stack
cf72e2dd 379 *
728ff21b 380 * @return grade_grade current grade object
0f5660f7 381 */
728ff21b 382 private function _pop() {
d24832f9 383 global $DB;
0f5660f7 384 if (empty($this->gradestack)) {
8de7c8a7 385 if (empty($this->grades_rs) || !$this->grades_rs->valid()) {
cf72e2dd 386 return null; // no grades present
0f5660f7 387 }
388
7ce5df86
AD
389 $current = $this->grades_rs->current();
390
391 $this->grades_rs->next();
0f5660f7 392
7ce5df86 393 return $current;
0f5660f7 394 } else {
395 return array_pop($this->gradestack);
396 }
397 }
398}
399
d08bba83 400/**
401 * Print a selection popup form of the graded users in a course.
402 *
4d5059d4
SH
403 * @deprecated since 2.0
404 *
cf72e2dd 405 * @param int $course id of the course
d08bba83 406 * @param string $actionpage The page receiving the data from the popoup form
cf72e2dd 407 * @param int $userid id of the currently selected user (or 'all' if they are all selected)
408 * @param int $groupid id of requested group, 0 means all
409 * @param int $includeall bool include all option
410 * @param bool $return If true, will return the HTML, otherwise, will print directly
d08bba83 411 * @return null
412 */
7ac88172 413function print_graded_users_selector($course, $actionpage, $userid=0, $groupid=0, $includeall=true, $return=false) {
714b4745 414 global $CFG, $USER, $OUTPUT;
4d5059d4
SH
415 return $OUTPUT->render(grade_get_graded_users_select(substr($actionpage, 0, strpos($actionpage, '/')), $course, $userid, $groupid, $includeall));
416}
345674ca 417
4d5059d4 418function grade_get_graded_users_select($report, $course, $userid, $groupid, $includeall) {
4e829d48 419 global $USER, $CFG;
f9510667 420
879c99bb 421 if (is_null($userid)) {
422 $userid = $USER->id;
423 }
38c1dd19
RT
424 $coursecontext = context_course::instance($course->id);
425 $defaultgradeshowactiveenrol = !empty($CFG->grade_report_showonlyactiveenrol);
426 $showonlyactiveenrol = get_user_preferences('grade_report_showonlyactiveenrol', $defaultgradeshowactiveenrol);
427 $showonlyactiveenrol = $showonlyactiveenrol || !has_capability('moodle/course:viewsuspendedusers', $coursecontext);
d08bba83 428 $menu = array(); // Will be a list of userid => user name
38c1dd19 429 $menususpendedusers = array(); // Suspended users go to a separate optgroup.
772229f3 430 $gui = new graded_users_iterator($course, null, $groupid);
38c1dd19 431 $gui->require_active_enrolment($showonlyactiveenrol);
d08bba83 432 $gui->init();
10f5c046 433 $label = get_string('selectauser', 'grades');
7ac88172 434 if ($includeall) {
879c99bb 435 $menu[0] = get_string('allusers', 'grades');
10f5c046 436 $label = get_string('selectalloroneuser', 'grades');
d08bba83 437 }
d08bba83 438 while ($userdata = $gui->next_user()) {
439 $user = $userdata->user;
38c1dd19
RT
440 $userfullname = fullname($user);
441 if ($user->suspendedenrolment) {
442 $menususpendedusers[$user->id] = $userfullname;
443 } else {
444 $menu[$user->id] = $userfullname;
445 }
d08bba83 446 }
d08bba83 447 $gui->close();
448
7ac88172 449 if ($includeall) {
38c1dd19
RT
450 $menu[0] .= " (" . (count($menu) + count($menususpendedusers) - 1) . ")";
451 }
452
453 if (!empty($menususpendedusers)) {
454 $menu[] = array(get_string('suspendedusers') => $menususpendedusers);
879c99bb 455 }
4d5059d4 456 $select = new single_select(new moodle_url('/grade/report/'.$report.'/index.php', array('id'=>$course->id)), 'userid', $menu, $userid);
f8dab966
PS
457 $select->label = $label;
458 $select->formid = 'choosegradeuser';
4d5059d4 459 return $select;
d08bba83 460}
461
a9937aec
DW
462/**
463 * Hide warning about changed grades during upgrade to 2.8.
464 *
465 * @param int $courseid The current course id.
466 */
467function hide_natural_aggregation_upgrade_notice($courseid) {
c8eb1fae 468 unset_config('show_sumofgrades_upgrade_' . $courseid);
a9937aec
DW
469}
470
c07775df
EM
471/**
472 * Hide warning about changed grades during upgrade from 2.8.0-2.8.6 and 2.9.0.
473 *
474 * @param int $courseid The current course id.
475 */
ebea19cb 476function grade_hide_min_max_grade_upgrade_notice($courseid) {
c07775df
EM
477 unset_config('show_min_max_grades_changed_' . $courseid);
478}
479
480/**
ebea19cb
FM
481 * Use the grade min and max from the grade_grade.
482 *
483 * This is reserved for core use after an upgrade.
c07775df
EM
484 *
485 * @param int $courseid The current course id.
486 */
ebea19cb
FM
487function grade_upgrade_use_min_max_from_grade_grade($courseid) {
488 grade_set_setting($courseid, 'minmaxtouse', GRADE_MIN_MAX_FROM_GRADE_GRADE);
c07775df
EM
489
490 grade_force_full_regrading($courseid);
491 // Do this now, because it probably happened to late in the page load to be happen automatically.
492 grade_regrade_final_grades($courseid);
493}
494
495/**
ebea19cb
FM
496 * Use the grade min and max from the grade_item.
497 *
498 * This is reserved for core use after an upgrade.
c07775df
EM
499 *
500 * @param int $courseid The current course id.
501 */
ebea19cb
FM
502function grade_upgrade_use_min_max_from_grade_item($courseid) {
503 grade_set_setting($courseid, 'minmaxtouse', GRADE_MIN_MAX_FROM_GRADE_ITEM);
c07775df
EM
504
505 grade_force_full_regrading($courseid);
506 // Do this now, because it probably happened to late in the page load to be happen automatically.
507 grade_regrade_final_grades($courseid);
508}
509
47d6e6a7
DW
510/**
511 * Hide warning about changed grades during upgrade to 2.8.
512 *
513 * @param int $courseid The current course id.
514 */
515function hide_aggregatesubcats_upgrade_notice($courseid) {
516 unset_config('show_aggregatesubcats_upgrade_' . $courseid);
517}
518
deb3d5ed
MG
519/**
520 * Hide warning about changed grades due to bug fixes
521 *
522 * @param int $courseid The current course id.
523 */
524function hide_gradebook_calculations_freeze_notice($courseid) {
525 unset_config('gradebook_calculations_freeze_' . $courseid);
526}
527
a9937aec
DW
528/**
529 * Print warning about changed grades during upgrade to 2.8.
530 *
531 * @param int $courseid The current course id.
532 * @param context $context The course context.
eafab799 533 * @param string $thispage The relative path for the current page. E.g. /grade/report/user/index.php
a9937aec
DW
534 * @param boolean $return return as string
535 *
536 * @return nothing or string if $return true
537 */
eafab799 538function print_natural_aggregation_upgrade_notice($courseid, $context, $thispage, $return=false) {
ebea19cb 539 global $CFG, $OUTPUT;
a9937aec 540 $html = '';
a9937aec 541
ebea19cb
FM
542 // Do not do anything if they cannot manage the grades of this course.
543 if (!has_capability('moodle/grade:manage', $context)) {
544 return $html;
545 }
546
eafab799
DW
547 $hidesubcatswarning = optional_param('seenaggregatesubcatsupgradedgrades', false, PARAM_BOOL) && confirm_sesskey();
548 $showsubcatswarning = get_config('core', 'show_aggregatesubcats_upgrade_' . $courseid);
549 $hidenaturalwarning = optional_param('seensumofgradesupgradedgrades', false, PARAM_BOOL) && confirm_sesskey();
550 $shownaturalwarning = get_config('core', 'show_sumofgrades_upgrade_' . $courseid);
ebea19cb 551
c07775df
EM
552 $hideminmaxwarning = optional_param('seenminmaxupgradedgrades', false, PARAM_BOOL) && confirm_sesskey();
553 $showminmaxwarning = get_config('core', 'show_min_max_grades_changed_' . $courseid);
eafab799 554
ebea19cb
FM
555 $useminmaxfromgradeitem = optional_param('useminmaxfromgradeitem', false, PARAM_BOOL) && confirm_sesskey();
556 $useminmaxfromgradegrade = optional_param('useminmaxfromgradegrade', false, PARAM_BOOL) && confirm_sesskey();
557
558 $minmaxtouse = grade_get_setting($courseid, 'minmaxtouse', $CFG->grade_minmaxtouse);
eafab799 559
deb3d5ed
MG
560 $gradebookcalculationsfreeze = get_config('core', 'gradebook_calculations_freeze_' . $courseid);
561 $acceptgradebookchanges = optional_param('acceptgradebookchanges', false, PARAM_BOOL) && confirm_sesskey();
562
eafab799
DW
563 // Hide the warning if the user told it to go away.
564 if ($hidenaturalwarning) {
565 hide_natural_aggregation_upgrade_notice($courseid);
566 }
567 // Hide the warning if the user told it to go away.
568 if ($hidesubcatswarning) {
569 hide_aggregatesubcats_upgrade_notice($courseid);
570 }
571
ebea19cb 572 // Hide the min/max warning if the user told it to go away.
c07775df 573 if ($hideminmaxwarning) {
ebea19cb
FM
574 grade_hide_min_max_grade_upgrade_notice($courseid);
575 $showminmaxwarning = false;
c07775df
EM
576 }
577
ebea19cb
FM
578 if ($useminmaxfromgradegrade) {
579 // Revert to the new behaviour, we now use the grade_grade for min/max.
580 grade_upgrade_use_min_max_from_grade_grade($courseid);
581 grade_hide_min_max_grade_upgrade_notice($courseid);
582 $showminmaxwarning = false;
583
584 } else if ($useminmaxfromgradeitem) {
585 // Apply the new logic, we now use the grade_item for min/max.
586 grade_upgrade_use_min_max_from_grade_item($courseid);
587 grade_hide_min_max_grade_upgrade_notice($courseid);
588 $showminmaxwarning = false;
c07775df
EM
589 }
590
591
eafab799 592 if (!$hidenaturalwarning && $shownaturalwarning) {
a9937aec 593 $message = get_string('sumofgradesupgradedgrades', 'grades');
47d6e6a7 594 $hidemessage = get_string('upgradedgradeshidemessage', 'grades');
a9937aec
DW
595 $urlparams = array( 'id' => $courseid,
596 'seensumofgradesupgradedgrades' => true,
597 'sesskey' => sesskey());
eafab799 598 $goawayurl = new moodle_url($thispage, $urlparams);
a9937aec
DW
599 $goawaybutton = $OUTPUT->single_button($goawayurl, $hidemessage, 'get');
600 $html .= $OUTPUT->notification($message, 'notifysuccess');
601 $html .= $goawaybutton;
602 }
603
eafab799 604 if (!$hidesubcatswarning && $showsubcatswarning) {
47d6e6a7
DW
605 $message = get_string('aggregatesubcatsupgradedgrades', 'grades');
606 $hidemessage = get_string('upgradedgradeshidemessage', 'grades');
607 $urlparams = array( 'id' => $courseid,
608 'seenaggregatesubcatsupgradedgrades' => true,
609 'sesskey' => sesskey());
eafab799 610 $goawayurl = new moodle_url($thispage, $urlparams);
47d6e6a7
DW
611 $goawaybutton = $OUTPUT->single_button($goawayurl, $hidemessage, 'get');
612 $html .= $OUTPUT->notification($message, 'notifysuccess');
613 $html .= $goawaybutton;
614 }
615
ebea19cb 616 if ($showminmaxwarning) {
c07775df
EM
617 $hidemessage = get_string('upgradedgradeshidemessage', 'grades');
618 $urlparams = array( 'id' => $courseid,
619 'seenminmaxupgradedgrades' => true,
620 'sesskey' => sesskey());
ebea19cb 621
c07775df 622 $goawayurl = new moodle_url($thispage, $urlparams);
ebea19cb
FM
623 $hideminmaxbutton = $OUTPUT->single_button($goawayurl, $hidemessage, 'get');
624 $moreinfo = html_writer::link(get_docs_url(get_string('minmaxtouse_link', 'grades')), get_string('moreinfo'),
625 array('target' => '_blank'));
626
627 if ($minmaxtouse == GRADE_MIN_MAX_FROM_GRADE_ITEM) {
628 // Show the message that there were min/max issues that have been resolved.
629 $message = get_string('minmaxupgradedgrades', 'grades') . ' ' . $moreinfo;
630
631 $revertmessage = get_string('upgradedminmaxrevertmessage', 'grades');
632 $urlparams = array('id' => $courseid,
633 'useminmaxfromgradegrade' => true,
634 'sesskey' => sesskey());
635 $reverturl = new moodle_url($thispage, $urlparams);
636 $revertbutton = $OUTPUT->single_button($reverturl, $revertmessage, 'get');
637
f677ece5 638 $html .= $OUTPUT->notification($message);
ebea19cb
FM
639 $html .= $revertbutton . $hideminmaxbutton;
640
641 } else if ($minmaxtouse == GRADE_MIN_MAX_FROM_GRADE_GRADE) {
642 // Show the warning that there are min/max issues that have not be resolved.
643 $message = get_string('minmaxupgradewarning', 'grades') . ' ' . $moreinfo;
644
645 $fixmessage = get_string('minmaxupgradefixbutton', 'grades');
646 $urlparams = array('id' => $courseid,
647 'useminmaxfromgradeitem' => true,
648 'sesskey' => sesskey());
649 $fixurl = new moodle_url($thispage, $urlparams);
650 $fixbutton = $OUTPUT->single_button($fixurl, $fixmessage, 'get');
651
f677ece5 652 $html .= $OUTPUT->notification($message);
ebea19cb
FM
653 $html .= $fixbutton . $hideminmaxbutton;
654 }
c07775df
EM
655 }
656
deb3d5ed
MG
657 if ($gradebookcalculationsfreeze) {
658 if ($acceptgradebookchanges) {
659 // Accept potential changes in grades caused by extra credit bug MDL-49257.
660 hide_gradebook_calculations_freeze_notice($courseid);
661 $courseitem = grade_item::fetch_course_item($courseid);
662 $courseitem->force_regrading();
663 grade_regrade_final_grades($courseid);
664
665 $html .= $OUTPUT->notification(get_string('gradebookcalculationsuptodate', 'grades'), 'notifysuccess');
666 } else {
667 // Show the warning that there may be extra credit weights problems.
668 $a = new stdClass();
669 $a->gradebookversion = $gradebookcalculationsfreeze;
670 if (preg_match('/(\d{8,})/', $CFG->release, $matches)) {
671 $a->currentversion = $matches[1];
672 } else {
673 $a->currentversion = $CFG->release;
674 }
6e4b8381 675 $a->url = get_docs_url('Gradebook_calculation_changes');
deb3d5ed
MG
676 $message = get_string('gradebookcalculationswarning', 'grades', $a);
677
678 $fixmessage = get_string('gradebookcalculationsfixbutton', 'grades');
679 $urlparams = array('id' => $courseid,
680 'acceptgradebookchanges' => true,
681 'sesskey' => sesskey());
682 $fixurl = new moodle_url($thispage, $urlparams);
683 $fixbutton = $OUTPUT->single_button($fixurl, $fixmessage, 'get');
684
f677ece5 685 $html .= $OUTPUT->notification($message);
deb3d5ed
MG
686 $html .= $fixbutton;
687 }
688 }
689
ebea19cb
FM
690 if (!empty($html)) {
691 $html = html_writer::tag('div', $html, array('class' => 'core_grades_notices'));
c07775df
EM
692 }
693
a9937aec
DW
694 if ($return) {
695 return $html;
696 } else {
697 echo $html;
698 }
699}
700
0610812a 701/**
702 * Print grading plugin selection popup form.
703 *
cf72e2dd 704 * @param array $plugin_info An array of plugins containing information for the selector
0610812a 705 * @param boolean $return return as string
cf72e2dd 706 *
0610812a 707 * @return nothing or string if $return true
708 */
f1a3e072 709function print_grade_plugin_selector($plugin_info, $active_type, $active_plugin, $return=false) {
714b4745 710 global $CFG, $OUTPUT, $PAGE;
dc482cfa 711
712 $menu = array();
713 $count = 0;
714 $active = '';
715
716 foreach ($plugin_info as $plugin_type => $plugins) {
717 if ($plugin_type == 'strings') {
718 continue;
719 }
720
7981d537 721 $first_plugin = reset($plugins);
dc482cfa 722
f1a3e072
PS
723 $sectionname = $plugin_info['strings'][$plugin_type];
724 $section = array();
d4dcfc6b 725
f1a3e072 726 foreach ($plugins as $plugin) {
d4dcfc6b 727 $link = $plugin->link->out(false);
f1a3e072
PS
728 $section[$link] = $plugin->string;
729 $count++;
730 if ($plugin_type === $active_type and $plugin->id === $active_plugin) {
731 $active = $link;
dc482cfa 732 }
733 }
f1a3e072
PS
734
735 if ($section) {
736 $menu[] = array($sectionname=>$section);
737 }
dc482cfa 738 }
739
cf72e2dd 740 // finally print/return the popup form
dc482cfa 741 if ($count > 1) {
f1a3e072 742 $select = new url_select($menu, $active, null, 'choosepluginreport');
29bea634 743 $select->set_label(get_string('gradereport', 'grades'), array('class' => 'accesshide'));
7981d537 744 if ($return) {
f1a3e072 745 return $OUTPUT->render($select);
7981d537 746 } else {
f1a3e072 747 echo $OUTPUT->render($select);
7981d537 748 }
dc482cfa 749 } else {
750 // only one option - no plugin selector needed
751 return '';
752 }
753}
754
755/**
756 * Print grading plugin selection tab-based navigation.
757 *
cf72e2dd 758 * @param string $active_type type of plugin on current page - import, export, report or edit
759 * @param string $active_plugin active plugin type - grader, user, cvs, ...
760 * @param array $plugin_info Array of plugins
dc482cfa 761 * @param boolean $return return as string
cf72e2dd 762 *
dc482cfa 763 * @return nothing or string if $return true
764 */
b827784e 765function grade_print_tabs($active_type, $active_plugin, $plugin_info, $return=false) {
dc482cfa 766 global $CFG, $COURSE;
1c1f64a2 767
e1513ca9 768 if (!isset($currenttab)) { //TODO: this is weird
dc482cfa 769 $currenttab = '';
770 }
771
772 $tabs = array();
773 $top_row = array();
774 $bottom_row = array();
775 $inactive = array($active_plugin);
f48d5209 776 $activated = array($active_type);
dc482cfa 777
778 $count = 0;
779 $active = '';
780
781 foreach ($plugin_info as $plugin_type => $plugins) {
782 if ($plugin_type == 'strings') {
783 continue;
784 }
785
786 // If $plugins is actually the definition of a child-less parent link:
cf72e2dd 787 if (!empty($plugins->id)) {
788 $string = $plugins->string;
789 if (!empty($plugin_info[$active_type]->parent)) {
790 $string = $plugin_info[$active_type]->parent->string;
27eef3bb 791 }
792
cf72e2dd 793 $top_row[] = new tabobject($plugin_type, $plugins->link, $string);
dc482cfa 794 continue;
795 }
796
797 $first_plugin = reset($plugins);
cf72e2dd 798 $url = $first_plugin->link;
dc482cfa 799
800 if ($plugin_type == 'report') {
801 $url = $CFG->wwwroot.'/grade/report/index.php?id='.$COURSE->id;
802 }
803
804 $top_row[] = new tabobject($plugin_type, $url, $plugin_info['strings'][$plugin_type]);
805
806 if ($active_type == $plugin_type) {
807 foreach ($plugins as $plugin) {
cf72e2dd 808 $bottom_row[] = new tabobject($plugin->id, $plugin->link, $plugin->string);
809 if ($plugin->id == $active_plugin) {
810 $inactive = array($plugin->id);
dc482cfa 811 }
812 }
813 }
814 }
815
816 $tabs[] = $top_row;
817 $tabs[] = $bottom_row;
818
819 if ($return) {
f48d5209 820 return print_tabs($tabs, $active_plugin, $inactive, $activated, true);
dc482cfa 821 } else {
f48d5209 822 print_tabs($tabs, $active_plugin, $inactive, $activated);
dc482cfa 823 }
824}
825
cf72e2dd 826/**
827 * grade_get_plugin_info
828 *
829 * @param int $courseid The course id
830 * @param string $active_type type of plugin on current page - import, export, report or edit
831 * @param string $active_plugin active plugin type - grader, user, cvs, ...
832 *
833 * @return array
834 */
dc482cfa 835function grade_get_plugin_info($courseid, $active_type, $active_plugin) {
f7fcf4cd 836 global $CFG, $SITE;
cbff94ba 837
d4060472 838 $context = context_course::instance($courseid);
cbff94ba 839
dc482cfa 840 $plugin_info = array();
6e2f3121 841 $count = 0;
3af29899 842 $active = '';
dc482cfa 843 $url_prefix = $CFG->wwwroot . '/grade/';
844
845 // Language strings
4d5059d4 846 $plugin_info['strings'] = grade_helper::get_plugin_strings();
b827784e 847
4d5059d4
SH
848 if ($reports = grade_helper::get_plugins_reports($courseid)) {
849 $plugin_info['report'] = $reports;
b827784e 850 }
c46aeeab 851
eb84b779
MG
852 if ($settings = grade_helper::get_info_manage_settings($courseid)) {
853 $plugin_info['settings'] = $settings;
854 }
855
4d5059d4
SH
856 if ($scale = grade_helper::get_info_scales($courseid)) {
857 $plugin_info['scale'] = array('view'=>$scale);
cbff94ba 858 }
dc482cfa 859
4d5059d4
SH
860 if ($outcomes = grade_helper::get_info_outcomes($courseid)) {
861 $plugin_info['outcome'] = $outcomes;
cbff94ba 862 }
cbff94ba 863
4d5059d4
SH
864 if ($letters = grade_helper::get_info_letters($courseid)) {
865 $plugin_info['letter'] = $letters;
cbff94ba 866 }
4d5059d4
SH
867
868 if ($imports = grade_helper::get_plugins_import($courseid)) {
869 $plugin_info['import'] = $imports;
281ffa4a 870 }
c46aeeab 871
4d5059d4
SH
872 if ($exports = grade_helper::get_plugins_export($courseid)) {
873 $plugin_info['export'] = $exports;
281ffa4a 874 }
281ffa4a 875
4d5059d4
SH
876 foreach ($plugin_info as $plugin_type => $plugins) {
877 if (!empty($plugins->id) && $active_plugin == $plugins->id) {
878 $plugin_info['strings']['active_plugin_str'] = $plugins->string;
879 break;
281ffa4a 880 }
4d5059d4
SH
881 foreach ($plugins as $plugin) {
882 if (is_a($plugin, 'grade_plugin_info')) {
883 if ($active_plugin == $plugin->id) {
884 $plugin_info['strings']['active_plugin_str'] = $plugin->string;
885 }
3af29899 886 }
281ffa4a 887 }
cbff94ba 888 }
c46aeeab 889
dc482cfa 890 return $plugin_info;
891}
284abb09 892
cf72e2dd 893/**
894 * A simple class containing info about grade plugins.
895 * Can be subclassed for special rules
896 *
a153c9f2 897 * @package core_grades
cf72e2dd 898 * @copyright 2009 Nicolas Connault
899 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
900 */
901class grade_plugin_info {
902 /**
903 * A unique id for this plugin
904 *
905 * @var mixed
906 */
907 public $id;
908 /**
909 * A URL to access this plugin
910 *
911 * @var mixed
912 */
913 public $link;
914 /**
915 * The name of this plugin
916 *
917 * @var mixed
918 */
919 public $string;
920 /**
921 * Another grade_plugin_info object, parent of the current one
922 *
923 * @var mixed
924 */
925 public $parent;
926
927 /**
928 * Constructor
929 *
930 * @param int $id A unique id for this plugin
931 * @param string $link A URL to access this plugin
932 * @param string $string The name of this plugin
933 * @param object $parent Another grade_plugin_info object, parent of the current one
934 *
935 * @return void
936 */
937 public function __construct($id, $link, $string, $parent=null) {
938 $this->id = $id;
939 $this->link = $link;
940 $this->string = $string;
941 $this->parent = $parent;
942 }
943}
944
de0300ea 945/**
946 * Prints the page headers, breadcrumb trail, page heading, (optional) dropdown navigation menu and
947 * (optional) navigation tabs for any gradebook page. All gradebook pages MUST use these functions
948 * in favour of the usual print_header(), print_header_simple(), print_heading() etc.
949 * !IMPORTANT! Use of tabs.php file in gradebook pages is forbidden unless tabs are switched off at
950 * the site level for the gradebook ($CFG->grade_navmethod = GRADE_NAVMETHOD_DROPDOWN).
951 *
cf72e2dd 952 * @param int $courseid Course id
953 * @param string $active_type The type of the current page (report, settings,
954 * import, export, scales, outcomes, letters)
955 * @param string $active_plugin The plugin of the current page (grader, fullview etc...)
956 * @param string $heading The heading of the page. Tries to guess if none is given
de0300ea 957 * @param boolean $return Whether to return (true) or echo (false) the HTML generated by this function
cf72e2dd 958 * @param string $bodytags Additional attributes that will be added to the <body> tag
959 * @param string $buttons Additional buttons to display on the page
5625d33d 960 * @param boolean $shownavigation should the gradebook navigation drop down (or tabs) be shown?
1464bcc8
AG
961 * @param string $headerhelpidentifier The help string identifier if required.
962 * @param string $headerhelpcomponent The component for the help string.
1acbd1f9 963 * @param stdClass $user The user object for use with the user context header.
de0300ea 964 *
965 * @return string HTML code or nothing if $return == false
966 */
cf72e2dd 967function print_grade_page_head($courseid, $active_type, $active_plugin=null,
34a2777c 968 $heading = false, $return=false,
1acbd1f9
AG
969 $buttons=false, $shownavigation=true, $headerhelpidentifier = null, $headerhelpcomponent = null,
970 $user = null) {
4d5059d4 971 global $CFG, $OUTPUT, $PAGE;
c46aeeab 972
eb84b779
MG
973 if ($active_type === 'preferences') {
974 // In Moodle 2.8 report preferences were moved under 'settings'. Allow backward compatibility for 3rd party grade reports.
975 $active_type = 'settings';
976 }
977
dc482cfa 978 $plugin_info = grade_get_plugin_info($courseid, $active_type, $active_plugin);
c46aeeab 979
dc482cfa 980 // Determine the string of the active plugin
981 $stractive_plugin = ($active_plugin) ? $plugin_info['strings']['active_plugin_str'] : $heading;
982 $stractive_type = $plugin_info['strings'][$active_type];
e0724506 983
cf72e2dd 984 if (empty($plugin_info[$active_type]->id) || !empty($plugin_info[$active_type]->parent)) {
4d5059d4
SH
985 $title = $PAGE->course->fullname.': ' . $stractive_type . ': ' . $stractive_plugin;
986 } else {
987 $title = $PAGE->course->fullname.': ' . $stractive_plugin;
c4c97a6d 988 }
989
367a75fa
SH
990 if ($active_type == 'report') {
991 $PAGE->set_pagelayout('report');
992 } else {
993 $PAGE->set_pagelayout('admin');
994 }
4d5059d4 995 $PAGE->set_title(get_string('grades') . ': ' . $stractive_type);
f3df5e14 996 $PAGE->set_heading($title);
4d5059d4
SH
997 if ($buttons instanceof single_button) {
998 $buttons = $OUTPUT->render($buttons);
999 }
f3df5e14 1000 $PAGE->set_button($buttons);
6bf696bb
MG
1001 if ($courseid != SITEID) {
1002 grade_extend_settings($plugin_info, $courseid);
1003 }
4d5059d4 1004
0c31d924
AN
1005 // Set the current report as active in the breadcrumbs.
1006 if ($active_plugin !== null && $reportnav = $PAGE->settingsnav->find($active_plugin, navigation_node::TYPE_SETTING)) {
1007 $reportnav->make_active();
1008 }
1009
f3df5e14 1010 $returnval = $OUTPUT->header();
1464bcc8 1011
f3df5e14 1012 if (!$return) {
1013 echo $returnval;
1014 }
dc482cfa 1015
1016 // Guess heading if not given explicitly
1017 if (!$heading) {
1018 $heading = $stractive_plugin;
1019 }
1020
2821c495 1021 if ($shownavigation) {
1acbd1f9 1022 $navselector = null;
6bf696bb
MG
1023 if ($courseid != SITEID &&
1024 ($CFG->grade_navmethod == GRADE_NAVMETHOD_COMBO || $CFG->grade_navmethod == GRADE_NAVMETHOD_DROPDOWN)) {
1acbd1f9
AG
1025 // It's absolutely essential that this grade plugin selector is shown after the user header. Just ask Fred.
1026 $navselector = print_grade_plugin_selector($plugin_info, $active_type, $active_plugin, true);
1027 if ($return) {
1028 $returnval .= $navselector;
1029 } else if (!isset($user)) {
1030 echo $navselector;
1031 }
2821c495 1032 }
5625d33d 1033
1464bcc8
AG
1034 $output = '';
1035 // Add a help dialogue box if provided.
1036 if (isset($headerhelpidentifier)) {
1037 $output = $OUTPUT->heading_with_help($heading, $headerhelpidentifier, $headerhelpcomponent);
1038 } else {
1acbd1f9
AG
1039 if (isset($user)) {
1040 $output = $OUTPUT->context_header(
1041 array(
1042 'heading' => fullname($user),
1043 'user' => $user,
1044 'usercontext' => context_user::instance($user->id)
1045 ), 2
1046 ) . $navselector;
1047 } else {
1048 $output = $OUTPUT->heading($heading);
1049 }
1464bcc8
AG
1050 }
1051
5625d33d 1052 if ($return) {
1464bcc8 1053 $returnval .= $output;
5625d33d 1054 } else {
1464bcc8 1055 echo $output;
5625d33d
AD
1056 }
1057
6bf696bb
MG
1058 if ($courseid != SITEID &&
1059 ($CFG->grade_navmethod == GRADE_NAVMETHOD_COMBO || $CFG->grade_navmethod == GRADE_NAVMETHOD_TABS)) {
2821c495
AD
1060 $returnval .= grade_print_tabs($active_type, $active_plugin, $plugin_info, $return);
1061 }
8354e716 1062 }
dc482cfa 1063
eafab799
DW
1064 $returnval .= print_natural_aggregation_upgrade_notice($courseid,
1065 context_course::instance($courseid),
f01972d9 1066 $PAGE->url,
eafab799
DW
1067 $return);
1068
dc482cfa 1069 if ($return) {
1070 return $returnval;
6e2f3121 1071 }
cbff94ba 1072}
1073
0610812a 1074/**
7a6b7acf 1075 * Utility class used for return tracking when using edit and other forms in grade plugins
cf72e2dd 1076 *
a153c9f2 1077 * @package core_grades
cf72e2dd 1078 * @copyright 2009 Nicolas Connault
1079 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
0610812a 1080 */
3af29899 1081class grade_plugin_return {
d24832f9 1082 public $type;
1083 public $plugin;
1084 public $courseid;
1085 public $userid;
1086 public $page;
281ffa4a 1087
0610812a 1088 /**
1089 * Constructor
cf72e2dd 1090 *
0610812a 1091 * @param array $params - associative array with return parameters, if null parameter are taken from _GET or _POST
1092 */
c4d0b752 1093 public function __construct($params = null) {
3af29899 1094 if (empty($params)) {
1095 $this->type = optional_param('gpr_type', null, PARAM_SAFEDIR);
aff24313 1096 $this->plugin = optional_param('gpr_plugin', null, PARAM_PLUGIN);
3af29899 1097 $this->courseid = optional_param('gpr_courseid', null, PARAM_INT);
1098 $this->userid = optional_param('gpr_userid', null, PARAM_INT);
1099 $this->page = optional_param('gpr_page', null, PARAM_INT);
a983b6ec 1100
a983b6ec 1101 } else {
3af29899 1102 foreach ($params as $key=>$value) {
4cc977a6 1103 if (property_exists($this, $key)) {
3af29899 1104 $this->$key = $value;
1105 }
cbff94ba 1106 }
1107 }
6cd8c592 1108 }
1109
9e313e79
DM
1110 /**
1111 * Old syntax of class constructor. Deprecated in PHP7.
1112 *
1113 * @deprecated since Moodle 3.1
1114 */
1115 public function grade_plugin_return($params = null) {
1116 debugging('Use of class name as constructor is deprecated', DEBUG_DEVELOPER);
1117 self::__construct($params);
1118 }
1119
0610812a 1120 /**
1121 * Returns return parameters as options array suitable for buttons.
1122 * @return array options
1123 */
d24832f9 1124 public function get_options() {
7a6b7acf 1125 if (empty($this->type)) {
3af29899 1126 return array();
865e9a82 1127 }
6cd8c592 1128
3af29899 1129 $params = array();
6cd8c592 1130
7a6b7acf 1131 if (!empty($this->plugin)) {
1132 $params['plugin'] = $this->plugin;
1133 }
6cd8c592 1134
3af29899 1135 if (!empty($this->courseid)) {
1136 $params['id'] = $this->courseid;
6cd8c592 1137 }
9c61ba4d 1138
3af29899 1139 if (!empty($this->userid)) {
1140 $params['userid'] = $this->userid;
9c61ba4d 1141 }
9c61ba4d 1142
3af29899 1143 if (!empty($this->page)) {
1144 $params['page'] = $this->page;
cbff94ba 1145 }
865e9a82 1146
3af29899 1147 return $params;
cbff94ba 1148 }
cbff94ba 1149
0610812a 1150 /**
1151 * Returns return url
cf72e2dd 1152 *
0610812a 1153 * @param string $default default url when params not set
cf72e2dd 1154 * @param array $extras Extra URL parameters
1155 *
0610812a 1156 * @return string url
1157 */
d24832f9 1158 public function get_return_url($default, $extras=null) {
3af29899 1159 global $CFG;
cbff94ba 1160
3af29899 1161 if (empty($this->type) or empty($this->plugin)) {
1162 return $default;
cbff94ba 1163 }
1164
65dd61bd 1165 $url = $CFG->wwwroot.'/grade/'.$this->type.'/'.$this->plugin.'/index.php';
1166 $glue = '?';
cbff94ba 1167
3af29899 1168 if (!empty($this->courseid)) {
1169 $url .= $glue.'id='.$this->courseid;
1170 $glue = '&amp;';
cbff94ba 1171 }
cbff94ba 1172
3af29899 1173 if (!empty($this->userid)) {
1174 $url .= $glue.'userid='.$this->userid;
1175 $glue = '&amp;';
cbff94ba 1176 }
7e2d7c92 1177
3af29899 1178 if (!empty($this->page)) {
1179 $url .= $glue.'page='.$this->page;
65dd61bd 1180 $glue = '&amp;';
1181 }
1182
1183 if (!empty($extras)) {
cf72e2dd 1184 foreach ($extras as $key=>$value) {
65dd61bd 1185 $url .= $glue.$key.'='.$value;
1186 $glue = '&amp;';
7a6b7acf 1187 }
cbff94ba 1188 }
cbff94ba 1189
3af29899 1190 return $url;
cbff94ba 1191 }
cbff94ba 1192
0610812a 1193 /**
1194 * Returns string with hidden return tracking form elements.
1195 * @return string
1196 */
d24832f9 1197 public function get_form_fields() {
7a6b7acf 1198 if (empty($this->type)) {
3af29899 1199 return '';
cbff94ba 1200 }
cbff94ba 1201
3af29899 1202 $result = '<input type="hidden" name="gpr_type" value="'.$this->type.'" />';
7a6b7acf 1203
1204 if (!empty($this->plugin)) {
1205 $result .= '<input type="hidden" name="gpr_plugin" value="'.$this->plugin.'" />';
1206 }
0ca5abd6 1207
3af29899 1208 if (!empty($this->courseid)) {
1209 $result .= '<input type="hidden" name="gpr_courseid" value="'.$this->courseid.'" />';
cbff94ba 1210 }
cbff94ba 1211
3af29899 1212 if (!empty($this->userid)) {
1213 $result .= '<input type="hidden" name="gpr_userid" value="'.$this->userid.'" />';
cbff94ba 1214 }
cbff94ba 1215
3af29899 1216 if (!empty($this->page)) {
1217 $result .= '<input type="hidden" name="gpr_page" value="'.$this->page.'" />';
cbff94ba 1218 }
1219 }
cbff94ba 1220
0610812a 1221 /**
1222 * Add hidden elements into mform
cf72e2dd 1223 *
1224 * @param object &$mform moodle form object
1225 *
0610812a 1226 * @return void
1227 */
d24832f9 1228 public function add_mform_elements(&$mform) {
7a6b7acf 1229 if (empty($this->type)) {
3af29899 1230 return;
cbff94ba 1231 }
cbff94ba 1232
3af29899 1233 $mform->addElement('hidden', 'gpr_type', $this->type);
1234 $mform->setType('gpr_type', PARAM_SAFEDIR);
cbff94ba 1235
7a6b7acf 1236 if (!empty($this->plugin)) {
1237 $mform->addElement('hidden', 'gpr_plugin', $this->plugin);
aff24313 1238 $mform->setType('gpr_plugin', PARAM_PLUGIN);
7a6b7acf 1239 }
97033c86 1240
3af29899 1241 if (!empty($this->courseid)) {
1242 $mform->addElement('hidden', 'gpr_courseid', $this->courseid);
1243 $mform->setType('gpr_courseid', PARAM_INT);
cbff94ba 1244 }
cbff94ba 1245
3af29899 1246 if (!empty($this->userid)) {
1247 $mform->addElement('hidden', 'gpr_userid', $this->userid);
1248 $mform->setType('gpr_userid', PARAM_INT);
cbff94ba 1249 }
cbff94ba 1250
3af29899 1251 if (!empty($this->page)) {
1252 $mform->addElement('hidden', 'gpr_page', $this->page);
1253 $mform->setType('gpr_page', PARAM_INT);
cbff94ba 1254 }
1255 }
281ffa4a 1256
0610812a 1257 /**
1258 * Add return tracking params into url
cf72e2dd 1259 *
1c1f64a2 1260 * @param moodle_url $url A URL
cf72e2dd 1261 *
6ef4878b 1262 * @return string $url with return tracking params
0610812a 1263 */
1c1f64a2 1264 public function add_url_params(moodle_url $url) {
7a6b7acf 1265 if (empty($this->type)) {
3af29899 1266 return $url;
cbff94ba 1267 }
5609f9e6 1268
1c1f64a2 1269 $url->param('gpr_type', $this->type);
cbff94ba 1270
7a6b7acf 1271 if (!empty($this->plugin)) {
1c1f64a2 1272 $url->param('gpr_plugin', $this->plugin);
7a6b7acf 1273 }
cbff94ba 1274
3af29899 1275 if (!empty($this->courseid)) {
1c1f64a2 1276 $url->param('gpr_courseid' ,$this->courseid);
cbff94ba 1277 }
cbff94ba 1278
3af29899 1279 if (!empty($this->userid)) {
1c1f64a2 1280 $url->param('gpr_userid', $this->userid);
cbff94ba 1281 }
0a8a95c9 1282
3af29899 1283 if (!empty($this->page)) {
1c1f64a2 1284 $url->param('gpr_page', $this->page);
0a8a95c9 1285 }
5a412dbf 1286
3af29899 1287 return $url;
5a412dbf 1288 }
5a412dbf 1289}
7a6b7acf 1290
826c5f86 1291/**
1292 * Function central to gradebook for building and printing the navigation (breadcrumb trail).
cf72e2dd 1293 *
826c5f86 1294 * @param string $path The path of the calling script (using __FILE__?)
1295 * @param string $pagename The language string to use as the last part of the navigation (non-link)
cf72e2dd 1296 * @param mixed $id Either a plain integer (assuming the key is 'id') or
1297 * an array of keys and values (e.g courseid => $courseid, itemid...)
1298 *
826c5f86 1299 * @return string
1300 */
1301function grade_build_nav($path, $pagename=null, $id=null) {
f3df5e14 1302 global $CFG, $COURSE, $PAGE;
826c5f86 1303
1304 $strgrades = get_string('grades', 'grades');
1305
1306 // Parse the path and build navlinks from its elements
1307 $dirroot_length = strlen($CFG->dirroot) + 1; // Add 1 for the first slash
1308 $path = substr($path, $dirroot_length);
1309 $path = str_replace('\\', '/', $path);
1310
1311 $path_elements = explode('/', $path);
1312
1313 $path_elements_count = count($path_elements);
1314
826c5f86 1315 // First link is always 'grade'
a6855934 1316 $PAGE->navbar->add($strgrades, new moodle_url('/grade/index.php', array('id'=>$COURSE->id)));
826c5f86 1317
f3df5e14 1318 $link = null;
826c5f86 1319 $numberofelements = 3;
1320
1321 // Prepare URL params string
f3df5e14 1322 $linkparams = array();
826c5f86 1323 if (!is_null($id)) {
1324 if (is_array($id)) {
1325 foreach ($id as $idkey => $idvalue) {
f3df5e14 1326 $linkparams[$idkey] = $idvalue;
826c5f86 1327 }
1328 } else {
f3df5e14 1329 $linkparams['id'] = $id;
826c5f86 1330 }
1331 }
1332
1333 $navlink4 = null;
1334
0f78c4de 1335 // Remove file extensions from filenames
1336 foreach ($path_elements as $key => $filename) {
1337 $path_elements[$key] = str_replace('.php', '', $filename);
1338 }
1339
826c5f86 1340 // Second level links
1341 switch ($path_elements[1]) {
1342 case 'edit': // No link
1343 if ($path_elements[3] != 'index.php') {
1344 $numberofelements = 4;
1345 }
1346 break;
1347 case 'import': // No link
1348 break;
1349 case 'export': // No link
1350 break;
1351 case 'report':
1352 // $id is required for this link. Do not print it if $id isn't given
1353 if (!is_null($id)) {
a6855934 1354 $link = new moodle_url('/grade/report/index.php', $linkparams);
826c5f86 1355 }
1356
1357 if ($path_elements[2] == 'grader') {
1358 $numberofelements = 4;
1359 }
1360 break;
1361
1362 default:
1363 // If this element isn't among the ones already listed above, it isn't supported, throw an error.
cf72e2dd 1364 debugging("grade_build_nav() doesn't support ". $path_elements[1] .
1365 " as the second path element after 'grade'.");
826c5f86 1366 return false;
1367 }
f3df5e14 1368 $PAGE->navbar->add(get_string($path_elements[1], 'grades'), $link);
826c5f86 1369
1370 // Third level links
1371 if (empty($pagename)) {
1372 $pagename = get_string($path_elements[2], 'grades');
1373 }
1374
1375 switch ($numberofelements) {
1376 case 3:
f3df5e14 1377 $PAGE->navbar->add($pagename, $link);
826c5f86 1378 break;
1379 case 4:
826c5f86 1380 if ($path_elements[2] == 'grader' AND $path_elements[3] != 'index.php') {
b5e7b2bf 1381 $PAGE->navbar->add(get_string('pluginname', 'gradereport_grader'), new moodle_url('/grade/report/grader/index.php', $linkparams));
826c5f86 1382 }
f3df5e14 1383 $PAGE->navbar->add($pagename);
826c5f86 1384 break;
1385 }
826c5f86 1386
f3df5e14 1387 return '';
d4795a07 1388}
7a6b7acf 1389
e98871a2 1390/**
6cc3e350 1391 * General structure representing grade items in course
cf72e2dd 1392 *
a153c9f2 1393 * @package core_grades
cf72e2dd 1394 * @copyright 2009 Nicolas Connault
1395 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
e98871a2 1396 */
6cc3e350 1397class grade_structure {
d24832f9 1398 public $context;
e98871a2 1399
d24832f9 1400 public $courseid;
e98871a2 1401
73ca5f01 1402 /**
1403 * Reference to modinfo for current course (for performance, to save
1404 * retrieving it from courseid every time). Not actually set except for
1405 * the grade_tree type.
1406 * @var course_modinfo
1407 */
1408 public $modinfo;
1409
e98871a2 1410 /**
1411 * 1D array of grade items only
1412 */
d24832f9 1413 public $items;
e98871a2 1414
6391ebe7 1415 /**
6cc3e350 1416 * Returns icon of element
cf72e2dd 1417 *
1418 * @param array &$element An array representing an element in the grade_tree
1419 * @param bool $spacerifnone return spacer if no icon found
1420 *
6cc3e350 1421 * @return string icon or spacer
6391ebe7 1422 */
d24832f9 1423 public function get_element_icon(&$element, $spacerifnone=false) {
6b608f8f 1424 global $CFG, $OUTPUT;
559276b1 1425 require_once $CFG->libdir.'/filelib.php';
6cc3e350 1426
1ef48469
JC
1427 $outputstr = '';
1428
1429 // Object holding pix_icon information before instantiation.
1430 $icon = new stdClass();
1431 $icon->attributes = array(
09235e24 1432 'class' => 'icon itemicon'
1ef48469
JC
1433 );
1434 $icon->component = 'moodle';
1435
1436 $none = true;
6cc3e350 1437 switch ($element['type']) {
1438 case 'item':
1439 case 'courseitem':
1440 case 'categoryitem':
1ef48469
JC
1441 $none = false;
1442
cf72e2dd 1443 $is_course = $element['object']->is_course_item();
1444 $is_category = $element['object']->is_category_item();
1445 $is_scale = $element['object']->gradetype == GRADE_TYPE_SCALE;
1446 $is_value = $element['object']->gradetype == GRADE_TYPE_VALUE;
0077f571 1447 $is_outcome = !empty($element['object']->outcomeid);
cf72e2dd 1448
6cc3e350 1449 if ($element['object']->is_calculated()) {
1ef48469
JC
1450 $icon->pix = 'i/calc';
1451 $icon->title = s(get_string('calculatedgrade', 'grades'));
6cc3e350 1452
cf72e2dd 1453 } else if (($is_course or $is_category) and ($is_scale or $is_value)) {
6cc3e350 1454 if ($category = $element['object']->get_item_category()) {
bfe969e8
DW
1455 $aggrstrings = grade_helper::get_aggregation_strings();
1456 $stragg = $aggrstrings[$category->aggregation];
1ef48469
JC
1457
1458 $icon->pix = 'i/calc';
1459 $icon->title = s($stragg);
1460
6cc3e350 1461 switch ($category->aggregation) {
1462 case GRADE_AGGREGATE_MEAN:
1463 case GRADE_AGGREGATE_MEDIAN:
1464 case GRADE_AGGREGATE_WEIGHTED_MEAN:
1426edac 1465 case GRADE_AGGREGATE_WEIGHTED_MEAN2:
6cc3e350 1466 case GRADE_AGGREGATE_EXTRACREDIT_MEAN:
1ef48469
JC
1467 $icon->pix = 'i/agg_mean';
1468 break;
0758a08e 1469 case GRADE_AGGREGATE_SUM:
1ef48469
JC
1470 $icon->pix = 'i/agg_sum';
1471 break;
6cc3e350 1472 }
1473 }
1474
1475 } else if ($element['object']->itemtype == 'mod') {
1ef48469 1476 // Prevent outcomes displaying the same icon as the activity they are attached to.
0077f571 1477 if ($is_outcome) {
1ef48469
JC
1478 $icon->pix = 'i/outcomes';
1479 $icon->title = s(get_string('outcome', 'grades'));
0077f571 1480 } else {
1ef48469
JC
1481 $icon->pix = 'icon';
1482 $icon->component = $element['object']->itemmodule;
1483 $icon->title = s(get_string('modulename', $element['object']->itemmodule));
0077f571 1484 }
6cc3e350 1485 } else if ($element['object']->itemtype == 'manual') {
1486 if ($element['object']->is_outcome_item()) {
1ef48469
JC
1487 $icon->pix = 'i/outcomes';
1488 $icon->title = s(get_string('outcome', 'grades'));
6cc3e350 1489 } else {
1ef48469
JC
1490 $icon->pix = 'i/manual_item';
1491 $icon->title = s(get_string('manualitem', 'grades'));
6cc3e350 1492 }
1493 }
1494 break;
1495
1496 case 'category':
1ef48469
JC
1497 $none = false;
1498 $icon->pix = 'i/folder';
1499 $icon->title = s(get_string('category', 'grades'));
1500 break;
6cc3e350 1501 }
1502
1ef48469
JC
1503 if ($none) {
1504 if ($spacerifnone) {
1505 $outputstr = $OUTPUT->spacer() . ' ';
1506 }
6cc3e350 1507 } else {
1ef48469 1508 $outputstr = $OUTPUT->pix_icon($icon->pix, $icon->title, $icon->component, $icon->attributes);
6cc3e350 1509 }
1ef48469
JC
1510
1511 return $outputstr;
6cc3e350 1512 }
6391ebe7 1513
e98871a2 1514 /**
6cc3e350 1515 * Returns name of element optionally with icon and link
cf72e2dd 1516 *
1517 * @param array &$element An array representing an element in the grade_tree
1518 * @param bool $withlink Whether or not this header has a link
1519 * @param bool $icon Whether or not to display an icon with this header
1520 * @param bool $spacerifnone return spacer if no icon found
65c2ac93 1521 * @param bool $withdescription Show description if defined by this item.
41e62a90
AN
1522 * @param bool $fulltotal If the item is a category total, returns $categoryname."total"
1523 * instead of "Category total" or "Course total"
cf72e2dd 1524 *
1525 * @return string header
e98871a2 1526 */
41e62a90
AN
1527 public function get_element_header(&$element, $withlink = false, $icon = true, $spacerifnone = false,
1528 $withdescription = false, $fulltotal = false) {
6cc3e350 1529 $header = '';
1530
1531 if ($icon) {
1532 $header .= $this->get_element_icon($element, $spacerifnone);
1533 }
1534
41e62a90 1535 $header .= $element['object']->get_name($fulltotal);
6cc3e350 1536
cf72e2dd 1537 if ($element['type'] != 'item' and $element['type'] != 'categoryitem' and
1538 $element['type'] != 'courseitem') {
6cc3e350 1539 return $header;
1540 }
1541
43cd76e8
JC
1542 if ($withlink && $url = $this->get_activity_link($element)) {
1543 $a = new stdClass();
1544 $a->name = get_string('modulename', $element['object']->itemmodule);
1545 $title = get_string('linktoactivity', 'grades', $a);
1546
1547 $header = html_writer::link($url, $header, array('title' => $title));
1548 } else {
1549 $header = html_writer::span($header);
6cc3e350 1550 }
1551
65c2ac93
DW
1552 if ($withdescription) {
1553 $desc = $element['object']->get_description();
1554 if (!empty($desc)) {
1555 $header .= '<div class="gradeitemdescription">' . s($desc) . '</div><div class="gradeitemdescriptionfiller"></div>';
1556 }
1557 }
1558
6cc3e350 1559 return $header;
1560 }
1561
73ca5f01 1562 private function get_activity_link($element) {
1563 global $CFG;
eff314b0
DM
1564 /** @var array static cache of the grade.php file existence flags */
1565 static $hasgradephp = array();
73ca5f01 1566
1567 $itemtype = $element['object']->itemtype;
1568 $itemmodule = $element['object']->itemmodule;
1569 $iteminstance = $element['object']->iteminstance;
25ab1d50 1570 $itemnumber = $element['object']->itemnumber;
73ca5f01 1571
1572 // Links only for module items that have valid instance, module and are
1573 // called from grade_tree with valid modinfo
1574 if ($itemtype != 'mod' || !$iteminstance || !$itemmodule || !$this->modinfo) {
1575 return null;
1576 }
1577
1578 // Get $cm efficiently and with visibility information using modinfo
1579 $instances = $this->modinfo->get_instances();
1580 if (empty($instances[$itemmodule][$iteminstance])) {
1581 return null;
1582 }
1583 $cm = $instances[$itemmodule][$iteminstance];
1584
1585 // Do not add link if activity is not visible to the current user
1586 if (!$cm->uservisible) {
1587 return null;
1588 }
1589
eff314b0
DM
1590 if (!array_key_exists($itemmodule, $hasgradephp)) {
1591 if (file_exists($CFG->dirroot . '/mod/' . $itemmodule . '/grade.php')) {
1592 $hasgradephp[$itemmodule] = true;
1593 } else {
1594 $hasgradephp[$itemmodule] = false;
1595 }
1596 }
1597
73ca5f01 1598 // If module has grade.php, link to that, otherwise view.php
eff314b0 1599 if ($hasgradephp[$itemmodule]) {
c97933ff
MG
1600 $args = array('id' => $cm->id, 'itemnumber' => $itemnumber);
1601 if (isset($element['userid'])) {
1602 $args['userid'] = $element['userid'];
1603 }
1604 return new moodle_url('/mod/' . $itemmodule . '/grade.php', $args);
73ca5f01 1605 } else {
1606 return new moodle_url('/mod/' . $itemmodule . '/view.php', array('id' => $cm->id));
1607 }
1608 }
1609
bb17ac1e
DM
1610 /**
1611 * Returns URL of a page that is supposed to contain detailed grade analysis
1612 *
bb17ac1e
DM
1613 * At the moment, only activity modules are supported. The method generates link
1614 * to the module's file grade.php with the parameters id (cmid), itemid, itemnumber,
eff314b0 1615 * gradeid and userid. If the grade.php does not exist, null is returned.
bb17ac1e
DM
1616 *
1617 * @return moodle_url|null URL or null if unable to construct it
1618 */
1619 public function get_grade_analysis_url(grade_grade $grade) {
eff314b0
DM
1620 global $CFG;
1621 /** @var array static cache of the grade.php file existence flags */
1622 static $hasgradephp = array();
bb17ac1e
DM
1623
1624 if (empty($grade->grade_item) or !($grade->grade_item instanceof grade_item)) {
1625 throw new coding_exception('Passed grade without the associated grade item');
1626 }
1627 $item = $grade->grade_item;
1628
1629 if (!$item->is_external_item()) {
1630 // at the moment, only activity modules are supported
1631 return null;
1632 }
1633 if ($item->itemtype !== 'mod') {
1634 throw new coding_exception('Unknown external itemtype: '.$item->itemtype);
1635 }
1636 if (empty($item->iteminstance) or empty($item->itemmodule) or empty($this->modinfo)) {
1637 return null;
1638 }
1639
eff314b0
DM
1640 if (!array_key_exists($item->itemmodule, $hasgradephp)) {
1641 if (file_exists($CFG->dirroot . '/mod/' . $item->itemmodule . '/grade.php')) {
1642 $hasgradephp[$item->itemmodule] = true;
1643 } else {
1644 $hasgradephp[$item->itemmodule] = false;
1645 }
1646 }
1647
1648 if (!$hasgradephp[$item->itemmodule]) {
1649 return null;
1650 }
1651
bb17ac1e
DM
1652 $instances = $this->modinfo->get_instances();
1653 if (empty($instances[$item->itemmodule][$item->iteminstance])) {
1654 return null;
1655 }
1656 $cm = $instances[$item->itemmodule][$item->iteminstance];
1657 if (!$cm->uservisible) {
1658 return null;
1659 }
1660
1661 $url = new moodle_url('/mod/'.$item->itemmodule.'/grade.php', array(
1662 'id' => $cm->id,
1663 'itemid' => $item->id,
1664 'itemnumber' => $item->itemnumber,
1665 'gradeid' => $grade->id,
1666 'userid' => $grade->userid,
1667 ));
1668
1669 return $url;
1670 }
1671
1672 /**
1673 * Returns an action icon leading to the grade analysis page
1674 *
1675 * @param grade_grade $grade
1676 * @return string
1677 */
1678 public function get_grade_analysis_icon(grade_grade $grade) {
1679 global $OUTPUT;
1680
1681 $url = $this->get_grade_analysis_url($grade);
1682 if (is_null($url)) {
1683 return '';
1684 }
1685
c97933ff 1686 return $OUTPUT->action_icon($url, new pix_icon('t/preview',
bb17ac1e
DM
1687 get_string('gradeanalysis', 'core_grades')));
1688 }
1689
6cc3e350 1690 /**
1691 * Returns the grade eid - the grade may not exist yet.
cf72e2dd 1692 *
1693 * @param grade_grade $grade_grade A grade_grade object
1694 *
6cc3e350 1695 * @return string eid
1696 */
d24832f9 1697 public function get_grade_eid($grade_grade) {
6cc3e350 1698 if (empty($grade_grade->id)) {
1699 return 'n'.$grade_grade->itemid.'u'.$grade_grade->userid;
1700 } else {
1701 return 'g'.$grade_grade->id;
1702 }
1703 }
1704
1705 /**
1706 * Returns the grade_item eid
cf72e2dd 1707 * @param grade_item $grade_item A grade_item object
6cc3e350 1708 * @return string eid
1709 */
d24832f9 1710 public function get_item_eid($grade_item) {
ddb9c95f 1711 return 'ig'.$grade_item->id;
6cc3e350 1712 }
1713
cf72e2dd 1714 /**
1715 * Given a grade_tree element, returns an array of parameters
1716 * used to build an icon for that element.
1717 *
1718 * @param array $element An array representing an element in the grade_tree
1719 *
1720 * @return array
1721 */
1722 public function get_params_for_iconstr($element) {
9ecd4386 1723 $strparams = new stdClass();
1724 $strparams->category = '';
1725 $strparams->itemname = '';
1726 $strparams->itemmodule = '';
cf72e2dd 1727
9ecd4386 1728 if (!method_exists($element['object'], 'get_name')) {
1729 return $strparams;
1730 }
345674ca 1731
b285c5aa 1732 $strparams->itemname = html_to_text($element['object']->get_name());
9ecd4386 1733
1734 // If element name is categorytotal, get the name of the parent category
1735 if ($strparams->itemname == get_string('categorytotal', 'grades')) {
1736 $parent = $element['object']->get_parent_category();
1737 $strparams->category = $parent->get_name() . ' ';
1738 } else {
1739 $strparams->category = '';
1740 }
1741
1742 $strparams->itemmodule = null;
1743 if (isset($element['object']->itemmodule)) {
1744 $strparams->itemmodule = $element['object']->itemmodule;
345674ca 1745 }
9ecd4386 1746 return $strparams;
1747 }
1748
ae93f353
FM
1749 /**
1750 * Return a reset icon for the given element.
1751 *
1752 * @param array $element An array representing an element in the grade_tree
1753 * @param object $gpr A grade_plugin_return object
079b2e52
MG
1754 * @param bool $returnactionmenulink return the instance of action_menu_link instead of string
1755 * @return string|action_menu_link
ae93f353 1756 */
079b2e52 1757 public function get_reset_icon($element, $gpr, $returnactionmenulink = false) {
ae93f353
FM
1758 global $CFG, $OUTPUT;
1759
1760 // Limit to category items set to use the natural weights aggregation method, and users
1761 // with the capability to manage grades.
1762 if ($element['type'] != 'category' || $element['object']->aggregation != GRADE_AGGREGATE_SUM ||
1763 !has_capability('moodle/grade:manage', $this->context)) {
079b2e52 1764 return $returnactionmenulink ? null : '';
ae93f353
FM
1765 }
1766
1767 $str = get_string('resetweights', 'grades', $this->get_params_for_iconstr($element));
1768 $url = new moodle_url('/grade/edit/tree/action.php', array(
1769 'id' => $this->courseid,
1770 'action' => 'resetweights',
1771 'eid' => $element['eid'],
1772 'sesskey' => sesskey(),
1773 ));
1774
079b2e52
MG
1775 if ($returnactionmenulink) {
1776 return new action_menu_link_secondary($gpr->add_url_params($url), new pix_icon('t/reset', $str),
1777 get_string('resetweightsshort', 'grades'));
1778 } else {
1779 return $OUTPUT->action_icon($gpr->add_url_params($url), new pix_icon('t/reset', $str));
1780 }
ae93f353
FM
1781 }
1782
6cc3e350 1783 /**
1784 * Return edit icon for give element
cf72e2dd 1785 *
1786 * @param array $element An array representing an element in the grade_tree
1787 * @param object $gpr A grade_plugin_return object
079b2e52
MG
1788 * @param bool $returnactionmenulink return the instance of action_menu_link instead of string
1789 * @return string|action_menu_link
6cc3e350 1790 */
079b2e52 1791 public function get_edit_icon($element, $gpr, $returnactionmenulink = false) {
6b608f8f 1792 global $CFG, $OUTPUT;
6cc3e350 1793
1794 if (!has_capability('moodle/grade:manage', $this->context)) {
1795 if ($element['type'] == 'grade' and has_capability('moodle/grade:edit', $this->context)) {
1796 // oki - let them override grade
1797 } else {
079b2e52 1798 return $returnactionmenulink ? null : '';
6cc3e350 1799 }
1800 }
1801
05aba805 1802 static $strfeedback = null;
1803 static $streditgrade = null;
1804 if (is_null($streditgrade)) {
1805 $streditgrade = get_string('editgrade', 'grades');
1806 $strfeedback = get_string('feedback');
6cc3e350 1807 }
1808
9ecd4386 1809 $strparams = $this->get_params_for_iconstr($element);
6ef4878b 1810
6cc3e350 1811 $object = $element['object'];
6cc3e350 1812
1813 switch ($element['type']) {
1814 case 'item':
1815 case 'categoryitem':
1816 case 'courseitem':
9ecd4386 1817 $stredit = get_string('editverbose', 'grades', $strparams);
6cc3e350 1818 if (empty($object->outcomeid) || empty($CFG->enableoutcomes)) {
a6855934 1819 $url = new moodle_url('/grade/edit/tree/item.php',
1c1f64a2 1820 array('courseid' => $this->courseid, 'id' => $object->id));
6cc3e350 1821 } else {
a6855934 1822 $url = new moodle_url('/grade/edit/tree/outcomeitem.php',
1c1f64a2 1823 array('courseid' => $this->courseid, 'id' => $object->id));
6cc3e350 1824 }
6cc3e350 1825 break;
1826
1827 case 'category':
9ecd4386 1828 $stredit = get_string('editverbose', 'grades', $strparams);
a6855934 1829 $url = new moodle_url('/grade/edit/tree/category.php',
1c1f64a2 1830 array('courseid' => $this->courseid, 'id' => $object->id));
6cc3e350 1831 break;
1832
1833 case 'grade':
05aba805 1834 $stredit = $streditgrade;
6cc3e350 1835 if (empty($object->id)) {
a6855934 1836 $url = new moodle_url('/grade/edit/tree/grade.php',
1c1f64a2 1837 array('courseid' => $this->courseid, 'itemid' => $object->itemid, 'userid' => $object->userid));
6cc3e350 1838 } else {
a6855934 1839 $url = new moodle_url('/grade/edit/tree/grade.php',
1c1f64a2 1840 array('courseid' => $this->courseid, 'id' => $object->id));
6cc3e350 1841 }
6cc3e350 1842 if (!empty($object->feedback)) {
1843 $feedback = addslashes_js(trim(format_string($object->feedback, $object->feedbackformat)));
6cc3e350 1844 }
1845 break;
1846
1847 default:
1848 $url = null;
1849 }
1850
1851 if ($url) {
079b2e52
MG
1852 if ($returnactionmenulink) {
1853 return new action_menu_link_secondary($gpr->add_url_params($url),
1854 new pix_icon('t/edit', $stredit),
1855 get_string('editsettings'));
1856 } else {
1857 return $OUTPUT->action_icon($gpr->add_url_params($url), new pix_icon('t/edit', $stredit));
1858 }
6cc3e350 1859
1860 } else {
079b2e52 1861 return $returnactionmenulink ? null : '';
6cc3e350 1862 }
1863 }
1864
1865 /**
1866 * Return hiding icon for give element
cf72e2dd 1867 *
1868 * @param array $element An array representing an element in the grade_tree
1869 * @param object $gpr A grade_plugin_return object
079b2e52
MG
1870 * @param bool $returnactionmenulink return the instance of action_menu_link instead of string
1871 * @return string|action_menu_link
6cc3e350 1872 */
079b2e52 1873 public function get_hiding_icon($element, $gpr, $returnactionmenulink = false) {
5d3b9994 1874 global $CFG, $OUTPUT;
6cc3e350 1875
39873128 1876 if (!$element['object']->can_control_visibility()) {
079b2e52 1877 return $returnactionmenulink ? null : '';
39873128
TH
1878 }
1879
cf72e2dd 1880 if (!has_capability('moodle/grade:manage', $this->context) and
1881 !has_capability('moodle/grade:hide', $this->context)) {
079b2e52 1882 return $returnactionmenulink ? null : '';
6cc3e350 1883 }
1884
345674ca 1885 $strparams = $this->get_params_for_iconstr($element);
9ecd4386 1886 $strshow = get_string('showverbose', 'grades', $strparams);
345674ca 1887 $strhide = get_string('hideverbose', 'grades', $strparams);
6cc3e350 1888
a6855934 1889 $url = new moodle_url('/grade/edit/tree/action.php', array('id' => $this->courseid, 'sesskey' => sesskey(), 'eid' => $element['eid']));
8ae8bf8a 1890 $url = $gpr->add_url_params($url);
1c1f64a2 1891
6cc3e350 1892 if ($element['object']->is_hidden()) {
8ae8bf8a 1893 $type = 'show';
6cc3e350 1894 $tooltip = $strshow;
1895
cf72e2dd 1896 // Change the icon and add a tooltip showing the date
1897 if ($element['type'] != 'category' and $element['object']->get_hidden() > 1) {
8ae8bf8a 1898 $type = 'hiddenuntil';
cf72e2dd 1899 $tooltip = get_string('hiddenuntildate', 'grades',
1900 userdate($element['object']->get_hidden()));
6cc3e350 1901 }
1902
8ae8bf8a 1903 $url->param('action', 'show');
b9cc756e 1904
079b2e52
MG
1905 if ($returnactionmenulink) {
1906 $hideicon = new action_menu_link_secondary($url, new pix_icon('t/'.$type, $tooltip), get_string('show'));
1907 } else {
1908 $hideicon = $OUTPUT->action_icon($url, new pix_icon('t/'.$type, $tooltip, 'moodle', array('alt'=>$strshow, 'class'=>'smallicon')));
1909 }
6cc3e350 1910
1911 } else {
8ae8bf8a 1912 $url->param('action', 'hide');
079b2e52
MG
1913 if ($returnactionmenulink) {
1914 $hideicon = new action_menu_link_secondary($url, new pix_icon('t/hide', $strhide), get_string('hide'));
1915 } else {
1916 $hideicon = $OUTPUT->action_icon($url, new pix_icon('t/hide', $strhide));
1917 }
6cc3e350 1918 }
1c1f64a2 1919
8ae8bf8a 1920 return $hideicon;
6cc3e350 1921 }
1922
1923 /**
2673c733 1924 * Return locking icon for given element
cf72e2dd 1925 *
1926 * @param array $element An array representing an element in the grade_tree
1927 * @param object $gpr A grade_plugin_return object
1928 *
6cc3e350 1929 * @return string
1930 */
d24832f9 1931 public function get_locking_icon($element, $gpr) {
6b608f8f 1932 global $CFG, $OUTPUT;
6cc3e350 1933
345674ca 1934 $strparams = $this->get_params_for_iconstr($element);
9ecd4386 1935 $strunlock = get_string('unlockverbose', 'grades', $strparams);
1936 $strlock = get_string('lockverbose', 'grades', $strparams);
d24832f9 1937
a6855934 1938 $url = new moodle_url('/grade/edit/tree/action.php', array('id' => $this->courseid, 'sesskey' => sesskey(), 'eid' => $element['eid']));
8ae8bf8a 1939 $url = $gpr->add_url_params($url);
1c1f64a2 1940
2673c733 1941 // Don't allow an unlocking action for a grade whose grade item is locked: just print a state icon
1942 if ($element['type'] == 'grade' && $element['object']->grade_item->is_locked()) {
1943 $strparamobj = new stdClass();
1944 $strparamobj->itemname = $element['object']->grade_item->itemname;
1945 $strnonunlockable = get_string('nonunlockableverbose', 'grades', $strparamobj);
1c1f64a2 1946
0cddd851
FM
1947 $action = html_writer::tag('span', $OUTPUT->pix_icon('t/locked', $strnonunlockable),
1948 array('class' => 'action-icon'));
8ae8bf8a 1949
cf72e2dd 1950 } else if ($element['object']->is_locked()) {
8ae8bf8a 1951 $type = 'unlock';
6cc3e350 1952 $tooltip = $strunlock;
1953
cf72e2dd 1954 // Change the icon and add a tooltip showing the date
1955 if ($element['type'] != 'category' and $element['object']->get_locktime() > 1) {
8ae8bf8a 1956 $type = 'locktime';
cf72e2dd 1957 $tooltip = get_string('locktimedate', 'grades',
1958 userdate($element['object']->get_locktime()));
6cc3e350 1959 }
1960
8ae8bf8a
PS
1961 if (!has_capability('moodle/grade:manage', $this->context) and !has_capability('moodle/grade:unlock', $this->context)) {
1962 $action = '';
1963 } else {
1964 $url->param('action', 'unlock');
c63923bd 1965 $action = $OUTPUT->action_icon($url, new pix_icon('t/'.$type, $tooltip, 'moodle', array('alt'=>$strunlock, 'class'=>'smallicon')));
6cc3e350 1966 }
6cc3e350 1967
1968 } else {
8ae8bf8a
PS
1969 if (!has_capability('moodle/grade:manage', $this->context) and !has_capability('moodle/grade:lock', $this->context)) {
1970 $action = '';
1971 } else {
1972 $url->param('action', 'lock');
c63923bd 1973 $action = $OUTPUT->action_icon($url, new pix_icon('t/lock', $strlock));
6cc3e350 1974 }
6cc3e350 1975 }
8ae8bf8a 1976
6cc3e350 1977 return $action;
1978 }
1979
1980 /**
1981 * Return calculation icon for given element
cf72e2dd 1982 *
1983 * @param array $element An array representing an element in the grade_tree
1984 * @param object $gpr A grade_plugin_return object
079b2e52
MG
1985 * @param bool $returnactionmenulink return the instance of action_menu_link instead of string
1986 * @return string|action_menu_link
6cc3e350 1987 */
079b2e52 1988 public function get_calculation_icon($element, $gpr, $returnactionmenulink = false) {
666e8458 1989 global $CFG, $OUTPUT;
6cc3e350 1990 if (!has_capability('moodle/grade:manage', $this->context)) {
079b2e52 1991 return $returnactionmenulink ? null : '';
6cc3e350 1992 }
1993
6cc3e350 1994 $type = $element['type'];
1995 $object = $element['object'];
1996
1997 if ($type == 'item' or $type == 'courseitem' or $type == 'categoryitem') {
345674ca 1998 $strparams = $this->get_params_for_iconstr($element);
9ecd4386 1999 $streditcalculation = get_string('editcalculationverbose', 'grades', $strparams);
6cc3e350 2000
cf72e2dd 2001 $is_scale = $object->gradetype == GRADE_TYPE_SCALE;
2002 $is_value = $object->gradetype == GRADE_TYPE_VALUE;
2003
6cc3e350 2004 // show calculation icon only when calculation possible
cf72e2dd 2005 if (!$object->is_external_item() and ($is_scale or $is_value)) {
6cc3e350 2006 if ($object->is_calculated()) {
666e8458 2007 $icon = 't/calc';
6cc3e350 2008 } else {
666e8458 2009 $icon = 't/calc_off';
6cc3e350 2010 }
cf72e2dd 2011
a6855934 2012 $url = new moodle_url('/grade/edit/tree/calculation.php', array('courseid' => $this->courseid, 'id' => $object->id));
8ae8bf8a 2013 $url = $gpr->add_url_params($url);
079b2e52
MG
2014 if ($returnactionmenulink) {
2015 return new action_menu_link_secondary($url,
2016 new pix_icon($icon, $streditcalculation),
2017 get_string('editcalculation', 'grades'));
2018 } else {
2019 return $OUTPUT->action_icon($url, new pix_icon($icon, $streditcalculation));
2020 }
6cc3e350 2021 }
2022 }
2023
079b2e52 2024 return $returnactionmenulink ? null : '';
6cc3e350 2025 }
2026}
2027
2028/**
2029 * Flat structure similar to grade tree.
cf72e2dd 2030 *
2031 * @uses grade_structure
a153c9f2 2032 * @package core_grades
cf72e2dd 2033 * @copyright 2009 Nicolas Connault
2034 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
6cc3e350 2035 */
2036class grade_seq extends grade_structure {
2037
6cc3e350 2038 /**
2039 * 1D array of elements
2040 */
d24832f9 2041 public $elements;
e98871a2 2042
2043 /**
2044 * Constructor, retrieves and stores array of all grade_category and grade_item
2045 * objects for the given courseid. Full objects are instantiated. Ordering sequence is fixed if needed.
cf72e2dd 2046 *
2047 * @param int $courseid The course id
2048 * @param bool $category_grade_last category grade item is the last child
2049 * @param bool $nooutcomes Whether or not outcomes should be included
e98871a2 2050 */
c4d0b752 2051 public function __construct($courseid, $category_grade_last=false, $nooutcomes=false) {
e98871a2 2052 global $USER, $CFG;
2053
2054 $this->courseid = $courseid;
d4060472 2055 $this->context = context_course::instance($courseid);
e98871a2 2056
2057 // get course grade tree
2058 $top_element = grade_category::fetch_course_tree($courseid, true);
2059
6391ebe7 2060 $this->elements = grade_seq::flatten($top_element, $category_grade_last, $nooutcomes);
2061
2062 foreach ($this->elements as $key=>$unused) {
b89a70ce 2063 $this->items[$this->elements[$key]['object']->id] =& $this->elements[$key]['object'];
6391ebe7 2064 }
e98871a2 2065 }
2066
9e313e79
DM
2067 /**
2068 * Old syntax of class constructor. Deprecated in PHP7.
2069 *
2070 * @deprecated since Moodle 3.1
2071 */
2072 public function grade_seq($courseid, $category_grade_last=false, $nooutcomes=false) {
2073 debugging('Use of class name as constructor is deprecated', DEBUG_DEVELOPER);
2074 self::__construct($courseid, $category_grade_last, $nooutcomes);
2075 }
2076
e98871a2 2077 /**
2078 * Static recursive helper - makes the grade_item for category the last children
cf72e2dd 2079 *
2080 * @param array &$element The seed of the recursion
2081 * @param bool $category_grade_last category grade item is the last child
2082 * @param bool $nooutcomes Whether or not outcomes should be included
2083 *
2084 * @return array
e98871a2 2085 */
d24832f9 2086 public function flatten(&$element, $category_grade_last, $nooutcomes) {
e98871a2 2087 if (empty($element['children'])) {
2088 return array();
2089 }
2090 $children = array();
2091
2092 foreach ($element['children'] as $sortorder=>$unused) {
cf72e2dd 2093 if ($nooutcomes and $element['type'] != 'category' and
2094 $element['children'][$sortorder]['object']->is_outcome_item()) {
e98871a2 2095 continue;
2096 }
2097 $children[] = $element['children'][$sortorder];
2098 }
2099 unset($element['children']);
2100
2101 if ($category_grade_last and count($children) > 1) {
2102 $cat_item = array_shift($children);
2103 array_push($children, $cat_item);
2104 }
2105
2106 $result = array();
2107 foreach ($children as $child) {
e0724506 2108 if ($child['type'] == 'category') {
6391ebe7 2109 $result = $result + grade_seq::flatten($child, $category_grade_last, $nooutcomes);
e98871a2 2110 } else {
2111 $child['eid'] = 'i'.$child['object']->id;
6391ebe7 2112 $result[$child['object']->id] = $child;
e98871a2 2113 }
2114 }
2115
2116 return $result;
2117 }
2118
2119 /**
2120 * Parses the array in search of a given eid and returns a element object with
2121 * information about the element it has found.
cf72e2dd 2122 *
2123 * @param int $eid Gradetree Element ID
2124 *
e98871a2 2125 * @return object element
2126 */
d24832f9 2127 public function locate_element($eid) {
e98871a2 2128 // it is a grade - construct a new object
2129 if (strpos($eid, 'n') === 0) {
2130 if (!preg_match('/n(\d+)u(\d+)/', $eid, $matches)) {
2131 return null;
2132 }
2133
2134 $itemid = $matches[1];
2135 $userid = $matches[2];
2136
2137 //extra security check - the grade item must be in this tree
ddb9c95f 2138 if (!$item_el = $this->locate_element('ig'.$itemid)) {
e98871a2 2139 return null;
2140 }
2141
2142 // $gradea->id may be null - means does not exist yet
2143 $grade = new grade_grade(array('itemid'=>$itemid, 'userid'=>$userid));
2144
2145 $grade->grade_item =& $item_el['object']; // this may speedup grade_grade methods!
2146 return array('eid'=>'n'.$itemid.'u'.$userid,'object'=>$grade, 'type'=>'grade');
2147
2148 } else if (strpos($eid, 'g') === 0) {
cf72e2dd 2149 $id = (int) substr($eid, 1);
e98871a2 2150 if (!$grade = grade_grade::fetch(array('id'=>$id))) {
2151 return null;
2152 }
2153 //extra security check - the grade item must be in this tree
ddb9c95f 2154 if (!$item_el = $this->locate_element('ig'.$grade->itemid)) {
e98871a2 2155 return null;
2156 }
2157 $grade->grade_item =& $item_el['object']; // this may speedup grade_grade methods!
2158 return array('eid'=>'g'.$id,'object'=>$grade, 'type'=>'grade');
2159 }
2160
2161 // it is a category or item
6391ebe7 2162 foreach ($this->elements as $element) {
6cc3e350 2163 if ($element['eid'] == $eid) {
2164 return $element;
2165 }
e98871a2 2166 }
6cc3e350 2167
2168 return null;
e98871a2 2169 }
e98871a2 2170}
2171
7a6b7acf 2172/**
2173 * This class represents a complete tree of categories, grade_items and final grades,
2174 * organises as an array primarily, but which can also be converted to other formats.
2175 * It has simple method calls with complex implementations, allowing for easy insertion,
2176 * deletion and moving of items and categories within the tree.
cf72e2dd 2177 *
2178 * @uses grade_structure
a153c9f2 2179 * @package core_grades
cf72e2dd 2180 * @copyright 2009 Nicolas Connault
2181 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
7a6b7acf 2182 */
6cc3e350 2183class grade_tree extends grade_structure {
7a6b7acf 2184
2185 /**
2186 * The basic representation of the tree as a hierarchical, 3-tiered array.
2187 * @var object $top_element
2188 */
d24832f9 2189 public $top_element;
7a6b7acf 2190
7a6b7acf 2191 /**
2192 * 2D array of grade items and categories
cf72e2dd 2193 * @var array $levels
7a6b7acf 2194 */
d24832f9 2195 public $levels;
7a6b7acf 2196
b89a70ce 2197 /**
2198 * Grade items
cf72e2dd 2199 * @var array $items
b89a70ce 2200 */
d24832f9 2201 public $items;
b89a70ce 2202
7a6b7acf 2203 /**
2204 * Constructor, retrieves and stores a hierarchical array of all grade_category and grade_item
e98871a2 2205 * objects for the given courseid. Full objects are instantiated. Ordering sequence is fixed if needed.
cf72e2dd 2206 *
2207 * @param int $courseid The Course ID
2208 * @param bool $fillers include fillers and colspans, make the levels var "rectangular"
2209 * @param bool $category_grade_last category grade item is the last child
4faf5f99 2210 * @param array $collapsed array of collapsed categories
cf72e2dd 2211 * @param bool $nooutcomes Whether or not outcomes should be included
7a6b7acf 2212 */
c4d0b752 2213 public function __construct($courseid, $fillers=true, $category_grade_last=false,
cf72e2dd 2214 $collapsed=null, $nooutcomes=false) {
73ca5f01 2215 global $USER, $CFG, $COURSE, $DB;
7a6b7acf 2216
2217 $this->courseid = $courseid;
7a6b7acf 2218 $this->levels = array();
d4060472 2219 $this->context = context_course::instance($courseid);
7a6b7acf 2220
73ca5f01 2221 if (!empty($COURSE->id) && $COURSE->id == $this->courseid) {
2222 $course = $COURSE;
2223 } else {
2224 $course = $DB->get_record('course', array('id' => $this->courseid));
2225 }
2226 $this->modinfo = get_fast_modinfo($course);
2227
7a6b7acf 2228 // get course grade tree
2229 $this->top_element = grade_category::fetch_course_tree($courseid, true);
2230
4faf5f99 2231 // collapse the categories if requested
2232 if (!empty($collapsed)) {
2233 grade_tree::category_collapse($this->top_element, $collapsed);
2234 }
2235
aea4df41 2236 // no otucomes if requested
2237 if (!empty($nooutcomes)) {
2238 grade_tree::no_outcomes($this->top_element);
2239 }
2240
4faf5f99 2241 // move category item to last position in category
7a6b7acf 2242 if ($category_grade_last) {
2243 grade_tree::category_grade_last($this->top_element);
2244 }
2245
2246 if ($fillers) {
2247 // inject fake categories == fillers
2248 grade_tree::inject_fillers($this->top_element, 0);
2249 // add colspans to categories and fillers
2250 grade_tree::inject_colspans($this->top_element);
2251 }
2252
2253 grade_tree::fill_levels($this->levels, $this->top_element, 0);
d297269d 2254
7a6b7acf 2255 }
2256
9e313e79
DM
2257 /**
2258 * Old syntax of class constructor. Deprecated in PHP7.
2259 *
2260 * @deprecated since Moodle 3.1
2261 */
2262 public function grade_tree($courseid, $fillers=true, $category_grade_last=false,
2263 $collapsed=null, $nooutcomes=false) {
2264 debugging('Use of class name as constructor is deprecated', DEBUG_DEVELOPER);
2265 self::__construct($courseid, $fillers, $category_grade_last, $collapsed, $nooutcomes);
2266 }
2267
4faf5f99 2268 /**
2269 * Static recursive helper - removes items from collapsed categories
cf72e2dd 2270 *
2271 * @param array &$element The seed of the recursion
4faf5f99 2272 * @param array $collapsed array of collapsed categories
cf72e2dd 2273 *
4faf5f99 2274 * @return void
2275 */
d24832f9 2276 public function category_collapse(&$element, $collapsed) {
4faf5f99 2277 if ($element['type'] != 'category') {
2278 return;
2279 }
2280 if (empty($element['children']) or count($element['children']) < 2) {
2281 return;
2282 }
2283
384960dd 2284 if (in_array($element['object']->id, $collapsed['aggregatesonly'])) {
4faf5f99 2285 $category_item = reset($element['children']); //keep only category item
2286 $element['children'] = array(key($element['children'])=>$category_item);
2287
2288 } else {
384960dd 2289 if (in_array($element['object']->id, $collapsed['gradesonly'])) { // Remove category item
2290 reset($element['children']);
2291 $first_key = key($element['children']);
2292 unset($element['children'][$first_key]);
2293 }
2294 foreach ($element['children'] as $sortorder=>$child) { // Recurse through the element's children
4faf5f99 2295 grade_tree::category_collapse($element['children'][$sortorder], $collapsed);
2296 }
2297 }
2298 }
7a6b7acf 2299
aea4df41 2300 /**
2301 * Static recursive helper - removes all outcomes
cf72e2dd 2302 *
2303 * @param array &$element The seed of the recursion
2304 *
aea4df41 2305 * @return void
2306 */
d24832f9 2307 public function no_outcomes(&$element) {
aea4df41 2308 if ($element['type'] != 'category') {
2309 return;
2310 }
2311 foreach ($element['children'] as $sortorder=>$child) {
2312 if ($element['children'][$sortorder]['type'] == 'item'
2313 and $element['children'][$sortorder]['object']->is_outcome_item()) {
2314 unset($element['children'][$sortorder]);
2315
d4795a07 2316 } else if ($element['children'][$sortorder]['type'] == 'category') {
aea4df41 2317 grade_tree::no_outcomes($element['children'][$sortorder]);
2318 }
2319 }
2320 }
2321
7a6b7acf 2322 /**
2323 * Static recursive helper - makes the grade_item for category the last children
cf72e2dd 2324 *
2325 * @param array &$element The seed of the recursion
2326 *
7a6b7acf 2327 * @return void
2328 */
d24832f9 2329 public function category_grade_last(&$element) {
7a6b7acf 2330 if (empty($element['children'])) {
2331 return;
2332 }
2333 if (count($element['children']) < 2) {
2334 return;
2335 }
3e0e2436 2336 $first_item = reset($element['children']);
4a3dfd9a 2337 if ($first_item['type'] == 'categoryitem' or $first_item['type'] == 'courseitem') {
3e0e2436 2338 // the category item might have been already removed
2339 $order = key($element['children']);
2340 unset($element['children'][$order]);
2341 $element['children'][$order] =& $first_item;
2342 }
206f9953 2343 foreach ($element['children'] as $sortorder => $child) {
7a6b7acf 2344 grade_tree::category_grade_last($element['children'][$sortorder]);
2345 }
2346 }
2347
2348 /**
2349 * Static recursive helper - fills the levels array, useful when accessing tree elements of one level
cf72e2dd 2350 *
2351 * @param array &$levels The levels of the grade tree through which to recurse
2352 * @param array &$element The seed of the recursion
2353 * @param int $depth How deep are we?
7a6b7acf 2354 * @return void
2355 */
d24832f9 2356 public function fill_levels(&$levels, &$element, $depth) {
7a6b7acf 2357 if (!array_key_exists($depth, $levels)) {
2358 $levels[$depth] = array();
2359 }
2360
2361 // prepare unique identifier
2362 if ($element['type'] == 'category') {
ddb9c95f 2363 $element['eid'] = 'cg'.$element['object']->id;
7a6b7acf 2364 } else if (in_array($element['type'], array('item', 'courseitem', 'categoryitem'))) {
ddb9c95f 2365 $element['eid'] = 'ig'.$element['object']->id;
b89a70ce 2366 $this->items[$element['object']->id] =& $element['object'];
7a6b7acf 2367 }
2368
2369 $levels[$depth][] =& $element;
2370 $depth++;
2371 if (empty($element['children'])) {
2372 return;
2373 }
2374 $prev = 0;
2375 foreach ($element['children'] as $sortorder=>$child) {
2376 grade_tree::fill_levels($levels, $element['children'][$sortorder], $depth);
2377 $element['children'][$sortorder]['prev'] = $prev;
2378 $element['children'][$sortorder]['next'] = 0;
2379 if ($prev) {
2380 $element['children'][$prev]['next'] = $sortorder;
2381 }
2382 $prev = $sortorder;
2383 }
2384 }
2385
825a3fa9
JP
2386 /**
2387 * Determines whether the grade tree item can be displayed.
2388 * This is particularly targeted for grade categories that have no total (None) when rendering the grade tree.
2389 * It checks if the grade tree item is of type 'category', and makes sure that the category, or at least one of children,
2390 * can be output.
2391 *
2392 * @param array $element The grade category element.
2393 * @return bool True if the grade tree item can be displayed. False, otherwise.
2394 */
2395 public static function can_output_item($element) {
2396 $canoutput = true;
2397
2398 if ($element['type'] === 'category') {
2399 $object = $element['object'];
2400 $category = grade_category::fetch(array('id' => $object->id));
2401 // Category has total, we can output this.
2402 if ($category->get_grade_item()->gradetype != GRADE_TYPE_NONE) {
2403 return true;
2404 }
2405
2406 // Category has no total and has no children, no need to output this.
2407 if (empty($element['children'])) {
2408 return false;
2409 }
2410
2411 $canoutput = false;
2412 // Loop over children and make sure at least one child can be output.
2413 foreach ($element['children'] as $child) {
2414 $canoutput = self::can_output_item($child);
2415 if ($canoutput) {
2416 break;
2417 }
2418 }
2419 }
2420
2421 return $canoutput;
2422 }
2423
7a6b7acf 2424 /**
2425 * Static recursive helper - makes full tree (all leafes are at the same level)
cf72e2dd 2426 *
2427 * @param array &$element The seed of the recursion
2428 * @param int $depth How deep are we?
2429 *
2430 * @return int
7a6b7acf 2431 */
d24832f9 2432 public function inject_fillers(&$element, $depth) {
7a6b7acf 2433 $depth++;
2434
2435 if (empty($element['children'])) {
2436 return $depth;
2437 }
2438 $chdepths = array();
2439 $chids = array_keys($element['children']);
2440 $last_child = end($chids);
2441 $first_child = reset($chids);
2442
2443 foreach ($chids as $chid) {
2444 $chdepths[$chid] = grade_tree::inject_fillers($element['children'][$chid], $depth);
2445 }
2446 arsort($chdepths);
2447
2448 $maxdepth = reset($chdepths);
2449 foreach ($chdepths as $chid=>$chd) {
2450 if ($chd == $maxdepth) {
2451 continue;
2452 }
825a3fa9
JP
2453 if (!self::can_output_item($element['children'][$chid])) {
2454 continue;
2455 }
7a6b7acf 2456 for ($i=0; $i < $maxdepth-$chd; $i++) {
2457 if ($chid == $first_child) {
2458 $type = 'fillerfirst';
2459 } else if ($chid == $last_child) {
2460 $type = 'fillerlast';
2461 } else {
2462 $type = 'filler';
2463 }
2464 $oldchild =& $element['children'][$chid];
cf72e2dd 2465 $element['children'][$chid] = array('object'=>'filler', 'type'=>$type,
2466 'eid'=>'', 'depth'=>$element['object']->depth,
2467 'children'=>array($oldchild));
7a6b7acf 2468 }
2469 }
2470
2471 return $maxdepth;
2472 }
2473
2474 /**
2475 * Static recursive helper - add colspan information into categories
cf72e2dd 2476 *
2477 * @param array &$element The seed of the recursion
2478 *
2479 * @return int
7a6b7acf 2480 */
d24832f9 2481 public function inject_colspans(&$element) {
7a6b7acf 2482 if (empty($element['children'])) {
2483 return 1;
2484 }
2485 $count = 0;
2486 foreach ($element['children'] as $key=>$child) {
825a3fa9
JP
2487 if (!self::can_output_item($child)) {
2488 continue;
2489 }
7a6b7acf 2490 $count += grade_tree::inject_colspans($element['children'][$key]);
2491 }
2492 $element['colspan'] = $count;
2493 return $count;
2494 }
2495
2496 /**
2497 * Parses the array in search of a given eid and returns a element object with
2498 * information about the element it has found.
cf72e2dd 2499 * @param int $eid Gradetree Element ID
7a6b7acf 2500 * @return object element
2501 */
d24832f9 2502 public function locate_element($eid) {
d3c3da1b 2503 // it is a grade - construct a new object
2504 if (strpos($eid, 'n') === 0) {
2505 if (!preg_match('/n(\d+)u(\d+)/', $eid, $matches)) {
2506 return null;
2507 }
2508
2509 $itemid = $matches[1];
2510 $userid = $matches[2];
2511
2512 //extra security check - the grade item must be in this tree
ddb9c95f 2513 if (!$item_el = $this->locate_element('ig'.$itemid)) {
d3c3da1b 2514 return null;
2515 }
2516
2517 // $gradea->id may be null - means does not exist yet
2518 $grade = new grade_grade(array('itemid'=>$itemid, 'userid'=>$userid));
2519
2520 $grade->grade_item =& $item_el['object']; // this may speedup grade_grade methods!
2521 return array('eid'=>'n'.$itemid.'u'.$userid,'object'=>$grade, 'type'=>'grade');
2522
2523 } else if (strpos($eid, 'g') === 0) {
cf72e2dd 2524 $id = (int) substr($eid, 1);
7a6b7acf 2525 if (!$grade = grade_grade::fetch(array('id'=>$id))) {
2526 return null;
2527 }
2528 //extra security check - the grade item must be in this tree
ddb9c95f 2529 if (!$item_el = $this->locate_element('ig'.$grade->itemid)) {
7a6b7acf 2530 return null;
2531 }
2532 $grade->grade_item =& $item_el['object']; // this may speedup grade_grade methods!
2533 return array('eid'=>'g'.$id,'object'=>$grade, 'type'=>'grade');
2534 }
2535
2536 // it is a category or item
2537 foreach ($this->levels as $row) {
2538 foreach ($row as $element) {
2539 if ($element['type'] == 'filler') {
2540 continue;
2541 }
2542 if ($element['eid'] == $eid) {
2543 return $element;
2544 }
2545 }
2546 }
2547
2548 return null;
2549 }
d24832f9 2550
b244b9b7 2551 /**
2552 * Returns a well-formed XML representation of the grade-tree using recursion.
cf72e2dd 2553 *
2554 * @param array $root The current element in the recursion. If null, starts at the top of the tree.
2555 * @param string $tabs The control character to use for tabs
2556 *
b244b9b7 2557 * @return string $xml
2558 */
cf72e2dd 2559 public function exporttoxml($root=null, $tabs="\t") {
b244b9b7 2560 $xml = null;
2561 $first = false;
2562 if (is_null($root)) {
2563 $root = $this->top_element;
2564 $xml = '<?xml version="1.0" encoding="UTF-8" ?>' . "\n";
2565 $xml .= "<gradetree>\n";
2566 $first = true;
2567 }
d24832f9 2568
b244b9b7 2569 $type = 'undefined';
2570 if (strpos($root['object']->table, 'grade_categories') !== false) {
2571 $type = 'category';
cf72e2dd 2572 } else if (strpos($root['object']->table, 'grade_items') !== false) {
b244b9b7 2573 $type = 'item';
cf72e2dd 2574 } else if (strpos($root['object']->table, 'grade_outcomes') !== false) {
b244b9b7 2575 $type = 'outcome';
2576 }
d24832f9 2577
b244b9b7 2578 $xml .= "$tabs<element type=\"$type\">\n";
2579 foreach ($root['object'] as $var => $value) {
2580 if (!is_object($value) && !is_array($value) && !empty($value)) {
2581 $xml .= "$tabs\t<$var>$value</$var>\n";
2582 }
2583 }
2584
2585 if (!empty($root['children'])) {
2586 $xml .= "$tabs\t<children>\n";
2587 foreach ($root['children'] as $sortorder => $child) {
2588 $xml .= $this->exportToXML($child, $tabs."\t\t");
2589 }
2590 $xml .= "$tabs\t</children>\n";
2591 }
d24832f9 2592
b244b9b7 2593 $xml .= "$tabs</element>\n";
2594
2595 if ($first) {
2596 $xml .= "</gradetree>";
2597 }
d24832f9 2598
b244b9b7 2599 return $xml;
2600 }
d24832f9 2601
b244b9b7 2602 /**
2603 * Returns a JSON representation of the grade-tree using recursion.
cf72e2dd 2604 *
b244b9b7 2605 * @param array $root The current element in the recursion. If null, starts at the top of the tree.
2606 * @param string $tabs Tab characters used to indent the string nicely for humans to enjoy
cf72e2dd 2607 *
2608 * @return string
b244b9b7 2609 */
cf72e2dd 2610 public function exporttojson($root=null, $tabs="\t") {
b244b9b7 2611 $json = null;
2612 $first = false;
2613 if (is_null($root)) {
2614 $root = $this->top_element;
2615 $first = true;
2616 }
d24832f9 2617
b244b9b7 2618 $name = '';
2619
2620
2621 if (strpos($root['object']->table, 'grade_categories') !== false) {
2622 $name = $root['object']->fullname;
2623 if ($name == '?') {
d24832f9 2624 $name = $root['object']->get_name();
b244b9b7 2625 }
cf72e2dd 2626 } else if (strpos($root['object']->table, 'grade_items') !== false) {
b244b9b7 2627 $name = $root['object']->itemname;
cf72e2dd 2628 } else if (strpos($root['object']->table, 'grade_outcomes') !== false) {
b244b9b7 2629 $name = $root['object']->itemname;
2630 }
d24832f9 2631
b244b9b7 2632 $json .= "$tabs {\n";
2633 $json .= "$tabs\t \"type\": \"{$root['type']}\",\n";
2634 $json .= "$tabs\t \"name\": \"$name\",\n";
2635
2636 foreach ($root['object'] as $var => $value) {
2637 if (!is_object($value) && !is_array($value) && !empty($value)) {
2638 $json .= "$tabs\t \"$var\": \"$value\",\n";
2639 }
2640 }
d24832f9 2641
b244b9b7 2642 $json = substr($json, 0, strrpos($json, ','));
d24832f9 2643
b244b9b7 2644 if (!empty($root['children'])) {
2645 $json .= ",\n$tabs\t\"children\": [\n";
2646 foreach ($root['children'] as $sortorder => $child) {
2647 $json .= $this->exportToJSON($child, $tabs."\t\t");
2648 }
2649 $json = substr($json, 0, strrpos($json, ','));
2650 $json .= "\n$tabs\t]\n";
d24832f9 2651 }
b244b9b7 2652
2653 if ($first) {
2654 $json .= "\n}";
2655 } else {
2656 $json .= "\n$tabs},\n";
2657 }
d24832f9 2658
b244b9b7 2659 return $json;
2660 }
d24832f9 2661
cf72e2dd 2662 /**
2663 * Returns the array of levels
2664 *
2665 * @return array
2666 */
d24832f9 2667 public function get_levels() {
2668 return $this->levels;
2669 }
2670
cf72e2dd 2671 /**
2672 * Returns the array of grade items
2673 *
2674 * @return array
2675 */
d24832f9 2676 public function get_items() {
2677 return $this->items;
2678 }
2679
cf72e2dd 2680 /**
2681 * Returns a specific Grade Item
2682 *
2683 * @param int $itemid The ID of the grade_item object
2684 *
2685 * @return grade_item
2686 */
d24832f9 2687 public function get_item($itemid) {
2688 if (array_key_exists($itemid, $this->items)) {
2689 return $this->items[$itemid];
2690 } else {
2691 return false;
2692 }
2693 }
7a6b7acf 2694}
eef00ade 2695
2696/**
2697 * Local shortcut function for creating an edit/delete button for a grade_* object.
4d27bc79 2698 * @param string $type 'edit' or 'delete'
eef00ade 2699 * @param int $courseid The Course ID
2700 * @param grade_* $object The grade_* object
2701 * @return string html
2702 */
2703function grade_button($type, $courseid, $object) {
2704 global $CFG, $OUTPUT;
2705 if (preg_match('/grade_(.*)/', get_class($object), $matches)) {
2706 $objectidstring = $matches[1] . 'id';
2707 } else {
2708 throw new coding_exception('grade_button() only accepts grade_* objects as third parameter!');
2709 }
2710
2711 $strdelete = get_string('delete');
2712 $stredit = get_string('edit');
2713
eef00ade 2714 if ($type == 'delete') {
8ae8bf8a 2715 $url = new moodle_url('index.php', array('id' => $courseid, $objectidstring => $object->id, 'action' => 'delete', 'sesskey' => sesskey()));
eef00ade 2716 } else if ($type == 'edit') {
8ae8bf8a 2717 $url = new moodle_url('edit.php', array('courseid' => $courseid, 'id' => $object->id));
eef00ade 2718 }
2719
fa9c0aab 2720 return $OUTPUT->action_icon($url, new pix_icon('t/'.$type, ${'str'.$type}, '', array('class' => 'iconsmall')));
eef00ade 2721
2722}
4d5059d4
SH
2723
2724/**
2725 * This method adds settings to the settings block for the grade system and its
2726 * plugins
2727 *
2728 * @global moodle_page $PAGE
2729 */
2730function grade_extend_settings($plugininfo, $courseid) {
2731 global $PAGE;
2732
2733 $gradenode = $PAGE->settingsnav->prepend(get_string('gradeadministration', 'grades'), null, navigation_node::TYPE_CONTAINER);
2734
2735 $strings = array_shift($plugininfo);
2736
2737 if ($reports = grade_helper::get_plugins_reports($courseid)) {
2738 foreach ($reports as $report) {
2739 $gradenode->add($report->string, $report->link, navigation_node::TYPE_SETTING, null, $report->id, new pix_icon('i/report', ''));
2740 }
2741 }
2742
eb84b779
MG
2743 if ($settings = grade_helper::get_info_manage_settings($courseid)) {
2744 $settingsnode = $gradenode->add($strings['settings'], null, navigation_node::TYPE_CONTAINER);
2745 foreach ($settings as $setting) {
2746 $settingsnode->add($setting->string, $setting->link, navigation_node::TYPE_SETTING, null, $setting->id, new pix_icon('i/settings', ''));
2747 }
2748 }
2749
4d5059d4
SH
2750 if ($imports = grade_helper::get_plugins_import($courseid)) {
2751 $importnode = $gradenode->add($strings['import'], null, navigation_node::TYPE_CONTAINER);
2752 foreach ($imports as $import) {
11f87187 2753 $importnode->add($import->string, $import->link, navigation_node::TYPE_SETTING, null, $import->id, new pix_icon('i/import', ''));
4d5059d4
SH
2754 }
2755 }
2756
2757 if ($exports = grade_helper::get_plugins_export($courseid)) {
2758 $exportnode = $gradenode->add($strings['export'], null, navigation_node::TYPE_CONTAINER);
2759 foreach ($exports as $export) {
11f87187 2760 $exportnode->add($export->string, $export->link, navigation_node::TYPE_SETTING, null, $export->id, new pix_icon('i/export', ''));
4d5059d4
SH
2761 }
2762 }
2763
4d5059d4
SH
2764 if ($letters = grade_helper::get_info_letters($courseid)) {
2765 $letters = array_shift($letters);
2766 $gradenode->add($strings['letter'], $letters->link, navigation_node::TYPE_SETTING, null, $letters->id, new pix_icon('i/settings', ''));
2767 }
2768
2769 if ($outcomes = grade_helper::get_info_outcomes($courseid)) {
2770 $outcomes = array_shift($outcomes);
2771 $gradenode->add($strings['outcome'], $outcomes->link, navigation_node::TYPE_SETTING, null, $outcomes->id, new pix_icon('i/outcomes', ''));
2772 }
2773
2774 if ($scales = grade_helper::get_info_scales($courseid)) {
2775 $gradenode->add($strings['scale'], $scales->link, navigation_node::TYPE_SETTING, null, $scales->id, new pix_icon('i/scales', ''));
2776 }
2777
4d5059d4
SH
2778 if ($gradenode->contains_active_node()) {
2779 // If the gradenode is active include the settings base node (gradeadministration) in
2780 // the navbar, typcially this is ignored.
2781 $PAGE->navbar->includesettingsbase = true;
2782
2783 // If we can get the course admin node make sure it is closed by default
2784 // as in this case the gradenode will be opened
2785 if ($coursenode = $PAGE->settingsnav->get('courseadmin', navigation_node::TYPE_COURSE)){
2786 $coursenode->make_inactive();
2787 $coursenode->forceopen = false;
2788 }
2789 }
2790}
2791
2792/**
2793 * Grade helper class
2794 *
2795 * This class provides several helpful functions that work irrespective of any
2796 * current state.
2797 *
2798 * @copyright 2010 Sam Hemelryk
2799 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2800 */
2801abstract class grade_helper {
2802 /**
2803 * Cached manage settings info {@see get_info_settings}
2804 * @var grade_plugin_info|false
2805 */
2806 protected static $managesetting = null;
2807 /**
2808 * Cached grade report plugins {@see get_plugins_reports}
2809 * @var array|false
2810 */
2811 protected static $gradereports = null;
2812 /**
2813 * Cached grade report plugins preferences {@see get_info_scales}
2814 * @var array|false
2815 */
2816 protected static $gradereportpreferences = null;
2817 /**
2818 * Cached scale info {@see get_info_scales}
2819 * @var grade_plugin_info|false
2820 */
2821 protected static $scaleinfo = null;
2822 /**
2823 * Cached outcome info {@see get_info_outcomes}
2824 * @var grade_plugin_info|false
2825 */
2826 protected static $outcomeinfo = null;
4d5059d4
SH
2827 /**
2828 * Cached leftter info {@see get_info_letters}
2829 * @var grade_plugin_info|false
2830 */
2831 protected static $letterinfo = null;
2832 /**
2833 * Cached grade import plugins {@see get_plugins_import}
2834 * @var array|false
2835 */
2836 protected static $importplugins = null;
2837 /**
2838 * Cached grade export plugins {@see get_plugins_export}
2839 * @var array|false
2840 */
2841 protected static $exportplugins = null;
2842 /**
2843 * Cached grade plugin strings
2844 * @var array
2845 */
2846 protected static $pluginstrings = null;
bfe969e8
DW
2847 /**
2848 * Cached grade aggregation strings
2849 * @var array
2850 */
2851 protected static $aggregationstrings = null;
4d5059d4
SH
2852
2853 /**
2854 * Gets strings commonly used by the describe plugins
2855 *
2856 * report => get_string('view'),
4d5059d4
SH
2857 * scale => get_string('scales'),
2858 * outcome => get_string('outcomes', 'grades'),
2859 * letter => get_string('letters', 'grades'),
2860 * export => get_string('export', 'grades'),
2861 * import => get_string('import'),
4d5059d4
SH
2862 * settings => get_string('settings')
2863 *
2864 * @return array
2865 */
2866 public static function get_plugin_strings() {
2867 if (self::$pluginstrings === null) {
2868 self::$pluginstrings = array(
2869 'report' => get_string('view'),
4d5059d4
SH
2870 'scale' => get_string('scales'),
2871 'outcome' => get_string('outcomes', 'grades'),
2872 'letter' => get_string('letters', 'grades'),
2873 'export' => get_string('export', 'grades'),
2874 'import' => get_string('import'),
eb84b779 2875 'settings' => get_string('edittree', 'grades')
4d5059d4
SH
2876 );
2877 }
2878 return self::$pluginstrings;
2879 }
bfe969e8
DW
2880
2881 /**
2882 * Gets strings describing the available aggregation methods.
2883 *
2884 * @return array
2885 */
2886 public static function get_aggregation_strings() {
2887 if (self::$aggregationstrings === null) {
2888 self::$aggregationstrings = array(
2889 GRADE_AGGREGATE_MEAN => get_string('aggregatemean', 'grades'),
2890 GRADE_AGGREGATE_WEIGHTED_MEAN => get_string('aggregateweightedmean', 'grades'),
2891 GRADE_AGGREGATE_WEIGHTED_MEAN2 => get_string('aggregateweightedmean2', 'grades'),
2892 GRADE_AGGREGATE_EXTRACREDIT_MEAN => get_string('aggregateextracreditmean', 'grades'),
2893 GRADE_AGGREGATE_MEDIAN => get_string('aggregatemedian', 'grades'),
2894 GRADE_AGGREGATE_MIN => get_string('aggregatemin', 'grades'),
2895 GRADE_AGGREGATE_MAX => get_string('aggregatemax', 'grades'),
2896 GRADE_AGGREGATE_MODE => get_string('aggregatemode', 'grades'),
2897 GRADE_AGGREGATE_SUM => get_string('aggregatesum', 'grades')
2898 );
2899 }
2900 return self::$aggregationstrings;
2901 }
2902
4d5059d4
SH
2903 /**
2904 * Get grade_plugin_info object for managing settings if the user can
2905 *
2906 * @param int $courseid
8faa560c 2907 * @return grade_plugin_info[]
4d5059d4
SH
2908 */
2909 public static function get_info_manage_settings($courseid) {
2910 if (self::$managesetting !== null) {
2911 return self::$managesetting;
2912 }
d4060472 2913 $context = context_course::instance($courseid);
8faa560c
MG
2914 self::$managesetting = array();
2915 if ($courseid != SITEID && has_capability('moodle/grade:manage', $context)) {
53914e44 2916 self::$managesetting['gradebooksetup'] = new grade_plugin_info('setup',
eb84b779 2917 new moodle_url('/grade/edit/tree/index.php', array('id' => $courseid)),
53914e44 2918 get_string('gradebooksetup', 'grades'));
8faa560c
MG
2919 self::$managesetting['coursesettings'] = new grade_plugin_info('coursesettings',
2920 new moodle_url('/grade/edit/settings/index.php', array('id'=>$courseid)),
2921 get_string('coursegradesettings', 'grades'));
eb84b779
MG
2922 }
2923 if (self::$gradereportpreferences === null) {
2924 self::get_plugins_reports($courseid);
2925 }
2926 if (self::$gradereportpreferences) {
2927 self::$managesetting = array_merge(self::$managesetting, self::$gradereportpreferences);
4d5059d4
SH
2928 }
2929 return self::$managesetting;
2930 }
2931 /**
2932 * Returns an array of plugin reports as grade_plugin_info objects
2933 *
2934 * @param int $courseid
2935 * @return array
2936 */
2937 public static function get_plugins_reports($courseid) {
f7fcf4cd 2938 global $SITE;
cf717dc2 2939
4d5059d4
SH
2940 if (self::$gradereports !== null) {
2941 return self::$gradereports;
2942 }
d4060472 2943 $context = context_course::instance($courseid);
4d5059d4
SH
2944 $gradereports = array();
2945 $gradepreferences = array();
bd3b3bba 2946 foreach (core_component::get_plugin_list('gradereport') as $plugin => $plugindir) {
f7fcf4cd
AD
2947 //some reports make no sense if we're not within a course
2948 if ($courseid==$SITE->id && ($plugin=='grader' || $plugin=='user')) {
2949 continue;
2950 }
2951
4d5059d4
SH
2952 // Remove ones we can't see
2953 if (!has_capability('gradereport/'.$plugin.':view', $context)) {
2954 continue;
2955 }
2956
4ae71e93
DP
2957 // Singleview doesn't doesn't accomodate for all cap combos yet, so this is hardcoded..
2958 if ($plugin === 'singleview' && !has_all_capabilities(array('moodle/grade:viewall',
2959 'moodle/grade:edit'), $context)) {
2960 continue;
2961 }
2962
b5e7b2bf 2963 $pluginstr = get_string('pluginname', 'gradereport_'.$plugin);
4d5059d4
SH
2964 $url = new moodle_url('/grade/report/'.$plugin.'/index.php', array('id'=>$courseid));
2965 $gradereports[$plugin] = new grade_plugin_info($plugin, $url, $pluginstr);
2966
2967 // Add link to preferences tab if such a page exists
2968 if (file_exists($plugindir.'/preferences.php')) {
2969 $url = new moodle_url('/grade/report/'.$plugin.'/preferences.php', array('id'=>$courseid));
eb84b779 2970 $gradepreferences[$plugin] = new grade_plugin_info($plugin, $url,
4887d152 2971 get_string('preferences', 'grades') . ': ' . $pluginstr);
4d5059d4
SH
2972 }
2973 }
2974 if (count($gradereports) == 0) {
2975 $gradereports = false;
2976 $gradepreferences = false;
2977 } else if (count($gradepreferences) == 0) {
2978 $gradepreferences = false;
2979 asort($gradereports);
2980 } else {
2981 asort($gradereports);
2982 asort($gradepreferences);
2983 }
2984 self::$gradereports = $gradereports;
2985 self::$gradereportpreferences = $gradepreferences;
2986 return self::$gradereports;
2987 }
eb84b779 2988
4d5059d4
SH
2989 /**
2990 * Get information on scales
2991 * @param int $courseid
2992 * @return grade_plugin_info
2993 */
2994 public static function get_info_scales($courseid) {
2995 if (self::$scaleinfo !== null) {
2996 return self::$scaleinfo;
2997 }
d4060472 2998 if (has_capability('moodle/course:managescales', context_course::instance($courseid))) {
4d5059d4
SH
2999 $url = new moodle_url('/grade/edit/scale/index.php', array('id'=>$courseid));
3000 self::$scaleinfo = new grade_plugin_info('scale', $url, get_string('view'));
3001 } else {
3002 self::$scaleinfo = false;
3003 }
3004 return self::$scaleinfo;
3005 }
3006 /**
3007 * Get information on outcomes
3008 * @param int $courseid
3009 * @return grade_plugin_info
3010 */
3011 public static function get_info_outcomes($courseid) {
f7fcf4cd 3012 global $CFG, $SITE;
4d5059d4
SH
3013
3014 if (self::$outcomeinfo !== null) {
3015 return self::$outcomeinfo;
3016 }
d4060472 3017 $context = context_course::instance($courseid);
4d5059d4
SH
3018 $canmanage = has_capability('moodle/grade:manage', $context);
3019 $canupdate = has_capability('moodle/course:update', $context);
3020 if (!empty($CFG->enableoutcomes) && ($canmanage || $canupdate)) {
3021 $outcomes = array();
3022 if ($canupdate) {
f7fcf4cd
AD
3023 if ($courseid!=$SITE->id) {
3024 $url = new moodle_url('/grade/edit/outcome/course.php', array('id'=>$courseid));
3025 $outcomes['course'] = new grade_plugin_info('course', $url, get_string('outcomescourse', 'grades'));
3026 }
4d5059d4
SH
3027 $url = new moodle_url('/grade/edit/outcome/index.php', array('id'=>$courseid));
3028 $outcomes['edit'] = new grade_plugin_info('edit', $url, get_string('editoutcomes', 'grades'));
c46aeeab
DC
3029 $url = new moodle_url('/grade/edit/outcome/import.php', array('courseid'=>$courseid));
3030 $outcomes['import'] = new grade_plugin_info('import', $url, get_string('importoutcomes', 'grades'));
4d5059d4 3031 } else {
f7fcf4cd
AD
3032 if ($courseid!=$SITE->id) {
3033 $url = new moodle_url('/grade/edit/outcome/course.php', array('id'=>$courseid));
3034 $outcomes['edit'] = new grade_plugin_info('edit', $url, get_string('outcomescourse', 'grades'));
3035 }
4d5059d4
SH
3036 }
3037 self::$outcomeinfo = $outcomes;
3038 } else {
3039 self::$outcomeinfo = false;
3040 }
3041 return self::$outcomeinfo;
3042 }
4d5059d4
SH
3043 /**
3044 * Get information on letters
3045 * @param int $courseid
4d27bc79 3046 * @return array
4d5059d4
SH
3047 */
3048 public static function get_info_letters($courseid) {
a8dfc483 3049 global $SITE;
4d5059d4
SH
3050 if (self::$letterinfo !== null) {
3051 return self::$letterinfo;
3052 }
d4060472 3053 $context = context_course::instance($courseid);
4d5059d4
SH
3054 $canmanage = has_capability('moodle/grade:manage', $context);
3055 $canmanageletters = has_capability('moodle/grade:manageletters', $context);
3056 if ($canmanage || $canmanageletters) {
a8dfc483
AA
3057 // Redirect to system context when report is accessed from admin settings MDL-31633
3058 if ($context->instanceid == $SITE->id) {
3059 $param = array('edit' => 1);
3060 } else {
3061 $param = array('edit' => 1,'id' => $context->id);
3062 }
4d5059d4 3063 self::$letterinfo = array(
54caa598 3064 'view' => new grade_plugin_info('view', new moodle_url('/grade/edit/letter/index.php', array('id'=>$context->id)), get_string('view')),
a8dfc483 3065 'edit' => new grade_plugin_info('edit', new moodle_url('/grade/edit/letter/index.php', $param), get_string('edit'))
4d5059d4
SH
3066 );
3067 } else {
3068 self::$letterinfo = false;
3069 }
3070 return self::$letterinfo;
3071 }
3072 /**
3073 * Get information import plugins
3074 * @param int $courseid
3075 * @return array
3076 */
3077 public static function get_plugins_import($courseid) {
3078 global $CFG;
3079
3080 if (self::$importplugins !== null) {
3081 return self::$importplugins;
3082 }
3083 $importplugins = array();
d4060472 3084 $context = context_course::instance($courseid);
4d5059d4
SH
3085
3086 if (has_capability('moodle/grade:import', $context)) {
bd3b3bba 3087 foreach (core_component::get_plugin_list('gradeimport') as $plugin => $plugindir) {
4d5059d4
SH
3088 if (!has_capability('gradeimport/'.$plugin.':view', $context)) {
3089 continue;
3090 }
b5e7b2bf 3091 $pluginstr = get_string('pluginname', 'gradeimport_'.$plugin);
4d5059d4
SH
3092 $url = new moodle_url('/grade/import/'.$plugin.'/index.php', array('id'=>$courseid));
3093 $importplugins[$plugin] = new grade_plugin_info($plugin, $url, $pluginstr);
3094 }
3095
ead4d41e
SL
3096 // Show key manager if grade publishing is enabled and the user has xml publishing capability.
3097 // XML is the only grade import plugin that has publishing feature.
3098 if ($CFG->gradepublishing && has_capability('gradeimport/xml:publish', $context)) {
4d5059d4
SH
3099 $url = new moodle_url('/grade/import/keymanager.php', array('id'=>$courseid));
3100 $importplugins['keymanager'] = new grade_plugin_info('keymanager', $url, get_string('keymanager', 'grades'));
3101 }
3102 }
3103
3104 if (count($importplugins) > 0) {
3105 asort($importplugins);
3106 self::$importplugins = $importplugins;
3107 } else {
3108 self::$importplugins = false;
3109 }
3110 return self::$importplugins;
3111 }
3112 /**
3113 * Get information export plugins
3114 * @param int $courseid
3115 * @return array
3116 */
3117 public static function get_plugins_export($courseid) {
3118 global $CFG;
3119
3120 if (self::$exportplugins !== null) {
3121 return self::$exportplugins;
3122 }
d4060472 3123 $context = context_course::instance($courseid);
4d5059d4 3124 $exportplugins = array();
ead4d41e 3125 $canpublishgrades = 0;
4d5059d4 3126 if (has_capability('moodle/grade:export', $context)) {
bd3b3bba 3127 foreach (core_component::get_plugin_list('gradeexport') as $plugin => $plugindir) {
4d5059d4
SH
3128 if (!has_capability('gradeexport/'.$plugin.':view', $context)) {
3129 continue;
3130 }
ead4d41e
SL
3131 // All the grade export plugins has grade publishing capabilities.
3132 if (has_capability('gradeexport/'.$plugin.':publish', $context)) {
3133 $canpublishgrades++;
3134 }
3135
b5e7b2bf 3136 $pluginstr = get_string('pluginname', 'gradeexport_'.$plugin);
4d5059d4
SH
3137 $url = new moodle_url('/grade/export/'.$plugin.'/index.php', array('id'=>$courseid));
3138 $exportplugins[$plugin] = new grade_plugin_info($plugin, $url, $pluginstr);
3139 }
3140
ead4d41e
SL
3141 // Show key manager if grade publishing is enabled and the user has at least one grade publishing capability.
3142 if ($CFG->gradepublishing && $canpublishgrades != 0) {
4d5059d4
SH
3143 $url = new moodle_url('/grade/export/keymanager.php', array('id'=>$courseid));
3144 $exportplugins['keymanager'] = new grade_plugin_info('keymanager', $url, get_string('keymanager', 'grades'));
3145 }
3146 }
3147 if (count($exportplugins) > 0) {
3148 asort($exportplugins);
3149 self::$exportplugins = $exportplugins;
3150 } else {
3151 self::$exportplugins = false;
3152 }
3153 return self::$exportplugins;
3154 }
293f42b6 3155
61c8e0d7
FM
3156 /**
3157 * Returns the value of a field from a user record
3158 *
3159 * @param stdClass $user object
3160 * @param stdClass $field object
3161 * @return string value of the field
3162 */
3163 public static function get_user_field_value($user, $field) {
3164 if (!empty($field->customid)) {
3165 $fieldname = 'customfield_' . $field->shortname;
3166 if (!empty($user->{$fieldname}) || is_numeric($user->{$fieldname})) {
3167 $fieldvalue = $user->{$fieldname};
3168 } else {
3169 $fieldvalue = $field->default;
3170 }
3171 } else {
3172 $fieldvalue = $user->{$field->shortname};
3173 }
3174 return $fieldvalue;
3175 }
3176
3177 /**
3178 * Returns an array of user profile fields to be included in export
3179 *
3180 * @param int $courseid
3181 * @param bool $includecustomfields
3182 * @return array An array of stdClass instances with customid, shortname, datatype, default and fullname fields
3183 */
3184 public static function get_user_profile_fields($courseid, $includecustomfields = false) {
3185 global $CFG, $DB;
3186
3187 // Gets the fields that have to be hidden
3188 $hiddenfields = array_map('trim', explode(',', $CFG->hiddenuserfields));
3189 $context = context_course::instance($courseid);
3190 $canseehiddenfields = has_capability('moodle/course:viewhiddenuserfields', $context);
3191 if ($canseehiddenfields) {
3192 $hiddenfields = array();
3193 }
3194
3195 $fields = array();
3196 require_once($CFG->dirroot.'/user/lib.php'); // Loads user_get_default_fields()
3197 require_once($CFG->dirroot.'/user/profile/lib.php'); // Loads constants, such as PROFILE_VISIBLE_ALL
3198 $userdefaultfields = user_get_default_fields();
3199
3200 // Sets the list of profile fields
3201 $userprofilefields = array_map('trim', explode(',', $CFG->grade_export_userprofilefields));
3202 if (!empty($userprofilefields)) {
3203 foreach ($userprofilefields as $field) {
3204 $field = trim($field);
3205 if (in_array($field, $hiddenfields) || !in_array($field, $userdefaultfields)) {
3206 continue;
3207 }
293f42b6 3208 $obj = new stdClass();
61c8e0d7 3209 $obj->customid = 0;
293f42b6 3210 $obj->shortname = $field;
61c8e0d7 3211 $obj->fullname = get_string($field);
293f42b6
CF
3212 $fields[] = $obj;
3213 }
3214 }
293f42b6 3215
61c8e0d7
FM
3216 // Sets the list of custom profile fields
3217 $customprofilefields = array_map('trim', explode(',', $CFG->grade_export_customprofilefields));
3218 if ($includecustomfields && !empty($customprofilefields)) {
3219 list($wherefields, $whereparams) = $DB->get_in_or_equal($customprofilefields);
3220 $customfields = $DB->get_records_sql("SELECT f.*
3221 FROM {user_info_field} f
3222 JOIN {user_info_category} c ON f.categoryid=c.id
3223 WHERE f.shortname $wherefields
3224 ORDER BY c.sortorder ASC, f.sortorder ASC", $whereparams);
61c8e0d7
FM
3225
3226 foreach ($customfields as $field) {
3227 // Make sure we can display this custom field
3228 if (!in_array($field->shortname, $customprofilefields)) {
3229 continue;
3230 } else if (in_array($field->shortname, $hiddenfields)) {
3231 continue;
3232 } else if ($field->visible != PROFILE_VISIBLE_ALL && !$canseehiddenfields) {
3233 continue;
3234 }
3235
3236 $obj = new stdClass();
3237 $obj->customid = $field->id;
3238 $obj->shortname = $field->shortname;
3239 $obj->fullname = format_string($field->name);
3240 $obj->datatype = $field->datatype;
3241 $obj->default = $field->defaultdata;
3242 $fields[] = $obj;
3243 }
3244 }
3245
3246 return $fields;
3247 }
e61f25a4
DW
3248
3249 /**
3250 * This helper method gets a snapshot of all the weights for a course.
3251 * It is used as a quick method to see if any wieghts have been automatically adjusted.
3252 * @param int $courseid
3253 * @return array of itemid -> aggregationcoef2
3254 */
3255 public static function fetch_all_natural_weights_for_course($courseid) {
3256 global $DB;
3257 $result = array();
3258
3259 $records = $DB->get_records('grade_items', array('courseid'=>$courseid), 'id', 'id, aggregationcoef2');
3260 foreach ($records as $record) {
3261 $result[$record->id] = $record->aggregationcoef2;
3262 }
3263 return $result;
3264 }
293f42b6 3265}
61c8e0d7 3266