2f84a3ce6fb05e3ea5e7d2c1f0019f6d1fc0d9ee
[moodle.git] / blocks / completionstatus / block_completionstatus.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
19 /**
20  * Block for displayed logged in user's course completion status
21  *
22  * @package   moodlecore
23  * @copyright 2009 Catalyst IT Ltd
24  * @author    Aaron Barnes <aaronb@catalyst.net.nz>
25  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26  */
27 require_once($CFG->libdir.'/completionlib.php');
29 /**
30  * Course completion status
31  * Displays overall, and individual criteria status for logged in user
32  */
33 class block_completionstatus extends block_base {
35     public function init() {
36         $this->title   = get_string('completionstatus', 'block_completionstatus');
37     }
39     public function get_content() {
40         global $USER, $CFG, $DB, $COURSE;
42         // If content is cached
43         if ($this->content !== NULL) {
44             return $this->content;
45         }
47         // Create empty content
48         $this->content = new stdClass;
50         // Can edit settings?
51         $can_edit = has_capability('moodle/course:update', get_context_instance(CONTEXT_COURSE, $this->page->course->id));
53         // Get course completion data
54         $info = new completion_info($this->page->course);
56         // Don't display if completion isn't enabled!
57         if (!completion_info::is_enabled_for_site()) {
58             if ($can_edit) {
59                 $this->content->text = get_string('completionnotenabledforsite', 'completion');
60             }
61             return $this->content;
63         } else if (!$info->is_enabled()) {
64             if ($can_edit) {
65                 $this->content->text = get_string('completionnotenabledforcourse', 'completion');
66             }
67             return $this->content;
68         }
70         // Load criteria to display
71         $completions = $info->get_completions($USER->id);
73         // Check if this course has any criteria
74         if (empty($completions)) {
75             if ($can_edit) {
76                 $this->content->text = get_string('nocriteriaset', 'completion');
77             }
78             return $this->content;
79         }
81         // Check this user is enroled
82         if (!$info->is_tracked_user($USER->id)) {
83             // If not enrolled, but are can view the report:
84             if (has_capability('coursereport/completion:view', get_context_instance(CONTEXT_COURSE, $COURSE->id))) {
85                 $this->content->text = '<a href="'.$CFG->wwwroot.'/course/report/completion/index.php?course='.$COURSE->id.
86                                        '">'.get_string('viewcoursereport', 'completion').'</a>';
87                 return $this->content;
88             }
90             // Otherwise, show error
91             $this->content->text = get_string('notenroled', 'completion');
92             return $this->content;
93         }
95         // Generate markup for criteria statuses
96         $shtml = '';
98         // For aggregating activity completion
99         $activities = array();
100         $activities_complete = 0;
102         // For aggregating course prerequisites
103         $prerequisites = array();
104         $prerequisites_complete = 0;
106         // Flag to set if current completion data is inconsistent with
107         // what is stored in the database
108         $pending_update = false;
110         // Loop through course criteria
111         foreach ($completions as $completion) {
113             $criteria = $completion->get_criteria();
114             $complete = $completion->is_complete();
116             if (!$pending_update && $criteria->is_pending($completion)) {
117                 $pending_update = true;
118             }
120             // Activities are a special case, so cache them and leave them till last
121             if ($criteria->criteriatype == COMPLETION_CRITERIA_TYPE_ACTIVITY) {
122                 $activities[$criteria->moduleinstance] = $complete;
124                 if ($complete) {
125                     $activities_complete++;
126                 }
128                 continue;
129             }
131             // Prerequisites are also a special case, so cache them and leave them till last
132             if ($criteria->criteriatype == COMPLETION_CRITERIA_TYPE_COURSE) {
133                 $prerequisites[$criteria->courseinstance] = $complete;
135                 if ($complete) {
136                     $prerequisites_complete++;
137                 }
139                 continue;
140             }
142             $shtml .= '<tr><td>';
143             $shtml .= $criteria->get_title();
144             $shtml .= '</td><td style="text-align: right">';
145             $shtml .= $completion->get_status();
146             $shtml .= '</td></tr>';
147         }
149         // Aggregate activities
150         if (!empty($activities)) {
152             $shtml .= '<tr><td>';
153             $shtml .= get_string('activitiescompleted', 'completion');
154             $shtml .= '</td><td style="text-align: right">';
155             $shtml .= $activities_complete.' of '.count($activities);
156             $shtml .= '</td></tr>';
157         }
159         // Aggregate prerequisites
160         if (!empty($prerequisites)) {
162             $phtml  = '<tr><td>';
163             $phtml .= get_string('prerequisitescompleted', 'completion');
164             $phtml .= '</td><td style="text-align: right">';
165             $phtml .= $prerequisites_complete.' of '.count($prerequisites);
166             $phtml .= '</td></tr>';
168             $shtml = $phtml . $shtml;
169         }
171         // Display completion status
172         $this->content->text  = '<table width="100%" style="font-size: 90%;"><tbody>';
173         $this->content->text .= '<tr><td colspan="2"><b>'.get_string('status').':</b> ';
175         // Is course complete?
176         $coursecomplete = $info->is_course_complete($USER->id);
178         // Load course completion
179         $params = array(
180             'userid' => $USER->id,
181             'course' => $COURSE->id
182         );
183         $ccompletion = new completion_completion($params);
185         // Has this user completed any criteria?
186         $criteriacomplete = $info->count_course_user_data($USER->id);
188         if ($pending_update) {
189             $this->content->text .= '<i>'.get_string('pending', 'completion').'</i>';
190         } else if ($coursecomplete) {
191             $this->content->text .= get_string('complete');
192         } else if (!$criteriacomplete && !$ccompletion->timestarted) {
193             $this->content->text .= '<i>'.get_string('notyetstarted', 'completion').'</i>';
194         } else {
195             $this->content->text .= '<i>'.get_string('inprogress','completion').'</i>';
196         }
198         $this->content->text .= '</td></tr>';
199         $this->content->text .= '<tr><td colspan="2">';
201         // Get overall aggregation method
202         $overall = $info->get_aggregation_method();
204         if ($overall == COMPLETION_AGGREGATION_ALL) {
205             $this->content->text .= get_string('criteriarequiredall', 'completion');
206         } else {
207             $this->content->text .= get_string('criteriarequiredany', 'completion');
208         }
210         $this->content->text .= ':</td></tr>';
211         $this->content->text .= '<tr><td><b>'.get_string('requiredcriteria', 'completion').'</b></td><td style="text-align: right"><b>'.get_string('status').'</b></td></tr>';
212         $this->content->text .= $shtml.'</tbody></table>';
214         // Display link to detailed view
215         $this->content->footer = '<br><a href="'.$CFG->wwwroot.'/blocks/completionstatus/details.php?course='.$COURSE->id.'">'.get_string('moredetails', 'completion').'</a>';
217         return $this->content;
218     }