MDL-30975 Docs Documenting report/logs
[moodle.git] / report / log / 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  * Public API of the log report.
19  *
20  * Defines the APIs used by log reports
21  * 
22  * @package    report
23  * @subpackage log
24  * @copyright  1999 onwards Martin Dougiamas (http://dougiamas.com)
25  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26  */
28 defined('MOODLE_INTERNAL') || die;
30 /**
31  * This function extends the navigation with the report items
32  *
33  * @param navigation_node $navigation The navigation node to extend
34  * @param stdClass $course The course to object for the report
35  * @param stdClass $context The context of the course
36  */
37 function report_log_extend_navigation_course($navigation, $course, $context) {
38     if (has_capability('report/log:view', $context)) {
39         $url = new moodle_url('/report/log/index.php', array('id'=>$course->id));
40         $navigation->add(get_string('pluginname', 'report_log'), $url, navigation_node::TYPE_SETTING, null, null, new pix_icon('i/report', ''));
41     }
42 }
44 /**
45  * This function extends the course navigation with the report items
46  *
47  * @param navigation_node $navigation The navigation node to extend
48  * @param stdClass $user
49  * @param stdClass $course The course to object for the report
50  */
51 function report_log_extend_navigation_user($navigation, $user, $course) {
52     list($all, $today) = report_log_can_access_user_report($user, $course);
54     if ($today) {
55         $url = new moodle_url('/report/log/user.php', array('id'=>$user->id, 'course'=>$course->id, 'mode'=>'today'));
56         $navigation->add(get_string('todaylogs'), $url);
57     }
58     if ($all) {
59         $url = new moodle_url('/report/log/user.php', array('id'=>$user->id, 'course'=>$course->id, 'mode'=>'all'));
60         $navigation->add(get_string('alllogs'), $url);
61     }
62 }
64 /**
65  * Is current user allowed to access this report
66  *
67  * @private defined in lib.php for performance reasons
68  *
69  * @param stdClass $user
70  * @param stdClass $course
71  * @return array with two elements $all, $today
72  */
73 function report_log_can_access_user_report($user, $course) {
74     global $USER;
76     $coursecontext = context_course::instance($course->id);
77     $personalcontext = context_user::instance($user->id);
79     $today = false;
80     $all = false;
82     if (has_capability('report/log:view', $coursecontext)) {
83         $today = true;
84     }
85     if (has_capability('report/log:viewtoday', $coursecontext)) {
86         $all = true;;
87     }
89     if ($today and $all) {
90         return array(true, true);
91     }
93     if (has_capability('moodle/user:viewuseractivitiesreport', $personalcontext)) {
94         if ($course->showreports and (is_viewing($coursecontext, $user) or is_enrolled($coursecontext, $user))) {
95             return array(true, true);
96         }
98     } else if ($user->id == $USER->id) {
99         if ($course->showreports and (is_viewing($coursecontext, $USER) or is_enrolled($coursecontext, $USER))) {
100             return array(true, true);
101         }
102     }
104     return array($all, $today);
107 /**
108  * This function extends the module navigation with the report items
109  *
110  * @param navigation_node $navigation The navigation node to extend
111  * @param stdClass $cm
112  */
113 function report_log_extend_navigation_module($navigation, $cm) {
114     if (has_capability('report/log:view', context_course::instance($cm->course))) {
115         $url = new moodle_url('/report/log/index.php', array('chooselog'=>'1','id'=>$cm->course,'modid'=>$cm->id));
116         $navigation->add(get_string('logs'), $url, navigation_node::TYPE_SETTING, null, 'logreport');
117     }
120 /**
121  * Return a list of page types
122  * @param string $pagetype current page type
123  * @param stdClass $parentcontext Block's parent context
124  * @param stdClass $currentcontext Current context of block
125  * @return array a list of page types
126  */
127 function report_log_page_type_list($pagetype, $parentcontext, $currentcontext) {
128     $array = array(
129         '*'                => get_string('page-x', 'pagetype'),
130         'report-*'         => get_string('page-report-x', 'pagetype'),
131         'report-log-*'     => get_string('page-report-log-x',  'report_log'),
132         'report-log-index' => get_string('page-report-log-index',  'report_log'),
133         'report-log-user'  => get_string('page-report-log-user',  'report_log')
134     );
135     return $array;