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