92a1a010ab2d464df4924df2d3860e5c4398dbee
[moodle.git] / blocks / completionstatus / details.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  * Block for displayed logged in user's course completion status
19  *
20  * @package    block
21  * @subpackage completion
22  * @copyright  2009-2012 Catalyst IT Ltd
23  * @author     Aaron Barnes <aaronb@catalyst.net.nz>
24  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
27 require_once(dirname(__FILE__).'/../../config.php');
28 require_once("{$CFG->libdir}/completionlib.php");
31 ///
32 /// Load data
33 ///
34 $id = required_param('course', PARAM_INT);
35 $userid = optional_param('user', 0, PARAM_INT);
37 // Load course
38 $course = $DB->get_record('course', array('id' => $id), '*', MUST_EXIST);
40 // Load user
41 if ($userid) {
42     $user = $DB->get_record('user', array('id' => $userid), '*', MUST_EXIST);
43 } else {
44     $user = $USER;
45 }
48 // Check permissions
49 require_login();
51 if (!completion_can_view_data($user->id, $course)) {
52     print_error('cannotviewreport');
53 }
56 // Load completion data
57 $info = new completion_info($course);
59 $returnurl = new moodle_url('/course/view.php', array('id' => $id));
61 // Don't display if completion isn't enabled!
62 if (!$info->is_enabled()) {
63     print_error('completionnotenabled', 'completion', $returnurl);
64 }
66 // Check this user is enroled
67 if (!$info->is_tracked_user($user->id)) {
68     if ($USER->id == $user->id) {
69         print_error('notenroled', 'completion', $returnurl);
70     } else {
71         print_error('usernotenroled', 'completion', $returnurl);
72     }
73 }
76 ///
77 /// Display page
78 ///
79 $PAGE->set_context(context_course::instance($course->id));
81 // Print header
82 $page = get_string('completionprogressdetails', 'block_completionstatus');
83 $title = format_string($course->fullname) . ': ' . $page;
85 $PAGE->navbar->add($page);
86 $PAGE->set_pagelayout('standard');
87 $PAGE->set_url('/blocks/completionstatus/details.php', array('course' => $course->id, 'user' => $user->id));
88 $PAGE->set_title(get_string('course') . ': ' . $course->fullname);
89 $PAGE->set_heading($title);
90 echo $OUTPUT->header();
93 // Display completion status
94 echo '<table class="generaltable boxaligncenter"><tbody>';
96 // If not display logged in user, show user name
97 if ($USER->id != $user->id) {
98     echo '<tr><td colspan="2"><b>'.get_string('showinguser', 'completion').'</b>: ';
99     echo '<a href="'.$CFG->wwwroot.'/user/view.php?id='.$user->id.'&course='.$course->id.'">'.fullname($user).'</a>';
100     echo '</td></tr>';
103 echo '<tr><td colspan="2"><b>'.get_string('status').':</b> ';
105 // Is course complete?
106 $coursecomplete = $info->is_course_complete($user->id);
108 // Has this user completed any criteria?
109 $criteriacomplete = $info->count_course_user_data($user->id);
111 // Load course completion
112 $params = array(
113     'userid' => $user->id,
114     'course' => $course->id,
115 );
116 $ccompletion = new completion_completion($params);
118 if ($coursecomplete) {
119     echo get_string('complete');
120 } else if (!$criteriacomplete && !$ccompletion->timestarted) {
121     echo '<i>'.get_string('notyetstarted', 'completion').'</i>';
122 } else {
123     echo '<i>'.get_string('inprogress','completion').'</i>';
126 echo '</td></tr>';
128 // Load criteria to display
129 $completions = $info->get_completions($user->id);
131 // Check if this course has any criteria
132 if (empty($completions)) {
133     echo '<tr><td colspan="2"><br />';
134     echo $OUTPUT->box(get_string('err_nocriteria', 'completion'), 'noticebox');
135     echo '</td></tr></tbody></table>';
136 } else {
137     echo '<tr><td colspan="2"><b>'.get_string('required').':</b> ';
139     // Get overall aggregation method
140     $overall = $info->get_aggregation_method();
142     if ($overall == COMPLETION_AGGREGATION_ALL) {
143         echo get_string('criteriarequiredall', 'completion');
144     } else {
145         echo get_string('criteriarequiredany', 'completion');
146     }
148     echo '</td></tr></tbody></table>';
150     // Generate markup for criteria statuses
151     echo '<table class="generaltable logtable boxaligncenter" id="criteriastatus" width="100%"><tbody>';
152     echo '<tr class="ccheader">';
153     echo '<th class="c0 header" scope="col">'.get_string('criteriagroup', 'block_completionstatus').'</th>';
154     echo '<th class="c1 header" scope="col">'.get_string('criteria', 'completion').'</th>';
155     echo '<th class="c2 header" scope="col">'.get_string('requirement', 'block_completionstatus').'</th>';
156     echo '<th class="c3 header" scope="col">'.get_string('status').'</th>';
157     echo '<th class="c4 header" scope="col">'.get_string('complete').'</th>';
158     echo '<th class="c5 header" scope="col">'.get_string('completiondate', 'report_completion').'</th>';
159     echo '</tr>';
161     // Save row data
162     $rows = array();
164     // Loop through course criteria
165     foreach ($completions as $completion) {
166         $criteria = $completion->get_criteria();
168         $row = array();
169         $row['type'] = $criteria->criteriatype;
170         $row['title'] = $criteria->get_title();
171         $row['status'] = $completion->get_status();
172         $row['complete'] = $completion->is_complete();
173         $row['timecompleted'] = $completion->timecompleted;
174         $row['details'] = $criteria->get_details($completion);
175         $rows[] = $row;
176     }
178     // Print table
179     $last_type = '';
180     $agg_type = false;
181     $oddeven = 0;
183     foreach ($rows as $row) {
185         echo '<tr class="r' . $oddeven . '">';
187         // Criteria group
188         echo '<td class="cell c0">';
189         if ($last_type !== $row['details']['type']) {
190             $last_type = $row['details']['type'];
191             echo $last_type;
193             // Reset agg type
194             $agg_type = true;
195         } else {
196             // Display aggregation type
197             if ($agg_type) {
198                 $agg = $info->get_aggregation_method($row['type']);
200                 echo '(<i>';
202                 if ($agg == COMPLETION_AGGREGATION_ALL) {
203                     echo strtolower(get_string('all', 'completion'));
204                 } else {
205                     echo strtolower(get_string('any', 'completion'));
206                 }
208                 echo '</i> '.strtolower(get_string('required')).')';
209                 $agg_type = false;
210             }
211         }
212         echo '</td>';
214         // Criteria title
215         echo '<td class="cell c1">';
216         echo $row['details']['criteria'];
217         echo '</td>';
219         // Requirement
220         echo '<td class="cell c2">';
221         echo $row['details']['requirement'];
222         echo '</td>';
224         // Status
225         echo '<td class="cell c3">';
226         echo $row['details']['status'];
227         echo '</td>';
229         // Is complete
230         echo '<td class="cell c4">';
231         echo $row['complete'] ? get_string('yes') : get_string('no');
232         echo '</td>';
234         // Completion data
235         echo '<td class="cell c5">';
236         if ($row['timecompleted']) {
237             echo userdate($row['timecompleted'], get_string('strftimedate', 'langconfig'));
238         } else {
239             echo '-';
240         }
241         echo '</td>';
242         echo '</tr>';
243         // for row striping
244         $oddeven = $oddeven ? 0 : 1;
245     }
247     echo '</tbody></table>';
250 echo '<div class="buttons">';
251 $courseurl = new moodle_url("/course/view.php", array('id' => $course->id));
252 echo $OUTPUT->single_button($courseurl, get_string('returntocourse', 'block_completionstatus'), 'get');
253 echo '</div>';
255 echo $OUTPUT->footer();