MDL-51784 various: use __construct() for PHP7 compatibility
[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
f3df5e14 1005 $returnval = $OUTPUT->header();
1464bcc8 1006
f3df5e14 1007 if (!$return) {
1008 echo $returnval;
1009 }
dc482cfa 1010
1011 // Guess heading if not given explicitly
1012 if (!$heading) {
1013 $heading = $stractive_plugin;
1014 }
1015
2821c495 1016 if ($shownavigation) {
1acbd1f9 1017 $navselector = null;
6bf696bb
MG
1018 if ($courseid != SITEID &&
1019 ($CFG->grade_navmethod == GRADE_NAVMETHOD_COMBO || $CFG->grade_navmethod == GRADE_NAVMETHOD_DROPDOWN)) {
1acbd1f9
AG
1020 // It's absolutely essential that this grade plugin selector is shown after the user header. Just ask Fred.
1021 $navselector = print_grade_plugin_selector($plugin_info, $active_type, $active_plugin, true);
1022 if ($return) {
1023 $returnval .= $navselector;
1024 } else if (!isset($user)) {
1025 echo $navselector;
1026 }
2821c495 1027 }
5625d33d 1028
1464bcc8
AG
1029 $output = '';
1030 // Add a help dialogue box if provided.
1031 if (isset($headerhelpidentifier)) {
1032 $output = $OUTPUT->heading_with_help($heading, $headerhelpidentifier, $headerhelpcomponent);
1033 } else {
1acbd1f9
AG
1034 if (isset($user)) {
1035 $output = $OUTPUT->context_header(
1036 array(
1037 'heading' => fullname($user),
1038 'user' => $user,
1039 'usercontext' => context_user::instance($user->id)
1040 ), 2
1041 ) . $navselector;
1042 } else {
1043 $output = $OUTPUT->heading($heading);
1044 }
1464bcc8
AG
1045 }
1046
5625d33d 1047 if ($return) {
1464bcc8 1048 $returnval .= $output;
5625d33d 1049 } else {
1464bcc8 1050 echo $output;
5625d33d
AD
1051 }
1052
6bf696bb
MG
1053 if ($courseid != SITEID &&
1054 ($CFG->grade_navmethod == GRADE_NAVMETHOD_COMBO || $CFG->grade_navmethod == GRADE_NAVMETHOD_TABS)) {
2821c495
AD
1055 $returnval .= grade_print_tabs($active_type, $active_plugin, $plugin_info, $return);
1056 }
8354e716 1057 }
dc482cfa 1058
eafab799
DW
1059 $returnval .= print_natural_aggregation_upgrade_notice($courseid,
1060 context_course::instance($courseid),
f01972d9 1061 $PAGE->url,
eafab799
DW
1062 $return);
1063
dc482cfa 1064 if ($return) {
1065 return $returnval;
6e2f3121 1066 }
cbff94ba 1067}
1068
0610812a 1069/**
7a6b7acf 1070 * Utility class used for return tracking when using edit and other forms in grade plugins
cf72e2dd 1071 *
a153c9f2 1072 * @package core_grades
cf72e2dd 1073 * @copyright 2009 Nicolas Connault
1074 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
0610812a 1075 */
3af29899 1076class grade_plugin_return {
d24832f9 1077 public $type;
1078 public $plugin;
1079 public $courseid;
1080 public $userid;
1081 public $page;
281ffa4a 1082
0610812a 1083 /**
1084 * Constructor
cf72e2dd 1085 *
0610812a 1086 * @param array $params - associative array with return parameters, if null parameter are taken from _GET or _POST
1087 */
c4d0b752 1088 public function __construct($params = null) {
3af29899 1089 if (empty($params)) {
1090 $this->type = optional_param('gpr_type', null, PARAM_SAFEDIR);
aff24313 1091 $this->plugin = optional_param('gpr_plugin', null, PARAM_PLUGIN);
3af29899 1092 $this->courseid = optional_param('gpr_courseid', null, PARAM_INT);
1093 $this->userid = optional_param('gpr_userid', null, PARAM_INT);
1094 $this->page = optional_param('gpr_page', null, PARAM_INT);
a983b6ec 1095
a983b6ec 1096 } else {
3af29899 1097 foreach ($params as $key=>$value) {
4cc977a6 1098 if (property_exists($this, $key)) {
3af29899 1099 $this->$key = $value;
1100 }
cbff94ba 1101 }
1102 }
6cd8c592 1103 }
1104
0610812a 1105 /**
1106 * Returns return parameters as options array suitable for buttons.
1107 * @return array options
1108 */
d24832f9 1109 public function get_options() {
7a6b7acf 1110 if (empty($this->type)) {
3af29899 1111 return array();
865e9a82 1112 }
6cd8c592 1113
3af29899 1114 $params = array();
6cd8c592 1115
7a6b7acf 1116 if (!empty($this->plugin)) {
1117 $params['plugin'] = $this->plugin;
1118 }
6cd8c592 1119
3af29899 1120 if (!empty($this->courseid)) {
1121 $params['id'] = $this->courseid;
6cd8c592 1122 }
9c61ba4d 1123
3af29899 1124 if (!empty($this->userid)) {
1125 $params['userid'] = $this->userid;
9c61ba4d 1126 }
9c61ba4d 1127
3af29899 1128 if (!empty($this->page)) {
1129 $params['page'] = $this->page;
cbff94ba 1130 }
865e9a82 1131
3af29899 1132 return $params;
cbff94ba 1133 }
cbff94ba 1134
0610812a 1135 /**
1136 * Returns return url
cf72e2dd 1137 *
0610812a 1138 * @param string $default default url when params not set
cf72e2dd 1139 * @param array $extras Extra URL parameters
1140 *
0610812a 1141 * @return string url
1142 */
d24832f9 1143 public function get_return_url($default, $extras=null) {
3af29899 1144 global $CFG;
cbff94ba 1145
3af29899 1146 if (empty($this->type) or empty($this->plugin)) {
1147 return $default;
cbff94ba 1148 }
1149
65dd61bd 1150 $url = $CFG->wwwroot.'/grade/'.$this->type.'/'.$this->plugin.'/index.php';
1151 $glue = '?';
cbff94ba 1152
3af29899 1153 if (!empty($this->courseid)) {
1154 $url .= $glue.'id='.$this->courseid;
1155 $glue = '&amp;';
cbff94ba 1156 }
cbff94ba 1157
3af29899 1158 if (!empty($this->userid)) {
1159 $url .= $glue.'userid='.$this->userid;
1160 $glue = '&amp;';
cbff94ba 1161 }
7e2d7c92 1162
3af29899 1163 if (!empty($this->page)) {
1164 $url .= $glue.'page='.$this->page;
65dd61bd 1165 $glue = '&amp;';
1166 }
1167
1168 if (!empty($extras)) {
cf72e2dd 1169 foreach ($extras as $key=>$value) {
65dd61bd 1170 $url .= $glue.$key.'='.$value;
1171 $glue = '&amp;';
7a6b7acf 1172 }
cbff94ba 1173 }
cbff94ba 1174
3af29899 1175 return $url;
cbff94ba 1176 }
cbff94ba 1177
0610812a 1178 /**
1179 * Returns string with hidden return tracking form elements.
1180 * @return string
1181 */
d24832f9 1182 public function get_form_fields() {
7a6b7acf 1183 if (empty($this->type)) {
3af29899 1184 return '';
cbff94ba 1185 }
cbff94ba 1186
3af29899 1187 $result = '<input type="hidden" name="gpr_type" value="'.$this->type.'" />';
7a6b7acf 1188
1189 if (!empty($this->plugin)) {
1190 $result .= '<input type="hidden" name="gpr_plugin" value="'.$this->plugin.'" />';
1191 }
0ca5abd6 1192
3af29899 1193 if (!empty($this->courseid)) {
1194 $result .= '<input type="hidden" name="gpr_courseid" value="'.$this->courseid.'" />';
cbff94ba 1195 }
cbff94ba 1196
3af29899 1197 if (!empty($this->userid)) {
1198 $result .= '<input type="hidden" name="gpr_userid" value="'.$this->userid.'" />';
cbff94ba 1199 }
cbff94ba 1200
3af29899 1201 if (!empty($this->page)) {
1202 $result .= '<input type="hidden" name="gpr_page" value="'.$this->page.'" />';
cbff94ba 1203 }
1204 }
cbff94ba 1205
0610812a 1206 /**
1207 * Add hidden elements into mform
cf72e2dd 1208 *
1209 * @param object &$mform moodle form object
1210 *
0610812a 1211 * @return void
1212 */
d24832f9 1213 public function add_mform_elements(&$mform) {
7a6b7acf 1214 if (empty($this->type)) {
3af29899 1215 return;
cbff94ba 1216 }
cbff94ba 1217
3af29899 1218 $mform->addElement('hidden', 'gpr_type', $this->type);
1219 $mform->setType('gpr_type', PARAM_SAFEDIR);
cbff94ba 1220
7a6b7acf 1221 if (!empty($this->plugin)) {
1222 $mform->addElement('hidden', 'gpr_plugin', $this->plugin);
aff24313 1223 $mform->setType('gpr_plugin', PARAM_PLUGIN);
7a6b7acf 1224 }
97033c86 1225
3af29899 1226 if (!empty($this->courseid)) {
1227 $mform->addElement('hidden', 'gpr_courseid', $this->courseid);
1228 $mform->setType('gpr_courseid', PARAM_INT);
cbff94ba 1229 }
cbff94ba 1230
3af29899 1231 if (!empty($this->userid)) {
1232 $mform->addElement('hidden', 'gpr_userid', $this->userid);
1233 $mform->setType('gpr_userid', PARAM_INT);
cbff94ba 1234 }
cbff94ba 1235
3af29899 1236 if (!empty($this->page)) {
1237 $mform->addElement('hidden', 'gpr_page', $this->page);
1238 $mform->setType('gpr_page', PARAM_INT);
cbff94ba 1239 }
1240 }
281ffa4a 1241
0610812a 1242 /**
1243 * Add return tracking params into url
cf72e2dd 1244 *
1c1f64a2 1245 * @param moodle_url $url A URL
cf72e2dd 1246 *
6ef4878b 1247 * @return string $url with return tracking params
0610812a 1248 */
1c1f64a2 1249 public function add_url_params(moodle_url $url) {
7a6b7acf 1250 if (empty($this->type)) {
3af29899 1251 return $url;
cbff94ba 1252 }
5609f9e6 1253
1c1f64a2 1254 $url->param('gpr_type', $this->type);
cbff94ba 1255
7a6b7acf 1256 if (!empty($this->plugin)) {
1c1f64a2 1257 $url->param('gpr_plugin', $this->plugin);
7a6b7acf 1258 }
cbff94ba 1259
3af29899 1260 if (!empty($this->courseid)) {
1c1f64a2 1261 $url->param('gpr_courseid' ,$this->courseid);
cbff94ba 1262 }
cbff94ba 1263
3af29899 1264 if (!empty($this->userid)) {
1c1f64a2 1265 $url->param('gpr_userid', $this->userid);
cbff94ba 1266 }
0a8a95c9 1267
3af29899 1268 if (!empty($this->page)) {
1c1f64a2 1269 $url->param('gpr_page', $this->page);
0a8a95c9 1270 }
5a412dbf 1271
3af29899 1272 return $url;
5a412dbf 1273 }
5a412dbf 1274}
7a6b7acf 1275
826c5f86 1276/**
1277 * Function central to gradebook for building and printing the navigation (breadcrumb trail).
cf72e2dd 1278 *
826c5f86 1279 * @param string $path The path of the calling script (using __FILE__?)
1280 * @param string $pagename The language string to use as the last part of the navigation (non-link)
cf72e2dd 1281 * @param mixed $id Either a plain integer (assuming the key is 'id') or
1282 * an array of keys and values (e.g courseid => $courseid, itemid...)
1283 *
826c5f86 1284 * @return string
1285 */
1286function grade_build_nav($path, $pagename=null, $id=null) {
f3df5e14 1287 global $CFG, $COURSE, $PAGE;
826c5f86 1288
1289 $strgrades = get_string('grades', 'grades');
1290
1291 // Parse the path and build navlinks from its elements
1292 $dirroot_length = strlen($CFG->dirroot) + 1; // Add 1 for the first slash
1293 $path = substr($path, $dirroot_length);
1294 $path = str_replace('\\', '/', $path);
1295
1296 $path_elements = explode('/', $path);
1297
1298 $path_elements_count = count($path_elements);
1299
826c5f86 1300 // First link is always 'grade'
a6855934 1301 $PAGE->navbar->add($strgrades, new moodle_url('/grade/index.php', array('id'=>$COURSE->id)));
826c5f86 1302
f3df5e14 1303 $link = null;
826c5f86 1304 $numberofelements = 3;
1305
1306 // Prepare URL params string
f3df5e14 1307 $linkparams = array();
826c5f86 1308 if (!is_null($id)) {
1309 if (is_array($id)) {
1310 foreach ($id as $idkey => $idvalue) {
f3df5e14 1311 $linkparams[$idkey] = $idvalue;
826c5f86 1312 }
1313 } else {
f3df5e14 1314 $linkparams['id'] = $id;
826c5f86 1315 }
1316 }
1317
1318 $navlink4 = null;
1319
0f78c4de 1320 // Remove file extensions from filenames
1321 foreach ($path_elements as $key => $filename) {
1322 $path_elements[$key] = str_replace('.php', '', $filename);
1323 }
1324
826c5f86 1325 // Second level links
1326 switch ($path_elements[1]) {
1327 case 'edit': // No link
1328 if ($path_elements[3] != 'index.php') {
1329 $numberofelements = 4;
1330 }
1331 break;
1332 case 'import': // No link
1333 break;
1334 case 'export': // No link
1335 break;
1336 case 'report':
1337 // $id is required for this link. Do not print it if $id isn't given
1338 if (!is_null($id)) {
a6855934 1339 $link = new moodle_url('/grade/report/index.php', $linkparams);
826c5f86 1340 }
1341
1342 if ($path_elements[2] == 'grader') {
1343 $numberofelements = 4;
1344 }
1345 break;
1346
1347 default:
1348 // If this element isn't among the ones already listed above, it isn't supported, throw an error.
cf72e2dd 1349 debugging("grade_build_nav() doesn't support ". $path_elements[1] .
1350 " as the second path element after 'grade'.");
826c5f86 1351 return false;
1352 }
f3df5e14 1353 $PAGE->navbar->add(get_string($path_elements[1], 'grades'), $link);
826c5f86 1354
1355 // Third level links
1356 if (empty($pagename)) {
1357 $pagename = get_string($path_elements[2], 'grades');
1358 }
1359
1360 switch ($numberofelements) {
1361 case 3:
f3df5e14 1362 $PAGE->navbar->add($pagename, $link);
826c5f86 1363 break;
1364 case 4:
826c5f86 1365 if ($path_elements[2] == 'grader' AND $path_elements[3] != 'index.php') {
b5e7b2bf 1366 $PAGE->navbar->add(get_string('pluginname', 'gradereport_grader'), new moodle_url('/grade/report/grader/index.php', $linkparams));
826c5f86 1367 }
f3df5e14 1368 $PAGE->navbar->add($pagename);
826c5f86 1369 break;
1370 }
826c5f86 1371
f3df5e14 1372 return '';
d4795a07 1373}
7a6b7acf 1374
e98871a2 1375/**
6cc3e350 1376 * General structure representing grade items in course
cf72e2dd 1377 *
a153c9f2 1378 * @package core_grades
cf72e2dd 1379 * @copyright 2009 Nicolas Connault
1380 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
e98871a2 1381 */
6cc3e350 1382class grade_structure {
d24832f9 1383 public $context;
e98871a2 1384
d24832f9 1385 public $courseid;
e98871a2 1386
73ca5f01 1387 /**
1388 * Reference to modinfo for current course (for performance, to save
1389 * retrieving it from courseid every time). Not actually set except for
1390 * the grade_tree type.
1391 * @var course_modinfo
1392 */
1393 public $modinfo;
1394
e98871a2 1395 /**
1396 * 1D array of grade items only
1397 */
d24832f9 1398 public $items;
e98871a2 1399
6391ebe7 1400 /**
6cc3e350 1401 * Returns icon of element
cf72e2dd 1402 *
1403 * @param array &$element An array representing an element in the grade_tree
1404 * @param bool $spacerifnone return spacer if no icon found
1405 *
6cc3e350 1406 * @return string icon or spacer
6391ebe7 1407 */
d24832f9 1408 public function get_element_icon(&$element, $spacerifnone=false) {
6b608f8f 1409 global $CFG, $OUTPUT;
559276b1 1410 require_once $CFG->libdir.'/filelib.php';
6cc3e350 1411
1ef48469
JC
1412 $outputstr = '';
1413
1414 // Object holding pix_icon information before instantiation.
1415 $icon = new stdClass();
1416 $icon->attributes = array(
09235e24 1417 'class' => 'icon itemicon'
1ef48469
JC
1418 );
1419 $icon->component = 'moodle';
1420
1421 $none = true;
6cc3e350 1422 switch ($element['type']) {
1423 case 'item':
1424 case 'courseitem':
1425 case 'categoryitem':
1ef48469
JC
1426 $none = false;
1427
cf72e2dd 1428 $is_course = $element['object']->is_course_item();
1429 $is_category = $element['object']->is_category_item();
1430 $is_scale = $element['object']->gradetype == GRADE_TYPE_SCALE;
1431 $is_value = $element['object']->gradetype == GRADE_TYPE_VALUE;
0077f571 1432 $is_outcome = !empty($element['object']->outcomeid);
cf72e2dd 1433
6cc3e350 1434 if ($element['object']->is_calculated()) {
1ef48469
JC
1435 $icon->pix = 'i/calc';
1436 $icon->title = s(get_string('calculatedgrade', 'grades'));
6cc3e350 1437
cf72e2dd 1438 } else if (($is_course or $is_category) and ($is_scale or $is_value)) {
6cc3e350 1439 if ($category = $element['object']->get_item_category()) {
bfe969e8
DW
1440 $aggrstrings = grade_helper::get_aggregation_strings();
1441 $stragg = $aggrstrings[$category->aggregation];
1ef48469
JC
1442
1443 $icon->pix = 'i/calc';
1444 $icon->title = s($stragg);
1445
6cc3e350 1446 switch ($category->aggregation) {
1447 case GRADE_AGGREGATE_MEAN:
1448 case GRADE_AGGREGATE_MEDIAN:
1449 case GRADE_AGGREGATE_WEIGHTED_MEAN:
1426edac 1450 case GRADE_AGGREGATE_WEIGHTED_MEAN2:
6cc3e350 1451 case GRADE_AGGREGATE_EXTRACREDIT_MEAN:
1ef48469
JC
1452 $icon->pix = 'i/agg_mean';
1453 break;
0758a08e 1454 case GRADE_AGGREGATE_SUM:
1ef48469
JC
1455 $icon->pix = 'i/agg_sum';
1456 break;
6cc3e350 1457 }
1458 }
1459
1460 } else if ($element['object']->itemtype == 'mod') {
1ef48469 1461 // Prevent outcomes displaying the same icon as the activity they are attached to.
0077f571 1462 if ($is_outcome) {
1ef48469
JC
1463 $icon->pix = 'i/outcomes';
1464 $icon->title = s(get_string('outcome', 'grades'));
0077f571 1465 } else {
1ef48469
JC
1466 $icon->pix = 'icon';
1467 $icon->component = $element['object']->itemmodule;
1468 $icon->title = s(get_string('modulename', $element['object']->itemmodule));
0077f571 1469 }
6cc3e350 1470 } else if ($element['object']->itemtype == 'manual') {
1471 if ($element['object']->is_outcome_item()) {
1ef48469
JC
1472 $icon->pix = 'i/outcomes';
1473 $icon->title = s(get_string('outcome', 'grades'));
6cc3e350 1474 } else {
1ef48469
JC
1475 $icon->pix = 'i/manual_item';
1476 $icon->title = s(get_string('manualitem', 'grades'));
6cc3e350 1477 }
1478 }
1479 break;
1480
1481 case 'category':
1ef48469
JC
1482 $none = false;
1483 $icon->pix = 'i/folder';
1484 $icon->title = s(get_string('category', 'grades'));
1485 break;
6cc3e350 1486 }
1487
1ef48469
JC
1488 if ($none) {
1489 if ($spacerifnone) {
1490 $outputstr = $OUTPUT->spacer() . ' ';
1491 }
6cc3e350 1492 } else {
1ef48469 1493 $outputstr = $OUTPUT->pix_icon($icon->pix, $icon->title, $icon->component, $icon->attributes);
6cc3e350 1494 }
1ef48469
JC
1495
1496 return $outputstr;
6cc3e350 1497 }
6391ebe7 1498
e98871a2 1499 /**
6cc3e350 1500 * Returns name of element optionally with icon and link
cf72e2dd 1501 *
1502 * @param array &$element An array representing an element in the grade_tree
1503 * @param bool $withlink Whether or not this header has a link
1504 * @param bool $icon Whether or not to display an icon with this header
1505 * @param bool $spacerifnone return spacer if no icon found
65c2ac93 1506 * @param bool $withdescription Show description if defined by this item.
41e62a90
AN
1507 * @param bool $fulltotal If the item is a category total, returns $categoryname."total"
1508 * instead of "Category total" or "Course total"
cf72e2dd 1509 *
1510 * @return string header
e98871a2 1511 */
41e62a90
AN
1512 public function get_element_header(&$element, $withlink = false, $icon = true, $spacerifnone = false,
1513 $withdescription = false, $fulltotal = false) {
6cc3e350 1514 $header = '';
1515
1516 if ($icon) {
1517 $header .= $this->get_element_icon($element, $spacerifnone);
1518 }
1519
41e62a90 1520 $header .= $element['object']->get_name($fulltotal);
6cc3e350 1521
cf72e2dd 1522 if ($element['type'] != 'item' and $element['type'] != 'categoryitem' and
1523 $element['type'] != 'courseitem') {
6cc3e350 1524 return $header;
1525 }
1526
43cd76e8
JC
1527 if ($withlink && $url = $this->get_activity_link($element)) {
1528 $a = new stdClass();
1529 $a->name = get_string('modulename', $element['object']->itemmodule);
1530 $title = get_string('linktoactivity', 'grades', $a);
1531
1532 $header = html_writer::link($url, $header, array('title' => $title));
1533 } else {
1534 $header = html_writer::span($header);
6cc3e350 1535 }
1536
65c2ac93
DW
1537 if ($withdescription) {
1538 $desc = $element['object']->get_description();
1539 if (!empty($desc)) {
1540 $header .= '<div class="gradeitemdescription">' . s($desc) . '</div><div class="gradeitemdescriptionfiller"></div>';
1541 }
1542 }
1543
6cc3e350 1544 return $header;
1545 }
1546
73ca5f01 1547 private function get_activity_link($element) {
1548 global $CFG;
eff314b0
DM
1549 /** @var array static cache of the grade.php file existence flags */
1550 static $hasgradephp = array();
73ca5f01 1551
1552 $itemtype = $element['object']->itemtype;
1553 $itemmodule = $element['object']->itemmodule;
1554 $iteminstance = $element['object']->iteminstance;
25ab1d50 1555 $itemnumber = $element['object']->itemnumber;
73ca5f01 1556
1557 // Links only for module items that have valid instance, module and are
1558 // called from grade_tree with valid modinfo
1559 if ($itemtype != 'mod' || !$iteminstance || !$itemmodule || !$this->modinfo) {
1560 return null;
1561 }
1562
1563 // Get $cm efficiently and with visibility information using modinfo
1564 $instances = $this->modinfo->get_instances();
1565 if (empty($instances[$itemmodule][$iteminstance])) {
1566 return null;
1567 }
1568 $cm = $instances[$itemmodule][$iteminstance];
1569
1570 // Do not add link if activity is not visible to the current user
1571 if (!$cm->uservisible) {
1572 return null;
1573 }
1574
eff314b0
DM
1575 if (!array_key_exists($itemmodule, $hasgradephp)) {
1576 if (file_exists($CFG->dirroot . '/mod/' . $itemmodule . '/grade.php')) {
1577 $hasgradephp[$itemmodule] = true;
1578 } else {
1579 $hasgradephp[$itemmodule] = false;
1580 }
1581 }
1582
73ca5f01 1583 // If module has grade.php, link to that, otherwise view.php
eff314b0 1584 if ($hasgradephp[$itemmodule]) {
c97933ff
MG
1585 $args = array('id' => $cm->id, 'itemnumber' => $itemnumber);
1586 if (isset($element['userid'])) {
1587 $args['userid'] = $element['userid'];
1588 }
1589 return new moodle_url('/mod/' . $itemmodule . '/grade.php', $args);
73ca5f01 1590 } else {
1591 return new moodle_url('/mod/' . $itemmodule . '/view.php', array('id' => $cm->id));
1592 }
1593 }
1594
bb17ac1e
DM
1595 /**
1596 * Returns URL of a page that is supposed to contain detailed grade analysis
1597 *
bb17ac1e
DM
1598 * At the moment, only activity modules are supported. The method generates link
1599 * to the module's file grade.php with the parameters id (cmid), itemid, itemnumber,
eff314b0 1600 * gradeid and userid. If the grade.php does not exist, null is returned.
bb17ac1e
DM
1601 *
1602 * @return moodle_url|null URL or null if unable to construct it
1603 */
1604 public function get_grade_analysis_url(grade_grade $grade) {
eff314b0
DM
1605 global $CFG;
1606 /** @var array static cache of the grade.php file existence flags */
1607 static $hasgradephp = array();
bb17ac1e
DM
1608
1609 if (empty($grade->grade_item) or !($grade->grade_item instanceof grade_item)) {
1610 throw new coding_exception('Passed grade without the associated grade item');
1611 }
1612 $item = $grade->grade_item;
1613
1614 if (!$item->is_external_item()) {
1615 // at the moment, only activity modules are supported
1616 return null;
1617 }
1618 if ($item->itemtype !== 'mod') {
1619 throw new coding_exception('Unknown external itemtype: '.$item->itemtype);
1620 }
1621 if (empty($item->iteminstance) or empty($item->itemmodule) or empty($this->modinfo)) {
1622 return null;
1623 }
1624
eff314b0
DM
1625 if (!array_key_exists($item->itemmodule, $hasgradephp)) {
1626 if (file_exists($CFG->dirroot . '/mod/' . $item->itemmodule . '/grade.php')) {
1627 $hasgradephp[$item->itemmodule] = true;
1628 } else {
1629 $hasgradephp[$item->itemmodule] = false;
1630 }
1631 }
1632
1633 if (!$hasgradephp[$item->itemmodule]) {
1634 return null;
1635 }
1636
bb17ac1e
DM
1637 $instances = $this->modinfo->get_instances();
1638 if (empty($instances[$item->itemmodule][$item->iteminstance])) {
1639 return null;
1640 }
1641 $cm = $instances[$item->itemmodule][$item->iteminstance];
1642 if (!$cm->uservisible) {
1643 return null;
1644 }
1645
1646 $url = new moodle_url('/mod/'.$item->itemmodule.'/grade.php', array(
1647 'id' => $cm->id,
1648 'itemid' => $item->id,
1649 'itemnumber' => $item->itemnumber,
1650 'gradeid' => $grade->id,
1651 'userid' => $grade->userid,
1652 ));
1653
1654 return $url;
1655 }
1656
1657 /**
1658 * Returns an action icon leading to the grade analysis page
1659 *
1660 * @param grade_grade $grade
1661 * @return string
1662 */
1663 public function get_grade_analysis_icon(grade_grade $grade) {
1664 global $OUTPUT;
1665
1666 $url = $this->get_grade_analysis_url($grade);
1667 if (is_null($url)) {
1668 return '';
1669 }
1670
c97933ff 1671 return $OUTPUT->action_icon($url, new pix_icon('t/preview',
bb17ac1e
DM
1672 get_string('gradeanalysis', 'core_grades')));
1673 }
1674
6cc3e350 1675 /**
1676 * Returns the grade eid - the grade may not exist yet.
cf72e2dd 1677 *
1678 * @param grade_grade $grade_grade A grade_grade object
1679 *
6cc3e350 1680 * @return string eid
1681 */
d24832f9 1682 public function get_grade_eid($grade_grade) {
6cc3e350 1683 if (empty($grade_grade->id)) {
1684 return 'n'.$grade_grade->itemid.'u'.$grade_grade->userid;
1685 } else {
1686 return 'g'.$grade_grade->id;
1687 }
1688 }
1689
1690 /**
1691 * Returns the grade_item eid
cf72e2dd 1692 * @param grade_item $grade_item A grade_item object
6cc3e350 1693 * @return string eid
1694 */
d24832f9 1695 public function get_item_eid($grade_item) {
ddb9c95f 1696 return 'ig'.$grade_item->id;
6cc3e350 1697 }
1698
cf72e2dd 1699 /**
1700 * Given a grade_tree element, returns an array of parameters
1701 * used to build an icon for that element.
1702 *
1703 * @param array $element An array representing an element in the grade_tree
1704 *
1705 * @return array
1706 */
1707 public function get_params_for_iconstr($element) {
9ecd4386 1708 $strparams = new stdClass();
1709 $strparams->category = '';
1710 $strparams->itemname = '';
1711 $strparams->itemmodule = '';
cf72e2dd 1712
9ecd4386 1713 if (!method_exists($element['object'], 'get_name')) {
1714 return $strparams;
1715 }
345674ca 1716
b285c5aa 1717 $strparams->itemname = html_to_text($element['object']->get_name());
9ecd4386 1718
1719 // If element name is categorytotal, get the name of the parent category
1720 if ($strparams->itemname == get_string('categorytotal', 'grades')) {
1721 $parent = $element['object']->get_parent_category();
1722 $strparams->category = $parent->get_name() . ' ';
1723 } else {
1724 $strparams->category = '';
1725 }
1726
1727 $strparams->itemmodule = null;
1728 if (isset($element['object']->itemmodule)) {
1729 $strparams->itemmodule = $element['object']->itemmodule;
345674ca 1730 }
9ecd4386 1731 return $strparams;
1732 }
1733
ae93f353
FM
1734 /**
1735 * Return a reset icon for the given element.
1736 *
1737 * @param array $element An array representing an element in the grade_tree
1738 * @param object $gpr A grade_plugin_return object
079b2e52
MG
1739 * @param bool $returnactionmenulink return the instance of action_menu_link instead of string
1740 * @return string|action_menu_link
ae93f353 1741 */
079b2e52 1742 public function get_reset_icon($element, $gpr, $returnactionmenulink = false) {
ae93f353
FM
1743 global $CFG, $OUTPUT;
1744
1745 // Limit to category items set to use the natural weights aggregation method, and users
1746 // with the capability to manage grades.
1747 if ($element['type'] != 'category' || $element['object']->aggregation != GRADE_AGGREGATE_SUM ||
1748 !has_capability('moodle/grade:manage', $this->context)) {
079b2e52 1749 return $returnactionmenulink ? null : '';
ae93f353
FM
1750 }
1751
1752 $str = get_string('resetweights', 'grades', $this->get_params_for_iconstr($element));
1753 $url = new moodle_url('/grade/edit/tree/action.php', array(
1754 'id' => $this->courseid,
1755 'action' => 'resetweights',
1756 'eid' => $element['eid'],
1757 'sesskey' => sesskey(),
1758 ));
1759
079b2e52
MG
1760 if ($returnactionmenulink) {
1761 return new action_menu_link_secondary($gpr->add_url_params($url), new pix_icon('t/reset', $str),
1762 get_string('resetweightsshort', 'grades'));
1763 } else {
1764 return $OUTPUT->action_icon($gpr->add_url_params($url), new pix_icon('t/reset', $str));
1765 }
ae93f353
FM
1766 }
1767
6cc3e350 1768 /**
1769 * Return edit icon for give element
cf72e2dd 1770 *
1771 * @param array $element An array representing an element in the grade_tree
1772 * @param object $gpr A grade_plugin_return object
079b2e52
MG
1773 * @param bool $returnactionmenulink return the instance of action_menu_link instead of string
1774 * @return string|action_menu_link
6cc3e350 1775 */
079b2e52 1776 public function get_edit_icon($element, $gpr, $returnactionmenulink = false) {
6b608f8f 1777 global $CFG, $OUTPUT;
6cc3e350 1778
1779 if (!has_capability('moodle/grade:manage', $this->context)) {
1780 if ($element['type'] == 'grade' and has_capability('moodle/grade:edit', $this->context)) {
1781 // oki - let them override grade
1782 } else {
079b2e52 1783 return $returnactionmenulink ? null : '';
6cc3e350 1784 }
1785 }
1786
05aba805 1787 static $strfeedback = null;
1788 static $streditgrade = null;
1789 if (is_null($streditgrade)) {
1790 $streditgrade = get_string('editgrade', 'grades');
1791 $strfeedback = get_string('feedback');
6cc3e350 1792 }
1793
9ecd4386 1794 $strparams = $this->get_params_for_iconstr($element);
6ef4878b 1795
6cc3e350 1796 $object = $element['object'];
6cc3e350 1797
1798 switch ($element['type']) {
1799 case 'item':
1800 case 'categoryitem':
1801 case 'courseitem':
9ecd4386 1802 $stredit = get_string('editverbose', 'grades', $strparams);
6cc3e350 1803 if (empty($object->outcomeid) || empty($CFG->enableoutcomes)) {
a6855934 1804 $url = new moodle_url('/grade/edit/tree/item.php',
1c1f64a2 1805 array('courseid' => $this->courseid, 'id' => $object->id));
6cc3e350 1806 } else {
a6855934 1807 $url = new moodle_url('/grade/edit/tree/outcomeitem.php',
1c1f64a2 1808 array('courseid' => $this->courseid, 'id' => $object->id));
6cc3e350 1809 }
6cc3e350 1810 break;
1811
1812 case 'category':
9ecd4386 1813 $stredit = get_string('editverbose', 'grades', $strparams);
a6855934 1814 $url = new moodle_url('/grade/edit/tree/category.php',
1c1f64a2 1815 array('courseid' => $this->courseid, 'id' => $object->id));
6cc3e350 1816 break;
1817
1818 case 'grade':
05aba805 1819 $stredit = $streditgrade;
6cc3e350 1820 if (empty($object->id)) {
a6855934 1821 $url = new moodle_url('/grade/edit/tree/grade.php',
1c1f64a2 1822 array('courseid' => $this->courseid, 'itemid' => $object->itemid, 'userid' => $object->userid));
6cc3e350 1823 } else {
a6855934 1824 $url = new moodle_url('/grade/edit/tree/grade.php',
1c1f64a2 1825 array('courseid' => $this->courseid, 'id' => $object->id));
6cc3e350 1826 }
6cc3e350 1827 if (!empty($object->feedback)) {
1828 $feedback = addslashes_js(trim(format_string($object->feedback, $object->feedbackformat)));
6cc3e350 1829 }
1830 break;
1831
1832 default:
1833 $url = null;
1834 }
1835
1836 if ($url) {
079b2e52
MG
1837 if ($returnactionmenulink) {
1838 return new action_menu_link_secondary($gpr->add_url_params($url),
1839 new pix_icon('t/edit', $stredit),
1840 get_string('editsettings'));
1841 } else {
1842 return $OUTPUT->action_icon($gpr->add_url_params($url), new pix_icon('t/edit', $stredit));
1843 }
6cc3e350 1844
1845 } else {
079b2e52 1846 return $returnactionmenulink ? null : '';
6cc3e350 1847 }
1848 }
1849
1850 /**
1851 * Return hiding icon for give element
cf72e2dd 1852 *
1853 * @param array $element An array representing an element in the grade_tree
1854 * @param object $gpr A grade_plugin_return object
079b2e52
MG
1855 * @param bool $returnactionmenulink return the instance of action_menu_link instead of string
1856 * @return string|action_menu_link
6cc3e350 1857 */
079b2e52 1858 public function get_hiding_icon($element, $gpr, $returnactionmenulink = false) {
5d3b9994 1859 global $CFG, $OUTPUT;
6cc3e350 1860
39873128 1861 if (!$element['object']->can_control_visibility()) {
079b2e52 1862 return $returnactionmenulink ? null : '';
39873128
TH
1863 }
1864
cf72e2dd 1865 if (!has_capability('moodle/grade:manage', $this->context) and
1866 !has_capability('moodle/grade:hide', $this->context)) {
079b2e52 1867 return $returnactionmenulink ? null : '';
6cc3e350 1868 }
1869
345674ca 1870 $strparams = $this->get_params_for_iconstr($element);
9ecd4386 1871 $strshow = get_string('showverbose', 'grades', $strparams);
345674ca 1872 $strhide = get_string('hideverbose', 'grades', $strparams);
6cc3e350 1873
a6855934 1874 $url = new moodle_url('/grade/edit/tree/action.php', array('id' => $this->courseid, 'sesskey' => sesskey(), 'eid' => $element['eid']));
8ae8bf8a 1875 $url = $gpr->add_url_params($url);
1c1f64a2 1876
6cc3e350 1877 if ($element['object']->is_hidden()) {
8ae8bf8a 1878 $type = 'show';
6cc3e350 1879 $tooltip = $strshow;
1880
cf72e2dd 1881 // Change the icon and add a tooltip showing the date
1882 if ($element['type'] != 'category' and $element['object']->get_hidden() > 1) {
8ae8bf8a 1883 $type = 'hiddenuntil';
cf72e2dd 1884 $tooltip = get_string('hiddenuntildate', 'grades',
1885 userdate($element['object']->get_hidden()));
6cc3e350 1886 }
1887
8ae8bf8a 1888 $url->param('action', 'show');
b9cc756e 1889
079b2e52
MG
1890 if ($returnactionmenulink) {
1891 $hideicon = new action_menu_link_secondary($url, new pix_icon('t/'.$type, $tooltip), get_string('show'));
1892 } else {
1893 $hideicon = $OUTPUT->action_icon($url, new pix_icon('t/'.$type, $tooltip, 'moodle', array('alt'=>$strshow, 'class'=>'smallicon')));
1894 }
6cc3e350 1895
1896 } else {
8ae8bf8a 1897 $url->param('action', 'hide');
079b2e52
MG
1898 if ($returnactionmenulink) {
1899 $hideicon = new action_menu_link_secondary($url, new pix_icon('t/hide', $strhide), get_string('hide'));
1900 } else {
1901 $hideicon = $OUTPUT->action_icon($url, new pix_icon('t/hide', $strhide));
1902 }
6cc3e350 1903 }
1c1f64a2 1904
8ae8bf8a 1905 return $hideicon;
6cc3e350 1906 }
1907
1908 /**
2673c733 1909 * Return locking icon for given element
cf72e2dd 1910 *
1911 * @param array $element An array representing an element in the grade_tree
1912 * @param object $gpr A grade_plugin_return object
1913 *
6cc3e350 1914 * @return string
1915 */
d24832f9 1916 public function get_locking_icon($element, $gpr) {
6b608f8f 1917 global $CFG, $OUTPUT;
6cc3e350 1918
345674ca 1919 $strparams = $this->get_params_for_iconstr($element);
9ecd4386 1920 $strunlock = get_string('unlockverbose', 'grades', $strparams);
1921 $strlock = get_string('lockverbose', 'grades', $strparams);
d24832f9 1922
a6855934 1923 $url = new moodle_url('/grade/edit/tree/action.php', array('id' => $this->courseid, 'sesskey' => sesskey(), 'eid' => $element['eid']));
8ae8bf8a 1924 $url = $gpr->add_url_params($url);
1c1f64a2 1925
2673c733 1926 // Don't allow an unlocking action for a grade whose grade item is locked: just print a state icon
1927 if ($element['type'] == 'grade' && $element['object']->grade_item->is_locked()) {
1928 $strparamobj = new stdClass();
1929 $strparamobj->itemname = $element['object']->grade_item->itemname;
1930 $strnonunlockable = get_string('nonunlockableverbose', 'grades', $strparamobj);
1c1f64a2 1931
0cddd851
FM
1932 $action = html_writer::tag('span', $OUTPUT->pix_icon('t/locked', $strnonunlockable),
1933 array('class' => 'action-icon'));
8ae8bf8a 1934
cf72e2dd 1935 } else if ($element['object']->is_locked()) {
8ae8bf8a 1936 $type = 'unlock';
6cc3e350 1937 $tooltip = $strunlock;
1938
cf72e2dd 1939 // Change the icon and add a tooltip showing the date
1940 if ($element['type'] != 'category' and $element['object']->get_locktime() > 1) {
8ae8bf8a 1941 $type = 'locktime';
cf72e2dd 1942 $tooltip = get_string('locktimedate', 'grades',
1943 userdate($element['object']->get_locktime()));
6cc3e350 1944 }
1945
8ae8bf8a
PS
1946 if (!has_capability('moodle/grade:manage', $this->context) and !has_capability('moodle/grade:unlock', $this->context)) {
1947 $action = '';
1948 } else {
1949 $url->param('action', 'unlock');
c63923bd 1950 $action = $OUTPUT->action_icon($url, new pix_icon('t/'.$type, $tooltip, 'moodle', array('alt'=>$strunlock, 'class'=>'smallicon')));
6cc3e350 1951 }
6cc3e350 1952
1953 } else {
8ae8bf8a
PS
1954 if (!has_capability('moodle/grade:manage', $this->context) and !has_capability('moodle/grade:lock', $this->context)) {
1955 $action = '';
1956 } else {
1957 $url->param('action', 'lock');
c63923bd 1958 $action = $OUTPUT->action_icon($url, new pix_icon('t/lock', $strlock));
6cc3e350 1959 }
6cc3e350 1960 }
8ae8bf8a 1961
6cc3e350 1962 return $action;
1963 }
1964
1965 /**
1966 * Return calculation icon for given element
cf72e2dd 1967 *
1968 * @param array $element An array representing an element in the grade_tree
1969 * @param object $gpr A grade_plugin_return object
079b2e52
MG
1970 * @param bool $returnactionmenulink return the instance of action_menu_link instead of string
1971 * @return string|action_menu_link
6cc3e350 1972 */
079b2e52 1973 public function get_calculation_icon($element, $gpr, $returnactionmenulink = false) {
666e8458 1974 global $CFG, $OUTPUT;
6cc3e350 1975 if (!has_capability('moodle/grade:manage', $this->context)) {
079b2e52 1976 return $returnactionmenulink ? null : '';
6cc3e350 1977 }
1978
6cc3e350 1979 $type = $element['type'];
1980 $object = $element['object'];
1981
1982 if ($type == 'item' or $type == 'courseitem' or $type == 'categoryitem') {
345674ca 1983 $strparams = $this->get_params_for_iconstr($element);
9ecd4386 1984 $streditcalculation = get_string('editcalculationverbose', 'grades', $strparams);
6cc3e350 1985
cf72e2dd 1986 $is_scale = $object->gradetype == GRADE_TYPE_SCALE;
1987 $is_value = $object->gradetype == GRADE_TYPE_VALUE;
1988
6cc3e350 1989 // show calculation icon only when calculation possible
cf72e2dd 1990 if (!$object->is_external_item() and ($is_scale or $is_value)) {
6cc3e350 1991 if ($object->is_calculated()) {
666e8458 1992 $icon = 't/calc';
6cc3e350 1993 } else {
666e8458 1994 $icon = 't/calc_off';
6cc3e350 1995 }
cf72e2dd 1996
a6855934 1997 $url = new moodle_url('/grade/edit/tree/calculation.php', array('courseid' => $this->courseid, 'id' => $object->id));
8ae8bf8a 1998 $url = $gpr->add_url_params($url);
079b2e52
MG
1999 if ($returnactionmenulink) {
2000 return new action_menu_link_secondary($url,
2001 new pix_icon($icon, $streditcalculation),
2002 get_string('editcalculation', 'grades'));
2003 } else {
2004 return $OUTPUT->action_icon($url, new pix_icon($icon, $streditcalculation));
2005 }
6cc3e350 2006 }
2007 }
2008
079b2e52 2009 return $returnactionmenulink ? null : '';
6cc3e350 2010 }
2011}
2012
2013/**
2014 * Flat structure similar to grade tree.
cf72e2dd 2015 *
2016 * @uses grade_structure
a153c9f2 2017 * @package core_grades
cf72e2dd 2018 * @copyright 2009 Nicolas Connault
2019 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
6cc3e350 2020 */
2021class grade_seq extends grade_structure {
2022
6cc3e350 2023 /**
2024 * 1D array of elements
2025 */
d24832f9 2026 public $elements;
e98871a2 2027
2028 /**
2029 * Constructor, retrieves and stores array of all grade_category and grade_item
2030 * objects for the given courseid. Full objects are instantiated. Ordering sequence is fixed if needed.
cf72e2dd 2031 *
2032 * @param int $courseid The course id
2033 * @param bool $category_grade_last category grade item is the last child
2034 * @param bool $nooutcomes Whether or not outcomes should be included
e98871a2 2035 */
c4d0b752 2036 public function __construct($courseid, $category_grade_last=false, $nooutcomes=false) {
e98871a2 2037 global $USER, $CFG;
2038
2039 $this->courseid = $courseid;
d4060472 2040 $this->context = context_course::instance($courseid);
e98871a2 2041
2042 // get course grade tree
2043 $top_element = grade_category::fetch_course_tree($courseid, true);
2044
6391ebe7 2045 $this->elements = grade_seq::flatten($top_element, $category_grade_last, $nooutcomes);
2046
2047 foreach ($this->elements as $key=>$unused) {
b89a70ce 2048 $this->items[$this->elements[$key]['object']->id] =& $this->elements[$key]['object'];
6391ebe7 2049 }
e98871a2 2050 }
2051
2052 /**
2053 * Static recursive helper - makes the grade_item for category the last children
cf72e2dd 2054 *
2055 * @param array &$element The seed of the recursion
2056 * @param bool $category_grade_last category grade item is the last child
2057 * @param bool $nooutcomes Whether or not outcomes should be included
2058 *
2059 * @return array
e98871a2 2060 */
d24832f9 2061 public function flatten(&$element, $category_grade_last, $nooutcomes) {
e98871a2 2062 if (empty($element['children'])) {
2063 return array();
2064 }
2065 $children = array();
2066
2067 foreach ($element['children'] as $sortorder=>$unused) {
cf72e2dd 2068 if ($nooutcomes and $element['type'] != 'category' and
2069 $element['children'][$sortorder]['object']->is_outcome_item()) {
e98871a2 2070 continue;
2071 }
2072 $children[] = $element['children'][$sortorder];
2073 }
2074 unset($element['children']);
2075
2076 if ($category_grade_last and count($children) > 1) {
2077 $cat_item = array_shift($children);
2078 array_push($children, $cat_item);
2079 }
2080
2081 $result = array();
2082 foreach ($children as $child) {
e0724506 2083 if ($child['type'] == 'category') {
6391ebe7 2084 $result = $result + grade_seq::flatten($child, $category_grade_last, $nooutcomes);
e98871a2 2085 } else {
2086 $child['eid'] = 'i'.$child['object']->id;
6391ebe7 2087 $result[$child['object']->id] = $child;
e98871a2 2088 }
2089 }
2090
2091 return $result;
2092 }
2093
2094 /**
2095 * Parses the array in search of a given eid and returns a element object with
2096 * information about the element it has found.
cf72e2dd 2097 *
2098 * @param int $eid Gradetree Element ID
2099 *
e98871a2 2100 * @return object element
2101 */
d24832f9 2102 public function locate_element($eid) {
e98871a2 2103 // it is a grade - construct a new object
2104 if (strpos($eid, 'n') === 0) {
2105 if (!preg_match('/n(\d+)u(\d+)/', $eid, $matches)) {
2106 return null;
2107 }
2108
2109 $itemid = $matches[1];
2110 $userid = $matches[2];
2111
2112 //extra security check - the grade item must be in this tree
ddb9c95f 2113 if (!$item_el = $this->locate_element('ig'.$itemid)) {
e98871a2 2114 return null;
2115 }
2116
2117 // $gradea->id may be null - means does not exist yet
2118 $grade = new grade_grade(array('itemid'=>$itemid, 'userid'=>$userid));
2119
2120 $grade->grade_item =& $item_el['object']; // this may speedup grade_grade methods!
2121 return array('eid'=>'n'.$itemid.'u'.$userid,'object'=>$grade, 'type'=>'grade');
2122
2123 } else if (strpos($eid, 'g') === 0) {
cf72e2dd 2124 $id = (int) substr($eid, 1);
e98871a2 2125 if (!$grade = grade_grade::fetch(array('id'=>$id))) {
2126 return null;
2127 }
2128 //extra security check - the grade item must be in this tree
ddb9c95f 2129 if (!$item_el = $this->locate_element('ig'.$grade->itemid)) {
e98871a2 2130 return null;
2131 }
2132 $grade->grade_item =& $item_el['object']; // this may speedup grade_grade methods!
2133 return array('eid'=>'g'.$id,'object'=>$grade, 'type'=>'grade');
2134 }
2135
2136 // it is a category or item
6391ebe7 2137 foreach ($this->elements as $element) {
6cc3e350 2138 if ($element['eid'] == $eid) {
2139 return $element;
2140 }
e98871a2 2141 }
6cc3e350 2142
2143 return null;
e98871a2 2144 }
e98871a2 2145}
2146
7a6b7acf 2147/**
2148 * This class represents a complete tree of categories, grade_items and final grades,
2149 * organises as an array primarily, but which can also be converted to other formats.
2150 * It has simple method calls with complex implementations, allowing for easy insertion,
2151 * deletion and moving of items and categories within the tree.
cf72e2dd 2152 *
2153 * @uses grade_structure
a153c9f2 2154 * @package core_grades
cf72e2dd 2155 * @copyright 2009 Nicolas Connault
2156 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
7a6b7acf 2157 */
6cc3e350 2158class grade_tree extends grade_structure {
7a6b7acf 2159
2160 /**
2161 * The basic representation of the tree as a hierarchical, 3-tiered array.
2162 * @var object $top_element
2163 */
d24832f9 2164 public $top_element;
7a6b7acf 2165
7a6b7acf 2166 /**
2167 * 2D array of grade items and categories
cf72e2dd 2168 * @var array $levels
7a6b7acf 2169 */
d24832f9 2170 public $levels;
7a6b7acf 2171
b89a70ce 2172 /**
2173 * Grade items
cf72e2dd 2174 * @var array $items
b89a70ce 2175 */
d24832f9 2176 public $items;
b89a70ce 2177
7a6b7acf 2178 /**
2179 * Constructor, retrieves and stores a hierarchical array of all grade_category and grade_item
e98871a2 2180 * objects for the given courseid. Full objects are instantiated. Ordering sequence is fixed if needed.
cf72e2dd 2181 *
2182 * @param int $courseid The Course ID
2183 * @param bool $fillers include fillers and colspans, make the levels var "rectangular"
2184 * @param bool $category_grade_last category grade item is the last child
4faf5f99 2185 * @param array $collapsed array of collapsed categories
cf72e2dd 2186 * @param bool $nooutcomes Whether or not outcomes should be included
7a6b7acf 2187 */
c4d0b752 2188 public function __construct($courseid, $fillers=true, $category_grade_last=false,
cf72e2dd 2189 $collapsed=null, $nooutcomes=false) {
73ca5f01 2190 global $USER, $CFG, $COURSE, $DB;
7a6b7acf 2191
2192 $this->courseid = $courseid;
7a6b7acf 2193 $this->levels = array();
d4060472 2194 $this->context = context_course::instance($courseid);
7a6b7acf 2195
73ca5f01 2196 if (!empty($COURSE->id) && $COURSE->id == $this->courseid) {
2197 $course = $COURSE;
2198 } else {
2199 $course = $DB->get_record('course', array('id' => $this->courseid));
2200 }
2201 $this->modinfo = get_fast_modinfo($course);
2202
7a6b7acf 2203 // get course grade tree
2204 $this->top_element = grade_category::fetch_course_tree($courseid, true);
2205
4faf5f99 2206 // collapse the categories if requested
2207 if (!empty($collapsed)) {
2208 grade_tree::category_collapse($this->top_element, $collapsed);
2209 }
2210
aea4df41 2211 // no otucomes if requested
2212 if (!empty($nooutcomes)) {
2213 grade_tree::no_outcomes($this->top_element);
2214 }
2215
4faf5f99 2216 // move category item to last position in category
7a6b7acf 2217 if ($category_grade_last) {
2218 grade_tree::category_grade_last($this->top_element);
2219 }
2220
2221 if ($fillers) {
2222 // inject fake categories == fillers
2223 grade_tree::inject_fillers($this->top_element, 0);
2224 // add colspans to categories and fillers
2225 grade_tree::inject_colspans($this->top_element);
2226 }
2227
2228 grade_tree::fill_levels($this->levels, $this->top_element, 0);
d297269d 2229
7a6b7acf 2230 }
2231
4faf5f99 2232 /**
2233 * Static recursive helper - removes items from collapsed categories
cf72e2dd 2234 *
2235 * @param array &$element The seed of the recursion
4faf5f99 2236 * @param array $collapsed array of collapsed categories
cf72e2dd 2237 *
4faf5f99 2238 * @return void
2239 */
d24832f9 2240 public function category_collapse(&$element, $collapsed) {
4faf5f99 2241 if ($element['type'] != 'category') {
2242 return;
2243 }
2244 if (empty($element['children']) or count($element['children']) < 2) {
2245 return;
2246 }
2247
384960dd 2248 if (in_array($element['object']->id, $collapsed['aggregatesonly'])) {
4faf5f99 2249 $category_item = reset($element['children']); //keep only category item
2250 $element['children'] = array(key($element['children'])=>$category_item);
2251
2252 } else {
384960dd 2253 if (in_array($element['object']->id, $collapsed['gradesonly'])) { // Remove category item
2254 reset($element['children']);
2255 $first_key = key($element['children']);
2256 unset($element['children'][$first_key]);
2257 }
2258 foreach ($element['children'] as $sortorder=>$child) { // Recurse through the element's children
4faf5f99 2259 grade_tree::category_collapse($element['children'][$sortorder], $collapsed);
2260 }
2261 }
2262 }
7a6b7acf 2263
aea4df41 2264 /**
2265 * Static recursive helper - removes all outcomes
cf72e2dd 2266 *
2267 * @param array &$element The seed of the recursion
2268 *
aea4df41 2269 * @return void
2270 */
d24832f9 2271 public function no_outcomes(&$element) {
aea4df41 2272 if ($element['type'] != 'category') {
2273 return;
2274 }
2275 foreach ($element['children'] as $sortorder=>$child) {
2276 if ($element['children'][$sortorder]['type'] == 'item'
2277 and $element['children'][$sortorder]['object']->is_outcome_item()) {
2278 unset($element['children'][$sortorder]);
2279
d4795a07 2280 } else if ($element['children'][$sortorder]['type'] == 'category') {
aea4df41 2281 grade_tree::no_outcomes($element['children'][$sortorder]);
2282 }
2283 }
2284 }
2285
7a6b7acf 2286 /**
2287 * Static recursive helper - makes the grade_item for category the last children
cf72e2dd 2288 *
2289 * @param array &$element The seed of the recursion
2290 *
7a6b7acf 2291 * @return void
2292 */
d24832f9 2293 public function category_grade_last(&$element) {
7a6b7acf 2294 if (empty($element['children'])) {
2295 return;
2296 }
2297 if (count($element['children']) < 2) {
2298 return;
2299 }
3e0e2436 2300 $first_item = reset($element['children']);
4a3dfd9a 2301 if ($first_item['type'] == 'categoryitem' or $first_item['type'] == 'courseitem') {
3e0e2436 2302 // the category item might have been already removed
2303 $order = key($element['children']);
2304 unset($element['children'][$order]);
2305 $element['children'][$order] =& $first_item;
2306 }
206f9953 2307 foreach ($element['children'] as $sortorder => $child) {
7a6b7acf 2308 grade_tree::category_grade_last($element['children'][$sortorder]);
2309 }
2310 }
2311
2312 /**
2313 * Static recursive helper - fills the levels array, useful when accessing tree elements of one level
cf72e2dd 2314 *
2315 * @param array &$levels The levels of the grade tree through which to recurse
2316 * @param array &$element The seed of the recursion
2317 * @param int $depth How deep are we?
7a6b7acf 2318 * @return void
2319 */
d24832f9 2320 public function fill_levels(&$levels, &$element, $depth) {
7a6b7acf 2321 if (!array_key_exists($depth, $levels)) {
2322 $levels[$depth] = array();
2323 }
2324
2325 // prepare unique identifier
2326 if ($element['type'] == 'category') {
ddb9c95f 2327 $element['eid'] = 'cg'.$element['object']->id;
7a6b7acf 2328 } else if (in_array($element['type'], array('item', 'courseitem', 'categoryitem'))) {
ddb9c95f 2329 $element['eid'] = 'ig'.$element['object']->id;
b89a70ce 2330 $this->items[$element['object']->id] =& $element['object'];
7a6b7acf 2331 }
2332
2333 $levels[$depth][] =& $element;
2334 $depth++;
2335 if (empty($element['children'])) {
2336 return;
2337 }
2338 $prev = 0;
2339 foreach ($element['children'] as $sortorder=>$child) {
2340 grade_tree::fill_levels($levels, $element['children'][$sortorder], $depth);
2341 $element['children'][$sortorder]['prev'] = $prev;
2342 $element['children'][$sortorder]['next'] = 0;
2343 if ($prev) {
2344 $element['children'][$prev]['next'] = $sortorder;
2345 }
2346 $prev = $sortorder;
2347 }
2348 }
2349
2350 /**
2351 * Static recursive helper - makes full tree (all leafes are at the same level)
cf72e2dd 2352 *
2353 * @param array &$element The seed of the recursion
2354 * @param int $depth How deep are we?
2355 *
2356 * @return int
7a6b7acf 2357 */
d24832f9 2358 public function inject_fillers(&$element, $depth) {
7a6b7acf 2359 $depth++;
2360
2361 if (empty($element['children'])) {
2362 return $depth;
2363 }
2364 $chdepths = array();
2365 $chids = array_keys($element['children']);
2366 $last_child = end($chids);
2367 $first_child = reset($chids);
2368
2369 foreach ($chids as $chid) {
2370 $chdepths[$chid] = grade_tree::inject_fillers($element['children'][$chid], $depth);
2371 }
2372 arsort($chdepths);
2373
2374 $maxdepth = reset($chdepths);
2375 foreach ($chdepths as $chid=>$chd) {
2376 if ($chd == $maxdepth) {
2377 continue;
2378 }
2379 for ($i=0; $i < $maxdepth-$chd; $i++) {
2380 if ($chid == $first_child) {
2381 $type = 'fillerfirst';
2382 } else if ($chid == $last_child) {
2383 $type = 'fillerlast';
2384 } else {
2385 $type = 'filler';
2386 }
2387 $oldchild =& $element['children'][$chid];
cf72e2dd 2388 $element['children'][$chid] = array('object'=>'filler', 'type'=>$type,
2389 'eid'=>'', 'depth'=>$element['object']->depth,
2390 'children'=>array($oldchild));
7a6b7acf 2391 }
2392 }
2393
2394 return $maxdepth;
2395 }
2396
2397 /**
2398 * Static recursive helper - add colspan information into categories
cf72e2dd 2399 *
2400 * @param array &$element The seed of the recursion
2401 *
2402 * @return int
7a6b7acf 2403 */
d24832f9 2404 public function inject_colspans(&$element) {
7a6b7acf 2405 if (empty($element['children'])) {
2406 return 1;
2407 }
2408 $count = 0;
2409 foreach ($element['children'] as $key=>$child) {
2410 $count += grade_tree::inject_colspans($element['children'][$key]);
2411 }
2412 $element['colspan'] = $count;
2413 return $count;
2414 }
2415
2416 /**
2417 * Parses the array in search of a given eid and returns a element object with
2418 * information about the element it has found.
cf72e2dd 2419 * @param int $eid Gradetree Element ID
7a6b7acf 2420 * @return object element
2421 */
d24832f9 2422 public function locate_element($eid) {
d3c3da1b 2423 // it is a grade - construct a new object
2424 if (strpos($eid, 'n') === 0) {
2425 if (!preg_match('/n(\d+)u(\d+)/', $eid, $matches)) {
2426 return null;
2427 }
2428
2429 $itemid = $matches[1];
2430 $userid = $matches[2];
2431
2432 //extra security check - the grade item must be in this tree
ddb9c95f 2433 if (!$item_el = $this->locate_element('ig'.$itemid)) {
d3c3da1b 2434 return null;
2435 }
2436
2437 // $gradea->id may be null - means does not exist yet
2438 $grade = new grade_grade(array('itemid'=>$itemid, 'userid'=>$userid));
2439
2440 $grade->grade_item =& $item_el['object']; // this may speedup grade_grade methods!
2441 return array('eid'=>'n'.$itemid.'u'.$userid,'object'=>$grade, 'type'=>'grade');
2442
2443 } else if (strpos($eid, 'g') === 0) {
cf72e2dd 2444 $id = (int) substr($eid, 1);
7a6b7acf 2445 if (!$grade = grade_grade::fetch(array('id'=>$id))) {
2446 return null;
2447 }
2448 //extra security check - the grade item must be in this tree
ddb9c95f 2449 if (!$item_el = $this->locate_element('ig'.$grade->itemid)) {
7a6b7acf 2450 return null;
2451 }
2452 $grade->grade_item =& $item_el['object']; // this may speedup grade_grade methods!
2453 return array('eid'=>'g'.$id,'object'=>$grade, 'type'=>'grade');
2454 }
2455
2456 // it is a category or item
2457 foreach ($this->levels as $row) {
2458 foreach ($row as $element) {
2459 if ($element['type'] == 'filler') {
2460 continue;
2461 }
2462 if ($element['eid'] == $eid) {
2463 return $element;
2464 }
2465 }
2466 }
2467
2468 return null;
2469 }
d24832f9 2470
b244b9b7 2471 /**
2472 * Returns a well-formed XML representation of the grade-tree using recursion.
cf72e2dd 2473 *
2474 * @param array $root The current element in the recursion. If null, starts at the top of the tree.
2475 * @param string $tabs The control character to use for tabs
2476 *
b244b9b7 2477 * @return string $xml
2478 */
cf72e2dd 2479 public function exporttoxml($root=null, $tabs="\t") {
b244b9b7 2480 $xml = null;
2481 $first = false;
2482 if (is_null($root)) {
2483 $root = $this->top_element;
2484 $xml = '<?xml version="1.0" encoding="UTF-8" ?>' . "\n";
2485 $xml .= "<gradetree>\n";
2486 $first = true;
2487 }
d24832f9 2488
b244b9b7 2489 $type = 'undefined';
2490 if (strpos($root['object']->table, 'grade_categories') !== false) {
2491 $type = 'category';
cf72e2dd 2492 } else if (strpos($root['object']->table, 'grade_items') !== false) {
b244b9b7 2493 $type = 'item';
cf72e2dd 2494 } else if (strpos($root['object']->table, 'grade_outcomes') !== false) {
b244b9b7 2495 $type = 'outcome';
2496 }
d24832f9 2497
b244b9b7 2498 $xml .= "$tabs<element type=\"$type\">\n";
2499 foreach ($root['object'] as $var => $value) {
2500 if (!is_object($value) && !is_array($value) && !empty($value)) {
2501 $xml .= "$tabs\t<$var>$value</$var>\n";
2502 }
2503 }
2504
2505 if (!empty($root['children'])) {
2506 $xml .= "$tabs\t<children>\n";
2507 foreach ($root['children'] as $sortorder => $child) {
2508 $xml .= $this->exportToXML($child, $tabs."\t\t");
2509 }
2510 $xml .= "$tabs\t</children>\n";
2511 }
d24832f9 2512
b244b9b7 2513 $xml .= "$tabs</element>\n";
2514
2515 if ($first) {
2516 $xml .= "</gradetree>";
2517 }
d24832f9 2518
b244b9b7 2519 return $xml;
2520 }
d24832f9 2521
b244b9b7 2522 /**
2523 * Returns a JSON representation of the grade-tree using recursion.
cf72e2dd 2524 *
b244b9b7 2525 * @param array $root The current element in the recursion. If null, starts at the top of the tree.
2526 * @param string $tabs Tab characters used to indent the string nicely for humans to enjoy
cf72e2dd 2527 *
2528 * @return string
b244b9b7 2529 */
cf72e2dd 2530 public function exporttojson($root=null, $tabs="\t") {
b244b9b7 2531 $json = null;
2532 $first = false;
2533 if (is_null($root)) {
2534 $root = $this->top_element;
2535 $first = true;
2536 }
d24832f9 2537
b244b9b7 2538 $name = '';
2539
2540
2541 if (strpos($root['object']->table, 'grade_categories') !== false) {
2542 $name = $root['object']->fullname;
2543 if ($name == '?') {
d24832f9 2544 $name = $root['object']->get_name();
b244b9b7 2545 }
cf72e2dd 2546 } else if (strpos($root['object']->table, 'grade_items') !== false) {
b244b9b7 2547 $name = $root['object']->itemname;
cf72e2dd 2548 } else if (strpos($root['object']->table, 'grade_outcomes') !== false) {
b244b9b7 2549 $name = $root['object']->itemname;
2550 }
d24832f9 2551
b244b9b7 2552 $json .= "$tabs {\n";
2553 $json .= "$tabs\t \"type\": \"{$root['type']}\",\n";
2554 $json .= "$tabs\t \"name\": \"$name\",\n";
2555
2556 foreach ($root['object'] as $var => $value) {
2557 if (!is_object($value) && !is_array($value) && !empty($value)) {
2558 $json .= "$tabs\t \"$var\": \"$value\",\n";
2559 }
2560 }
d24832f9 2561
b244b9b7 2562 $json = substr($json, 0, strrpos($json, ','));
d24832f9 2563
b244b9b7 2564 if (!empty($root['children'])) {
2565 $json .= ",\n$tabs\t\"children\": [\n";
2566 foreach ($root['children'] as $sortorder => $child) {
2567 $json .= $this->exportToJSON($child, $tabs."\t\t");
2568 }
2569 $json = substr($json, 0, strrpos($json, ','));
2570 $json .= "\n$tabs\t]\n";
d24832f9 2571 }
b244b9b7 2572
2573 if ($first) {
2574 $json .= "\n}";
2575 } else {
2576 $json .= "\n$tabs},\n";
2577 }
d24832f9 2578
b244b9b7 2579 return $json;
2580 }
d24832f9 2581
cf72e2dd 2582 /**
2583 * Returns the array of levels
2584 *
2585 * @return array
2586 */
d24832f9 2587 public function get_levels() {
2588 return $this->levels;
2589 }
2590
cf72e2dd 2591 /**
2592 * Returns the array of grade items
2593 *
2594 * @return array
2595 */
d24832f9 2596 public function get_items() {
2597 return $this->items;
2598 }
2599
cf72e2dd 2600 /**
2601 * Returns a specific Grade Item
2602 *
2603 * @param int $itemid The ID of the grade_item object
2604 *
2605 * @return grade_item
2606 */
d24832f9 2607 public function get_item($itemid) {
2608 if (array_key_exists($itemid, $this->items)) {
2609 return $this->items[$itemid];
2610 } else {
2611 return false;
2612 }
2613 }
7a6b7acf 2614}
eef00ade 2615
2616/**
2617 * Local shortcut function for creating an edit/delete button for a grade_* object.
4d27bc79 2618 * @param string $type 'edit' or 'delete'
eef00ade 2619 * @param int $courseid The Course ID
2620 * @param grade_* $object The grade_* object
2621 * @return string html
2622 */
2623function grade_button($type, $courseid, $object) {
2624 global $CFG, $OUTPUT;
2625 if (preg_match('/grade_(.*)/', get_class($object), $matches)) {
2626 $objectidstring = $matches[1] . 'id';
2627 } else {
2628 throw new coding_exception('grade_button() only accepts grade_* objects as third parameter!');
2629 }
2630
2631 $strdelete = get_string('delete');
2632 $stredit = get_string('edit');
2633
eef00ade 2634 if ($type == 'delete') {
8ae8bf8a 2635 $url = new moodle_url('index.php', array('id' => $courseid, $objectidstring => $object->id, 'action' => 'delete', 'sesskey' => sesskey()));
eef00ade 2636 } else if ($type == 'edit') {
8ae8bf8a 2637 $url = new moodle_url('edit.php', array('courseid' => $courseid, 'id' => $object->id));
eef00ade 2638 }
2639
fa9c0aab 2640 return $OUTPUT->action_icon($url, new pix_icon('t/'.$type, ${'str'.$type}, '', array('class' => 'iconsmall')));
eef00ade 2641
2642}
4d5059d4
SH
2643
2644/**
2645 * This method adds settings to the settings block for the grade system and its
2646 * plugins
2647 *
2648 * @global moodle_page $PAGE
2649 */
2650function grade_extend_settings($plugininfo, $courseid) {
2651 global $PAGE;
2652
2653 $gradenode = $PAGE->settingsnav->prepend(get_string('gradeadministration', 'grades'), null, navigation_node::TYPE_CONTAINER);
2654
2655 $strings = array_shift($plugininfo);
2656
2657 if ($reports = grade_helper::get_plugins_reports($courseid)) {
2658 foreach ($reports as $report) {
2659 $gradenode->add($report->string, $report->link, navigation_node::TYPE_SETTING, null, $report->id, new pix_icon('i/report', ''));
2660 }
2661 }
2662
eb84b779
MG
2663 if ($settings = grade_helper::get_info_manage_settings($courseid)) {
2664 $settingsnode = $gradenode->add($strings['settings'], null, navigation_node::TYPE_CONTAINER);
2665 foreach ($settings as $setting) {
2666 $settingsnode->add($setting->string, $setting->link, navigation_node::TYPE_SETTING, null, $setting->id, new pix_icon('i/settings', ''));
2667 }
2668 }
2669
4d5059d4
SH
2670 if ($imports = grade_helper::get_plugins_import($courseid)) {
2671 $importnode = $gradenode->add($strings['import'], null, navigation_node::TYPE_CONTAINER);
2672 foreach ($imports as $import) {
11f87187 2673 $importnode->add($import->string, $import->link, navigation_node::TYPE_SETTING, null, $import->id, new pix_icon('i/import', ''));
4d5059d4
SH
2674 }
2675 }
2676
2677 if ($exports = grade_helper::get_plugins_export($courseid)) {
2678 $exportnode = $gradenode->add($strings['export'], null, navigation_node::TYPE_CONTAINER);
2679 foreach ($exports as $export) {
11f87187 2680 $exportnode->add($export->string, $export->link, navigation_node::TYPE_SETTING, null, $export->id, new pix_icon('i/export', ''));
4d5059d4
SH
2681 }
2682 }
2683
4d5059d4
SH
2684 if ($letters = grade_helper::get_info_letters($courseid)) {
2685 $letters = array_shift($letters);
2686 $gradenode->add($strings['letter'], $letters->link, navigation_node::TYPE_SETTING, null, $letters->id, new pix_icon('i/settings', ''));
2687 }
2688
2689 if ($outcomes = grade_helper::get_info_outcomes($courseid)) {
2690 $outcomes = array_shift($outcomes);
2691 $gradenode->add($strings['outcome'], $outcomes->link, navigation_node::TYPE_SETTING, null, $outcomes->id, new pix_icon('i/outcomes', ''));
2692 }
2693
2694 if ($scales = grade_helper::get_info_scales($courseid)) {
2695 $gradenode->add($strings['scale'], $scales->link, navigation_node::TYPE_SETTING, null, $scales->id, new pix_icon('i/scales', ''));
2696 }
2697
4d5059d4
SH
2698 if ($gradenode->contains_active_node()) {
2699 // If the gradenode is active include the settings base node (gradeadministration) in
2700 // the navbar, typcially this is ignored.
2701 $PAGE->navbar->includesettingsbase = true;
2702
2703 // If we can get the course admin node make sure it is closed by default
2704 // as in this case the gradenode will be opened
2705 if ($coursenode = $PAGE->settingsnav->get('courseadmin', navigation_node::TYPE_COURSE)){
2706 $coursenode->make_inactive();
2707 $coursenode->forceopen = false;
2708 }
2709 }
2710}
2711
2712/**
2713 * Grade helper class
2714 *
2715 * This class provides several helpful functions that work irrespective of any
2716 * current state.
2717 *
2718 * @copyright 2010 Sam Hemelryk
2719 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2720 */
2721abstract class grade_helper {
2722 /**
2723 * Cached manage settings info {@see get_info_settings}
2724 * @var grade_plugin_info|false
2725 */
2726 protected static $managesetting = null;
2727 /**
2728 * Cached grade report plugins {@see get_plugins_reports}
2729 * @var array|false
2730 */
2731 protected static $gradereports = null;
2732 /**
2733 * Cached grade report plugins preferences {@see get_info_scales}
2734 * @var array|false
2735 */
2736 protected static $gradereportpreferences = null;
2737 /**
2738 * Cached scale info {@see get_info_scales}
2739 * @var grade_plugin_info|false
2740 */
2741 protected static $scaleinfo = null;
2742 /**
2743 * Cached outcome info {@see get_info_outcomes}
2744 * @var grade_plugin_info|false
2745 */
2746 protected static $outcomeinfo = null;
4d5059d4
SH
2747 /**
2748 * Cached leftter info {@see get_info_letters}
2749 * @var grade_plugin_info|false
2750 */
2751 protected static $letterinfo = null;
2752 /**
2753 * Cached grade import plugins {@see get_plugins_import}
2754 * @var array|false
2755 */
2756 protected static $importplugins = null;
2757 /**
2758 * Cached grade export plugins {@see get_plugins_export}
2759 * @var array|false
2760 */
2761 protected static $exportplugins = null;
2762 /**
2763 * Cached grade plugin strings
2764 * @var array
2765 */
2766 protected static $pluginstrings = null;
bfe969e8
DW
2767 /**
2768 * Cached grade aggregation strings
2769 * @var array
2770 */
2771 protected static $aggregationstrings = null;
4d5059d4
SH
2772
2773 /**
2774 * Gets strings commonly used by the describe plugins
2775 *
2776 * report => get_string('view'),
4d5059d4
SH
2777 * scale => get_string('scales'),
2778 * outcome => get_string('outcomes', 'grades'),
2779 * letter => get_string('letters', 'grades'),
2780 * export => get_string('export', 'grades'),
2781 * import => get_string('import'),
4d5059d4
SH
2782 * settings => get_string('settings')
2783 *
2784 * @return array
2785 */
2786 public static function get_plugin_strings() {
2787 if (self::$pluginstrings === null) {
2788 self::$pluginstrings = array(
2789 'report' => get_string('view'),
4d5059d4
SH
2790 'scale' => get_string('scales'),
2791 'outcome' => get_string('outcomes', 'grades'),
2792 'letter' => get_string('letters', 'grades'),
2793 'export' => get_string('export', 'grades'),
2794 'import' => get_string('import'),
eb84b779 2795 'settings' => get_string('edittree', 'grades')
4d5059d4
SH
2796 );
2797 }
2798 return self::$pluginstrings;
2799 }
bfe969e8
DW
2800
2801 /**
2802 * Gets strings describing the available aggregation methods.
2803 *
2804 * @return array
2805 */
2806 public static function get_aggregation_strings() {
2807 if (self::$aggregationstrings === null) {
2808 self::$aggregationstrings = array(
2809 GRADE_AGGREGATE_MEAN => get_string('aggregatemean', 'grades'),
2810 GRADE_AGGREGATE_WEIGHTED_MEAN => get_string('aggregateweightedmean', 'grades'),
2811 GRADE_AGGREGATE_WEIGHTED_MEAN2 => get_string('aggregateweightedmean2', 'grades'),
2812 GRADE_AGGREGATE_EXTRACREDIT_MEAN => get_string('aggregateextracreditmean', 'grades'),
2813 GRADE_AGGREGATE_MEDIAN => get_string('aggregatemedian', 'grades'),
2814 GRADE_AGGREGATE_MIN => get_string('aggregatemin', 'grades'),
2815 GRADE_AGGREGATE_MAX => get_string('aggregatemax', 'grades'),
2816 GRADE_AGGREGATE_MODE => get_string('aggregatemode', 'grades'),
2817 GRADE_AGGREGATE_SUM => get_string('aggregatesum', 'grades')
2818 );
2819 }
2820 return self::$aggregationstrings;
2821 }
2822
4d5059d4
SH
2823 /**
2824 * Get grade_plugin_info object for managing settings if the user can
2825 *
2826 * @param int $courseid
8faa560c 2827 * @return grade_plugin_info[]
4d5059d4
SH
2828 */
2829 public static function get_info_manage_settings($courseid) {
2830 if (self::$managesetting !== null) {
2831 return self::$managesetting;
2832 }
d4060472 2833 $context = context_course::instance($courseid);
8faa560c
MG
2834 self::$managesetting = array();
2835 if ($courseid != SITEID && has_capability('moodle/grade:manage', $context)) {
53914e44 2836 self::$managesetting['gradebooksetup'] = new grade_plugin_info('setup',
eb84b779 2837 new moodle_url('/grade/edit/tree/index.php', array('id' => $courseid)),
53914e44 2838 get_string('gradebooksetup', 'grades'));
8faa560c
MG
2839 self::$managesetting['coursesettings'] = new grade_plugin_info('coursesettings',
2840 new moodle_url('/grade/edit/settings/index.php', array('id'=>$courseid)),
2841 get_string('coursegradesettings', 'grades'));
eb84b779
MG
2842 }
2843 if (self::$gradereportpreferences === null) {
2844 self::get_plugins_reports($courseid);
2845 }
2846 if (self::$gradereportpreferences) {
2847 self::$managesetting = array_merge(self::$managesetting, self::$gradereportpreferences);
4d5059d4
SH
2848 }
2849 return self::$managesetting;
2850 }
2851 /**
2852 * Returns an array of plugin reports as grade_plugin_info objects
2853 *
2854 * @param int $courseid
2855 * @return array
2856 */
2857 public static function get_plugins_reports($courseid) {
f7fcf4cd 2858 global $SITE;
cf717dc2 2859
4d5059d4
SH
2860 if (self::$gradereports !== null) {
2861 return self::$gradereports;
2862 }
d4060472 2863 $context = context_course::instance($courseid);
4d5059d4
SH
2864 $gradereports = array();
2865 $gradepreferences = array();
bd3b3bba 2866 foreach (core_component::get_plugin_list('gradereport') as $plugin => $plugindir) {
f7fcf4cd
AD
2867 //some reports make no sense if we're not within a course
2868 if ($courseid==$SITE->id && ($plugin=='grader' || $plugin=='user')) {
2869 continue;
2870 }
2871
4d5059d4
SH
2872 // Remove ones we can't see
2873 if (!has_capability('gradereport/'.$plugin.':view', $context)) {
2874 continue;
2875 }
2876
4ae71e93
DP
2877 // Singleview doesn't doesn't accomodate for all cap combos yet, so this is hardcoded..
2878 if ($plugin === 'singleview' && !has_all_capabilities(array('moodle/grade:viewall',
2879 'moodle/grade:edit'), $context)) {
2880 continue;
2881 }
2882
b5e7b2bf 2883 $pluginstr = get_string('pluginname', 'gradereport_'.$plugin);
4d5059d4
SH
2884 $url = new moodle_url('/grade/report/'.$plugin.'/index.php', array('id'=>$courseid));
2885 $gradereports[$plugin] = new grade_plugin_info($plugin, $url, $pluginstr);
2886
2887 // Add link to preferences tab if such a page exists
2888 if (file_exists($plugindir.'/preferences.php')) {
2889 $url = new moodle_url('/grade/report/'.$plugin.'/preferences.php', array('id'=>$courseid));
eb84b779 2890 $gradepreferences[$plugin] = new grade_plugin_info($plugin, $url,
4887d152 2891 get_string('preferences', 'grades') . ': ' . $pluginstr);
4d5059d4
SH
2892 }
2893 }
2894 if (count($gradereports) == 0) {
2895 $gradereports = false;
2896 $gradepreferences = false;
2897 } else if (count($gradepreferences) == 0) {
2898 $gradepreferences = false;
2899 asort($gradereports);
2900 } else {
2901 asort($gradereports);
2902 asort($gradepreferences);
2903 }
2904 self::$gradereports = $gradereports;
2905 self::$gradereportpreferences = $gradepreferences;
2906 return self::$gradereports;
2907 }
eb84b779 2908
4d5059d4
SH
2909 /**
2910 * Get information on scales
2911 * @param int $courseid
2912 * @return grade_plugin_info
2913 */
2914 public static function get_info_scales($courseid) {
2915 if (self::$scaleinfo !== null) {
2916 return self::$scaleinfo;
2917 }
d4060472 2918 if (has_capability('moodle/course:managescales', context_course::instance($courseid))) {
4d5059d4
SH
2919 $url = new moodle_url('/grade/edit/scale/index.php', array('id'=>$courseid));
2920 self::$scaleinfo = new grade_plugin_info('scale', $url, get_string('view'));
2921 } else {
2922 self::$scaleinfo = false;
2923 }
2924 return self::$scaleinfo;
2925 }
2926 /**
2927 * Get information on outcomes
2928 * @param int $courseid
2929 * @return grade_plugin_info
2930 */
2931 public static function get_info_outcomes($courseid) {
f7fcf4cd 2932 global $CFG, $SITE;
4d5059d4
SH
2933
2934 if (self::$outcomeinfo !== null) {
2935 return self::$outcomeinfo;
2936 }
d4060472 2937 $context = context_course::instance($courseid);
4d5059d4
SH
2938 $canmanage = has_capability('moodle/grade:manage', $context);
2939 $canupdate = has_capability('moodle/course:update', $context);
2940 if (!empty($CFG->enableoutcomes) && ($canmanage || $canupdate)) {
2941 $outcomes = array();
2942 if ($canupdate) {
f7fcf4cd
AD
2943 if ($courseid!=$SITE->id) {
2944 $url = new moodle_url('/grade/edit/outcome/course.php', array('id'=>$courseid));
2945 $outcomes['course'] = new grade_plugin_info('course', $url, get_string('outcomescourse', 'grades'));
2946 }
4d5059d4
SH
2947 $url = new moodle_url('/grade/edit/outcome/index.php', array('id'=>$courseid));
2948 $outcomes['edit'] = new grade_plugin_info('edit', $url, get_string('editoutcomes', 'grades'));
c46aeeab
DC
2949 $url = new moodle_url('/grade/edit/outcome/import.php', array('courseid'=>$courseid));
2950 $outcomes['import'] = new grade_plugin_info('import', $url, get_string('importoutcomes', 'grades'));
4d5059d4 2951 } else {
f7fcf4cd
AD
2952 if ($courseid!=$SITE->id) {
2953 $url = new moodle_url('/grade/edit/outcome/course.php', array('id'=>$courseid));
2954 $outcomes['edit'] = new grade_plugin_info('edit', $url, get_string('outcomescourse', 'grades'));
2955 }
4d5059d4
SH
2956 }
2957 self::$outcomeinfo = $outcomes;
2958 } else {
2959 self::$outcomeinfo = false;
2960 }
2961 return self::$outcomeinfo;
2962 }
4d5059d4
SH
2963 /**
2964 * Get information on letters
2965 * @param int $courseid
4d27bc79 2966 * @return array
4d5059d4
SH
2967 */
2968 public static function get_info_letters($courseid) {
a8dfc483 2969 global $SITE;
4d5059d4
SH
2970 if (self::$letterinfo !== null) {
2971 return self::$letterinfo;
2972 }
d4060472 2973 $context = context_course::instance($courseid);
4d5059d4
SH
2974 $canmanage = has_capability('moodle/grade:manage', $context);
2975 $canmanageletters = has_capability('moodle/grade:manageletters', $context);
2976 if ($canmanage || $canmanageletters) {
a8dfc483
AA
2977 // Redirect to system context when report is accessed from admin settings MDL-31633
2978 if ($context->instanceid == $SITE->id) {
2979 $param = array('edit' => 1);
2980 } else {
2981 $param = array('edit' => 1,'id' => $context->id);
2982 }
4d5059d4 2983 self::$letterinfo = array(
54caa598 2984 'view' => new grade_plugin_info('view', new moodle_url('/grade/edit/letter/index.php', array('id'=>$context->id)), get_string('view')),
a8dfc483 2985 'edit' => new grade_plugin_info('edit', new moodle_url('/grade/edit/letter/index.php', $param), get_string('edit'))
4d5059d4
SH
2986 );
2987 } else {
2988 self::$letterinfo = false;
2989 }
2990 return self::$letterinfo;
2991 }
2992 /**
2993 * Get information import plugins
2994 * @param int $courseid
2995 * @return array
2996 */
2997 public static function get_plugins_import($courseid) {
2998 global $CFG;
2999
3000 if (self::$importplugins !== null) {
3001 return self::$importplugins;
3002 }
3003 $importplugins = array();
d4060472 3004 $context = context_course::instance($courseid);
4d5059d4
SH
3005
3006 if (has_capability('moodle/grade:import', $context)) {
bd3b3bba 3007 foreach (core_component::get_plugin_list('gradeimport') as $plugin => $plugindir) {
4d5059d4
SH
3008 if (!has_capability('gradeimport/'.$plugin.':view', $context)) {
3009 continue;
3010 }
b5e7b2bf 3011 $pluginstr = get_string('pluginname', 'gradeimport_'.$plugin);
4d5059d4
SH
3012 $url = new moodle_url('/grade/import/'.$plugin.'/index.php', array('id'=>$courseid));
3013 $importplugins[$plugin] = new grade_plugin_info($plugin, $url, $pluginstr);
3014 }
3015
ead4d41e
SL
3016 // Show key manager if grade publishing is enabled and the user has xml publishing capability.
3017 // XML is the only grade import plugin that has publishing feature.
3018 if ($CFG->gradepublishing && has_capability('gradeimport/xml:publish', $context)) {
4d5059d4
SH
3019 $url = new moodle_url('/grade/import/keymanager.php', array('id'=>$courseid));
3020 $importplugins['keymanager'] = new grade_plugin_info('keymanager', $url, get_string('keymanager', 'grades'));
3021 }
3022 }
3023
3024 if (count($importplugins) > 0) {
3025 asort($importplugins);
3026 self::$importplugins = $importplugins;
3027 } else {
3028 self::$importplugins = false;
3029 }
3030 return self::$importplugins;
3031 }
3032 /**
3033 * Get information export plugins
3034 * @param int $courseid
3035 * @return array
3036 */
3037 public static function get_plugins_export($courseid) {
3038 global $CFG;
3039
3040 if (self::$exportplugins !== null) {
3041 return self::$exportplugins;
3042 }
d4060472 3043 $context = context_course::instance($courseid);
4d5059d4 3044 $exportplugins = array();
ead4d41e 3045 $canpublishgrades = 0;
4d5059d4 3046 if (has_capability('moodle/grade:export', $context)) {
bd3b3bba 3047 foreach (core_component::get_plugin_list('gradeexport') as $plugin => $plugindir) {
4d5059d4
SH
3048 if (!has_capability('gradeexport/'.$plugin.':view', $context)) {
3049 continue;
3050 }
ead4d41e
SL
3051 // All the grade export plugins has grade publishing capabilities.
3052 if (has_capability('gradeexport/'.$plugin.':publish', $context)) {
3053 $canpublishgrades++;
3054 }
3055
b5e7b2bf 3056 $pluginstr = get_string('pluginname', 'gradeexport_'.$plugin);
4d5059d4
SH
3057 $url = new moodle_url('/grade/export/'.$plugin.'/index.php', array('id'=>$courseid));
3058 $exportplugins[$plugin] = new grade_plugin_info($plugin, $url, $pluginstr);
3059 }
3060
ead4d41e
SL
3061 // Show key manager if grade publishing is enabled and the user has at least one grade publishing capability.
3062 if ($CFG->gradepublishing && $canpublishgrades != 0) {
4d5059d4
SH
3063 $url = new moodle_url('/grade/export/keymanager.php', array('id'=>$courseid));
3064 $exportplugins['keymanager'] = new grade_plugin_info('keymanager', $url, get_string('keymanager', 'grades'));
3065 }
3066 }
3067 if (count($exportplugins) > 0) {
3068 asort($exportplugins);
3069 self::$exportplugins = $exportplugins;
3070 } else {
3071 self::$exportplugins = false;
3072 }
3073 return self::$exportplugins;
3074 }
293f42b6 3075
61c8e0d7
FM
3076 /**
3077 * Returns the value of a field from a user record
3078 *
3079 * @param stdClass $user object
3080 * @param stdClass $field object
3081 * @return string value of the field
3082 */
3083 public static function get_user_field_value($user, $field) {
3084 if (!empty($field->customid)) {
3085 $fieldname = 'customfield_' . $field->shortname;
3086 if (!empty($user->{$fieldname}) || is_numeric($user->{$fieldname})) {
3087 $fieldvalue = $user->{$fieldname};
3088 } else {
3089 $fieldvalue = $field->default;
3090 }
3091 } else {
3092 $fieldvalue = $user->{$field->shortname};
3093 }
3094 return $fieldvalue;
3095 }
3096
3097 /**
3098 * Returns an array of user profile fields to be included in export
3099 *
3100 * @param int $courseid
3101 * @param bool $includecustomfields
3102 * @return array An array of stdClass instances with customid, shortname, datatype, default and fullname fields
3103 */
3104 public static function get_user_profile_fields($courseid, $includecustomfields = false) {
3105 global $CFG, $DB;
3106
3107 // Gets the fields that have to be hidden
3108 $hiddenfields = array_map('trim', explode(',', $CFG->hiddenuserfields));
3109 $context = context_course::instance($courseid);
3110 $canseehiddenfields = has_capability('moodle/course:viewhiddenuserfields', $context);
3111 if ($canseehiddenfields) {
3112 $hiddenfields = array();
3113 }
3114
3115 $fields = array();
3116 require_once($CFG->dirroot.'/user/lib.php'); // Loads user_get_default_fields()
3117 require_once($CFG->dirroot.'/user/profile/lib.php'); // Loads constants, such as PROFILE_VISIBLE_ALL
3118 $userdefaultfields = user_get_default_fields();
3119
3120 // Sets the list of profile fields
3121 $userprofilefields = array_map('trim', explode(',', $CFG->grade_export_userprofilefields));
3122 if (!empty($userprofilefields)) {
3123 foreach ($userprofilefields as $field) {
3124 $field = trim($field);
3125 if (in_array($field, $hiddenfields) || !in_array($field, $userdefaultfields)) {
3126 continue;
3127 }
293f42b6 3128 $obj = new stdClass();
61c8e0d7 3129 $obj->customid = 0;
293f42b6 3130 $obj->shortname = $field;
61c8e0d7 3131 $obj->fullname = get_string($field);
293f42b6
CF
3132 $fields[] = $obj;
3133 }
3134 }
293f42b6 3135
61c8e0d7
FM
3136 // Sets the list of custom profile fields
3137 $customprofilefields = array_map('trim', explode(',', $CFG->grade_export_customprofilefields));
3138 if ($includecustomfields && !empty($customprofilefields)) {
3139 list($wherefields, $whereparams) = $DB->get_in_or_equal($customprofilefields);
3140 $customfields = $DB->get_records_sql("SELECT f.*
3141 FROM {user_info_field} f
3142 JOIN {user_info_category} c ON f.categoryid=c.id
3143 WHERE f.shortname $wherefields
3144 ORDER BY c.sortorder ASC, f.sortorder ASC", $whereparams);
61c8e0d7
FM
3145
3146 foreach ($customfields as $field) {
3147 // Make sure we can display this custom field
3148 if (!in_array($field->shortname, $customprofilefields)) {
3149 continue;
3150 } else if (in_array($field->shortname, $hiddenfields)) {
3151 continue;
3152 } else if ($field->visible != PROFILE_VISIBLE_ALL && !$canseehiddenfields) {
3153 continue;
3154 }
3155
3156 $obj = new stdClass();
3157 $obj->customid = $field->id;
3158 $obj->shortname = $field->shortname;
3159 $obj->fullname = format_string($field->name);
3160 $obj->datatype = $field->datatype;
3161 $obj->default = $field->defaultdata;
3162 $fields[] = $obj;
3163 }
3164 }
3165
3166 return $fields;
3167 }
e61f25a4
DW
3168
3169 /**
3170 * This helper method gets a snapshot of all the weights for a course.
3171 * It is used as a quick method to see if any wieghts have been automatically adjusted.
3172 * @param int $courseid
3173 * @return array of itemid -> aggregationcoef2
3174 */
3175 public static function fetch_all_natural_weights_for_course($courseid) {
3176 global $DB;
3177 $result = array();
3178
3179 $records = $DB->get_records('grade_items', array('courseid'=>$courseid), 'id', 'id, aggregationcoef2');
3180 foreach ($records as $record) {
3181 $result[$record->id] = $record->aggregationcoef2;
3182 }
3183 return $result;
3184 }
293f42b6 3185}
61c8e0d7 3186