a6837199dd3d32b70778ab0cdaf38c3e74bda05a
[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 displaying 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");
30 // Load data.
31 $id = required_param('course', PARAM_INT);
32 $userid = optional_param('user', 0, PARAM_INT);
34 // Load course.
35 $course = $DB->get_record('course', array('id' => $id), '*', MUST_EXIST);
37 // Load user.
38 if ($userid) {
39     $user = $DB->get_record('user', array('id' => $userid), '*', MUST_EXIST);
40 } else {
41     $user = $USER;
42 }
44 // Check permissions.
45 require_login();
47 if (!completion_can_view_data($user->id, $course)) {
48     print_error('cannotviewreport');
49 }
51 // Load completion data.
52 $info = new completion_info($course);
54 $returnurl = new moodle_url('/course/view.php', array('id' => $id));
56 // Don't display if completion isn't enabled.
57 if (!$info->is_enabled()) {
58     print_error('completionnotenabled', 'completion', $returnurl);
59 }
61 // Check this user is enroled.
62 if (!$info->is_tracked_user($user->id)) {
63     if ($USER->id == $user->id) {
64         print_error('notenroled', 'completion', $returnurl);
65     } else {
66         print_error('usernotenroled', 'completion', $returnurl);
67     }
68 }
70 // Display page.
72 $PAGE->set_context(context_course::instance($course->id));
74 // Print header.
75 $page = get_string('completionprogressdetails', 'block_completionstatus');
76 $title = format_string($course->fullname) . ': ' . $page;
78 $PAGE->navbar->add($page);
79 $PAGE->set_pagelayout('standard');
80 $PAGE->set_url('/blocks/completionstatus/details.php', array('course' => $course->id, 'user' => $user->id));
81 $PAGE->set_title(get_string('course') . ': ' . $course->fullname);
82 $PAGE->set_heading($title);
83 echo $OUTPUT->header();
86 // Display completion status.
87 echo html_writer::start_tag('table', array('class' => 'generalbox boxaligncenter'));
88 echo html_writer::start_tag('tbody');
90 // If not display logged in user, show user name.
91 if ($USER->id != $user->id) {
92     echo html_writer::start_tag('tr');
93     echo html_writer::start_tag('td', array('colspan' => '2'));
94     echo html_writer::tag('b', get_string('showinguser', 'completion'));
95     $url = new moodle_url('/user/view.php', array('id' => $user->id, 'course' => $course->id));
96     echo html_writer::link($url, fullname($user));
97     echo html_writer::end_tag('td');
98     echo html_writer::end_tag('tr');
99 }
101 echo html_writer::start_tag('tr');
102 echo html_writer::start_tag('td', array('colspan' => '2'));
103 echo html_writer::tag('b', get_string('status'));
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 html_writer::tag('i', get_string('notyetstarted', 'completion'));
122 } else {
123     echo html_writer::tag('i', get_string('inprogress', 'completion'));
126 echo html_writer::end_tag('td');
127 echo html_writer::end_tag('tr');
129 // Load criteria to display.
130 $completions = $info->get_completions($user->id);
132 // Check if this course has any criteria.
133 if (empty($completions)) {
134     echo html_writer::start_tag('tr');
135     echo html_writer::start_tag('td', array('colspan' => '2'));
136     echo html_writer::start_tag('br');
137     echo $OUTPUT->box(get_string('err_nocriteria', 'completion'), 'noticebox');
138     echo html_writer::end_tag('td');
139     echo html_writer::end_tag('tr');
140     echo html_writer::end_tag('tbody');
141     echo html_writer::end_tag('table');
142 } else {
143     echo html_writer::start_tag('tr');
144     echo html_writer::start_tag('td', array('colspan' => '2'));
145     echo html_writer::tag('b', get_string('required'));
147     // Get overall aggregation method.
148     $overall = $info->get_aggregation_method();
150     if ($overall == COMPLETION_AGGREGATION_ALL) {
151         echo get_string('criteriarequiredall', 'completion');
152     } else {
153         echo get_string('criteriarequiredany', 'completion');
154     }
156     echo html_writer::end_tag('td');
157     echo html_writer::end_tag('tr');
158     echo html_writer::end_tag('tbody');
159     echo html_writer::end_tag('table');
161     // Generate markup for criteria statuses.
162     echo html_writer::start_tag('table',
163             array('class' => 'generalbox logtable boxaligncenter', 'id' => 'criteriastatus', 'width' => '100%'));
164     echo html_writer::start_tag('tbody');
165     echo html_writer::start_tag('tr', array('class' => 'ccheader'));
166     echo html_writer::tag('th', get_string('criteriagroup', 'block_completionstatus'), array('class' => 'c0 header', 'scope' => 'col'));
167     echo html_writer::tag('th', get_string('criteria', 'completion'), array('class' => 'c1 header', 'scope' => 'col'));
168     echo html_writer::tag('th', get_string('requirement', 'block_completionstatus'), array('class' => 'c2 header', 'scope' => 'col'));
169     echo html_writer::tag('th', get_string('status'), array('class' => 'c3 header', 'scope' => 'col'));
170     echo html_writer::tag('th', get_string('complete'), array('class' => 'c4 header', 'scope' => 'col'));
171     echo html_writer::tag('th', get_string('completiondate', 'report_completion'), array('class' => 'c5 header', 'scope' => 'col'));
172     echo html_writer::end_tag('tr');
174     // Save row data.
175     $rows = array();
177     // Loop through course criteria.
178     foreach ($completions as $completion) {
179         $criteria = $completion->get_criteria();
181         $row = array();
182         $row['type'] = $criteria->criteriatype;
183         $row['title'] = $criteria->get_title();
184         $row['status'] = $completion->get_status();
185         $row['complete'] = $completion->is_complete();
186         $row['timecompleted'] = $completion->timecompleted;
187         $row['details'] = $criteria->get_details($completion);
188         $rows[] = $row;
189     }
191     // Print table.
192     $last_type = '';
193     $agg_type = false;
194     $oddeven = 0;
196     foreach ($rows as $row) {
198         echo html_writer::start_tag('tr', array('class' => 'r' . $oddeven));
199         // Criteria group.
200         echo html_writer::start_tag('td', array('class' => 'cell c0'));
201         if ($last_type !== $row['details']['type']) {
202             $last_type = $row['details']['type'];
203             echo $last_type;
205             // Reset agg type.
206             $agg_type = true;
207         } else {
208             // Display aggregation type.
209             if ($agg_type) {
210                 $agg = $info->get_aggregation_method($row['type']);
211                 echo '('. html_writer::start_tag('i');
212                 if ($agg == COMPLETION_AGGREGATION_ALL) {
213                     echo strtolower(get_string('all', 'completion'));
214                 } else {
215                     echo strtolower(get_string('any', 'completion'));
216                 }
218                 echo html_writer::end_tag('i') .strtolower(get_string('required')).')';
219                 $agg_type = false;
220             }
221         }
222         echo html_writer::end_tag('td');
224         // Criteria title.
225         echo html_writer::start_tag('td', array('class' => 'cell c1'));
226         echo $row['details']['criteria'];
227         echo html_writer::end_tag('td');
229         // Requirement.
230         echo html_writer::start_tag('td', array('class' => 'cell c2'));
231         echo $row['details']['requirement'];
232         echo html_writer::end_tag('td');
234         // Status.
235         echo html_writer::start_tag('td', array('class' => 'cell c3'));
236         echo $row['details']['status'];
237         echo html_writer::end_tag('td');
239         // Is complete.
240         echo html_writer::start_tag('td', array('class' => 'cell c4'));
241         echo $row['complete'] ? get_string('yes') : get_string('no');
242         echo html_writer::end_tag('td');
244         // Completion data.
245         echo html_writer::start_tag('td', array('class' => 'cell c5'));
246         if ($row['timecompleted']) {
247             echo userdate($row['timecompleted'], get_string('strftimedate', 'langconfig'));
248         } else {
249             echo '-';
250         }
251         echo html_writer::end_tag('td');
252         echo html_writer::end_tag('tr');
253         // For row striping.
254         $oddeven = $oddeven ? 0 : 1;
255     }
257     echo html_writer::end_tag('tbody');
258     echo html_writer::end_tag('table');
260 $courseurl = new moodle_url("/course/view.php", array('id' => $course->id));
261 echo html_writer::start_tag('div', array('class' => 'buttons'));
262 echo $OUTPUT->single_button($courseurl, get_string('returntocourse', 'block_completionstatus'), 'get');
263 echo html_writer::end_tag('div');
264 echo $OUTPUT->footer();