3 // This file is part of Moodle - http://moodle.org/
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.
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.
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 * Toggles the manual completion flag for a particular activity or course completion
20 * and the current user.
22 * If by student params: course=2
23 * If by manager params: course=2&user=4&rolec=3&sesskey=ghfgsdf
25 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
29 require_once('../config.php');
30 require_once($CFG->libdir
.'/completionlib.php');
33 $cmid = optional_param('id', 0, PARAM_INT
);
34 $courseid = optional_param('course', 0, PARAM_INT
);
35 $confirm = optional_param('confirm', 0, PARAM_BOOL
);
37 // Check if we are marking a user complete via the completion report.
38 $user = optional_param('user', 0, PARAM_INT
);
39 $rolec = optional_param('rolec', 0, PARAM_INT
);
41 if (!$cmid && !$courseid) {
42 print_error('invalidarguments');
45 // Process self completion
47 $PAGE->set_url(new moodle_url('/course/togglecompletion.php', array('course'=>$courseid)));
49 // Check user is logged in
50 $course = $DB->get_record('course', array('id' => $courseid), '*', MUST_EXIST
);
51 $context = context_course
::instance($course->id
);
52 require_login($course);
54 $completion = new completion_info($course);
55 $trackeduser = ($user ?
$user : $USER->id
);
57 if (!$completion->is_enabled()) {
58 throw new moodle_exception('completionnotenabled', 'completion');
59 } else if (!$completion->is_tracked_user($trackeduser)) {
60 throw new moodle_exception('nottracked', 'completion');
63 if ($user && $rolec) {
66 completion_criteria
::factory(array('id'=>$rolec, 'criteriatype'=>COMPLETION_CRITERIA_TYPE_ROLE
)); //TODO: this is dumb, because it does not fetch the data?!?!
67 $criteria = completion_criteria_role
::fetch(array('id'=>$rolec));
69 if ($criteria and user_has_role_assignment($USER->id
, $criteria->role
, $context->id
)) {
70 $criteria_completions = $completion->get_completions($user, COMPLETION_CRITERIA_TYPE_ROLE
);
72 foreach ($criteria_completions as $criteria_completion) {
73 if ($criteria_completion->criteriaid
== $rolec) {
74 $criteria->complete($criteria_completion);
80 // Return to previous page
81 if (!empty($_SERVER['HTTP_REFERER'])) {
82 redirect($_SERVER['HTTP_REFERER']);
84 redirect('view.php?id='.$course->id
);
90 if ($confirm and confirm_sesskey()) {
91 $completion = $completion->get_completion($USER->id
, COMPLETION_CRITERIA_TYPE_SELF
);
94 print_error('noselfcompletioncriteria', 'completion');
97 // Check if the user has already marked themselves as complete
98 if ($completion->is_complete()) {
99 print_error('useralreadymarkedcomplete', 'completion');
102 $completion->mark_complete();
104 redirect($CFG->wwwroot
.'/course/view.php?id='.$courseid);
108 $strconfirm = get_string('confirmselfcompletion', 'completion');
109 $PAGE->set_title($strconfirm);
110 $PAGE->set_heading($course->fullname
);
111 $PAGE->navbar
->add($strconfirm);
112 echo $OUTPUT->header();
113 $buttoncontinue = new single_button(new moodle_url('/course/togglecompletion.php', array('course'=>$courseid, 'confirm'=>1, 'sesskey'=>sesskey())), get_string('yes'), 'post');
114 $buttoncancel = new single_button(new moodle_url('/course/view.php', array('id'=>$courseid)), get_string('no'), 'get');
115 echo $OUTPUT->confirm($strconfirm, $buttoncontinue, $buttoncancel);
116 echo $OUTPUT->footer();
122 $targetstate = required_param('completionstate', PARAM_INT
);
123 $fromajax = optional_param('fromajax', 0, PARAM_INT
);
125 $PAGE->set_url('/course/togglecompletion.php', array('id'=>$cmid, 'completionstate'=>$targetstate));
127 switch($targetstate) {
128 case COMPLETION_COMPLETE
:
129 case COMPLETION_INCOMPLETE
:
132 print_error('unsupportedstate');
135 // Get course-modules entry
136 $cm = get_coursemodule_from_id(null, $cmid, null, true, MUST_EXIST
);
137 $course = $DB->get_record('course', array('id'=>$cm->course
), '*', MUST_EXIST
);
139 // Check user is logged in
140 require_login($course, false, $cm);
142 if (isguestuser() or !confirm_sesskey()) {
143 print_error('error');
146 // Set up completion object and check it is enabled.
147 $completion = new completion_info($course);
148 if (!$completion->is_enabled()) {
149 throw new moodle_exception('completionnotenabled', 'completion');
152 // NOTE: All users are allowed to toggle their completion state, including
153 // users for whom completion information is not directly tracked. (I.e. even
154 // if you are a teacher, or admin who is not enrolled, you can still toggle
155 // your own completion state. You just don't appear on the reports.)
157 // Check completion state is manual
158 if($cm->completion
!= COMPLETION_TRACKING_MANUAL
) {
159 error_or_ajax('cannotmanualctrack', $fromajax);
162 $completion->update_state($cm, $targetstate);
164 // And redirect back to course
168 // In case of use in other areas of code we allow a 'backto' parameter,
169 // otherwise go back to course page
171 if ($backto = optional_param('backto', null, PARAM_URL
)) {
174 redirect(course_get_url($course, $cm->sectionnum
));
180 function error_or_ajax($message, $fromajax) {
182 print get_string($message, 'error');
185 print_error($message);