MDL-30020 blocks/completion: Some criteria do not display complete
[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($course);
51 $coursecontext   = context_course::instance($course->id);
52 $personalcontext = context_user::instance($user->id);
54 $can_view = false;
56 // Can view own report
57 if ($USER->id == $user->id) {
58     $can_view = true;
59 } else if (has_capability('moodle/user:viewuseractivitiesreport', $personalcontext)) {
60     $can_view = true;
61 } else if (has_capability('report/completion:view', $coursecontext)) {
62     $can_view = true;
63 } else if (has_capability('report/completion:view', $personalcontext)) {
64     $can_view = true;
65 }
67 if (!$can_view) {
68     print_error('cannotviewreport');
69 }
72 // Load completion data
73 $info = new completion_info($course);
75 $returnurl = new moodle_url('/course/view.php', array('id' => $id));
77 // Don't display if completion isn't enabled!
78 if (!$info->is_enabled()) {
79     print_error('completionnotenabled', 'completion', $returnurl);
80 }
82 // Check this user is enroled
83 if (!$info->is_tracked_user($user->id)) {
84     if ($USER->id == $user->id) {
85         print_error('notenroled', 'completion', $returnurl);
86     } else {
87         print_error('usernotenroled', 'completion', $returnurl);
88     }
89 }
92 ///
93 /// Display page
94 ///
95 $PAGE->set_context(context_course::instance($course->id));
97 // Print header
98 $page = get_string('completionprogressdetails', 'block_completionstatus');
99 $title = format_string($course->fullname) . ': ' . $page;
101 $PAGE->navbar->add($page);
102 $PAGE->set_pagelayout('standard');
103 $PAGE->set_url('/blocks/completionstatus/details.php', array('course' => $course->id, 'user' => $user->id));
104 $PAGE->set_title(get_string('course') . ': ' . $course->fullname);
105 $PAGE->set_heading($title);
106 echo $OUTPUT->header();
109 // Display completion status
110 echo '<table class="generalbox boxaligncenter"><tbody>';
112 // If not display logged in user, show user name
113 if ($USER->id != $user->id) {
114     echo '<tr><td colspan="2"><b>'.get_string('showinguser', 'completion').'</b>: ';
115     echo '<a href="'.$CFG->wwwroot.'/user/view.php?id='.$user->id.'&course='.$course->id.'">'.fullname($user).'</a>';
116     echo '</td></tr>';
119 echo '<tr><td colspan="2"><b>'.get_string('status').':</b> ';
121 // Is course complete?
122 $coursecomplete = $info->is_course_complete($user->id);
124 // Has this user completed any criteria?
125 $criteriacomplete = $info->count_course_user_data($user->id);
127 // Load course completion
128 $params = array(
129     'userid' => $user->id,
130     'course' => $course->id,
131 );
132 $ccompletion = new completion_completion($params);
134 if ($coursecomplete) {
135     echo get_string('complete');
136 } else if (!$criteriacomplete && !$ccompletion->timestarted) {
137     echo '<i>'.get_string('notyetstarted', 'completion').'</i>';
138 } else {
139     echo '<i>'.get_string('inprogress','completion').'</i>';
142 echo '</td></tr>';
144 // Load criteria to display
145 $completions = $info->get_completions($user->id);
147 // Check if this course has any criteria
148 if (empty($completions)) {
149     echo '<tr><td colspan="2"><br />';
150     echo $OUTPUT->box(get_string('err_nocriteria', 'completion'), 'noticebox');
151     echo '</td></tr></tbody></table>';
152 } else {
153     echo '<tr><td colspan="2"><b>'.get_string('required').':</b> ';
155     // Get overall aggregation method
156     $overall = $info->get_aggregation_method();
158     if ($overall == COMPLETION_AGGREGATION_ALL) {
159         echo get_string('criteriarequiredall', 'completion');
160     } else {
161         echo get_string('criteriarequiredany', 'completion');
162     }
164     echo '</td></tr></tbody></table>';
166     // Generate markup for criteria statuses
167     echo '<table class="generalbox logtable boxaligncenter" id="criteriastatus" width="100%"><tbody>';
168     echo '<tr class="ccheader">';
169     echo '<th class="c0 header" scope="col">'.get_string('criteriagroup', 'block_completionstatus').'</th>';
170     echo '<th class="c1 header" scope="col">'.get_string('criteria', 'completion').'</th>';
171     echo '<th class="c2 header" scope="col">'.get_string('requirement', 'block_completionstatus').'</th>';
172     echo '<th class="c3 header" scope="col">'.get_string('status').'</th>';
173     echo '<th class="c4 header" scope="col">'.get_string('complete').'</th>';
174     echo '<th class="c5 header" scope="col">'.get_string('completiondate', 'report_completion').'</th>';
175     echo '</tr>';
177     // Save row data
178     $rows = array();
180     // Loop through course criteria
181     foreach ($completions as $completion) {
182         $criteria = $completion->get_criteria();
184         $row = array();
185         $row['type'] = $criteria->criteriatype;
186         $row['title'] = $criteria->get_title();
187         $row['status'] = $completion->get_status();
188         $row['complete'] = $completion->is_complete();
189         $row['timecompleted'] = $completion->timecompleted;
190         $row['details'] = $criteria->get_details($completion);
191         $rows[] = $row;
192     }
194     // Print table
195     $last_type = '';
196     $agg_type = false;
197     $oddeven = 0;
199     foreach ($rows as $row) {
201         echo '<tr class="r' . $oddeven . '">';
203         // Criteria group
204         echo '<td class="cell c0">';
205         if ($last_type !== $row['details']['type']) {
206             $last_type = $row['details']['type'];
207             echo $last_type;
209             // Reset agg type
210             $agg_type = true;
211         } else {
212             // Display aggregation type
213             if ($agg_type) {
214                 $agg = $info->get_aggregation_method($row['type']);
216                 echo '(<i>';
218                 if ($agg == COMPLETION_AGGREGATION_ALL) {
219                     echo strtolower(get_string('aggregateall', 'completion'));
220                 } else {
221                     echo strtolower(get_string('aggregateany', 'completion'));
222                 }
224                 echo '</i> '.strtolower(get_string('required')).')';
225                 $agg_type = false;
226             }
227         }
228         echo '</td>';
230         // Criteria title
231         echo '<td class="cell c1">';
232         echo $row['details']['criteria'];
233         echo '</td>';
235         // Requirement
236         echo '<td class="cell c2">';
237         echo $row['details']['requirement'];
238         echo '</td>';
240         // Status
241         echo '<td class="cell c3">';
242         echo $row['details']['status'];
243         echo '</td>';
245         // Is complete
246         echo '<td class="cell c4">';
247         echo $row['complete'] ? get_string('yes') : get_string('no');
248         echo '</td>';
250         // Completion data
251         echo '<td class="cell c5">';
252         if ($row['timecompleted']) {
253             echo userdate($row['timecompleted'], get_string('strftimedate', 'langconfig'));
254         } else {
255             echo '-';
256         }
257         echo '</td>';
258         echo '</tr>';
259         // for row striping
260         $oddeven = $oddeven ? 0 : 1;
261     }
263     echo '</tbody></table>';
266 echo '<div class="buttons">';
267 $courseurl = new moodle_url("/course/view.php", array('id' => $course->id));
268 echo $OUTPUT->single_button($courseurl, get_string('returntocourse', 'block_completionstatus'), 'get');
269 echo '</div>';
271 echo $OUTPUT->footer();