2 // This file is part of Moodle - http://moodle.org/
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.
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.
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/>.
18 * Completion external API
20 * @package core_completion
22 * @copyright 2015 Juan Leyva <juan@moodle.com>
23 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
27 defined('MOODLE_INTERNAL') ||
die;
29 require_once("$CFG->libdir/externallib.php");
30 require_once("$CFG->libdir/completionlib.php");
33 * Completion external functions
35 * @package core_completion
37 * @copyright 2015 Juan Leyva <juan@moodle.com>
38 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
41 class core_completion_external
extends external_api
{
44 * Describes the parameters for update_activity_completion_status_manually.
46 * @return external_function_parameters
49 public static function update_activity_completion_status_manually_parameters() {
50 return new external_function_parameters (
52 'cmid' => new external_value(PARAM_INT
, 'course module id'),
53 'completed' => new external_value(PARAM_BOOL
, 'activity completed or not'),
59 * Update completion status for the current user in an activity, only for activities with manual tracking.
60 * @param int $cmid Course module id
61 * @param bool $completed Activity completed or not
62 * @return array Result and possible warnings
64 * @throws moodle_exception
66 public static function update_activity_completion_status_manually($cmid, $completed) {
68 // Validate and normalize parameters.
69 $params = self
::validate_parameters(self
::update_activity_completion_status_manually_parameters(),
70 array('cmid' => $cmid, 'completed' => $completed));
71 $cmid = $params['cmid'];
72 $completed = $params['completed'];
76 $context = context_module
::instance($cmid);
77 self
::validate_context($context);
79 list($course, $cm) = get_course_and_cm_from_cmid($cmid);
81 // Set up completion object and check it is enabled.
82 $completion = new completion_info($course);
83 if (!$completion->is_enabled()) {
84 throw new moodle_exception('completionnotenabled', 'completion');
87 // Check completion state is manual.
88 if ($cm->completion
!= COMPLETION_TRACKING_MANUAL
) {
89 throw new moodle_exception('cannotmanualctrack', 'error');
92 $targetstate = ($completed) ? COMPLETION_COMPLETE
: COMPLETION_INCOMPLETE
;
93 $completion->update_state($cm, $targetstate);
96 $result['status'] = true;
97 $result['warnings'] = $warnings;
102 * Describes the update_activity_completion_status_manually return value.
104 * @return external_single_structure
107 public static function update_activity_completion_status_manually_returns() {
109 return new external_single_structure(
111 'status' => new external_value(PARAM_BOOL
, 'status, true if success'),
112 'warnings' => new external_warnings(),
118 * Describes the parameters for override_activity_completion_status.
120 * @return external_external_function_parameters
123 public static function override_activity_completion_status_parameters() {
124 return new external_function_parameters (
126 'userid' => new external_value(PARAM_INT
, 'user id'),
127 'cmid' => new external_value(PARAM_INT
, 'course module id'),
128 'newstate' => new external_value(PARAM_INT
, 'the new activity completion state'),
134 * Update completion status for a user in an activity.
135 * @param int $userid User id
136 * @param int $cmid Course module id
137 * @param int $newstate Activity completion
138 * @return array Array containing the current (updated) completion status.
140 * @throws moodle_exception
142 public static function override_activity_completion_status($userid, $cmid, $newstate) {
143 // Validate and normalize parameters.
144 $params = self
::validate_parameters(self
::override_activity_completion_status_parameters(),
145 array('userid' => $userid, 'cmid' => $cmid, 'newstate' => $newstate));
146 $userid = $params['userid'];
147 $cmid = $params['cmid'];
148 $newstate = $params['newstate'];
150 $context = context_module
::instance($cmid);
151 self
::validate_context($context);
153 list($course, $cm) = get_course_and_cm_from_cmid($cmid);
155 // Set up completion object and check it is enabled.
156 $completion = new completion_info($course);
157 if (!$completion->is_enabled()) {
158 throw new moodle_exception('completionnotenabled', 'completion');
161 // Update completion state and get the new state back.
162 $completion->update_state($cm, $newstate, $userid, true);
163 $completiondata = $completion->get_data($cm, false, $userid);
165 // Return the current state of completion.
167 'cmid' => $completiondata->coursemoduleid
,
168 'userid' => $completiondata->userid
,
169 'state' => $completiondata->completionstate
,
170 'timecompleted' => $completiondata->timemodified
,
171 'overrideby' => $completiondata->overrideby
,
172 'tracking' => $completion->is_enabled($cm)
177 * Describes the override_activity_completion_status return value.
179 * @return external_single_structure
182 public static function override_activity_completion_status_returns() {
184 return new external_single_structure(
186 'cmid' => new external_value(PARAM_INT
, 'The course module id'),
187 'userid' => new external_value(PARAM_INT
, 'The user id to which the completion info belongs'),
188 'state' => new external_value(PARAM_INT
, 'The current completion state.'),
189 'timecompleted' => new external_value(PARAM_INT
, 'time of completion'),
190 'overrideby' => new external_value(PARAM_INT
, 'The user id who has overriden the status, or null'),
191 'tracking' => new external_value(PARAM_INT
, 'type of tracking:
192 0 means none, 1 manual, 2 automatic'),
198 * Returns description of method parameters
200 * @return external_function_parameters
203 public static function get_activities_completion_status_parameters() {
204 return new external_function_parameters(
206 'courseid' => new external_value(PARAM_INT
, 'Course ID'),
207 'userid' => new external_value(PARAM_INT
, 'User ID'),
213 * Get Activities completion status
215 * @param int $courseid ID of the Course
216 * @param int $userid ID of the User
217 * @return array of activities progress and warnings
218 * @throws moodle_exception
220 * @throws moodle_exception
222 public static function get_activities_completion_status($courseid, $userid) {
224 require_once($CFG->libdir
. '/grouplib.php');
227 $arrayparams = array(
228 'courseid' => $courseid,
232 $params = self
::validate_parameters(self
::get_activities_completion_status_parameters(), $arrayparams);
234 $course = get_course($params['courseid']);
235 $user = core_user
::get_user($params['userid'], '*', MUST_EXIST
);
236 core_user
::require_active_user($user);
238 $context = context_course
::instance($course->id
);
239 self
::validate_context($context);
241 // Check that current user have permissions to see this user's activities.
242 if ($user->id
!= $USER->id
) {
243 require_capability('report/progress:view', $context);
244 if (!groups_user_groups_visible($course, $user->id
)) {
245 // We are not in the same group!
246 throw new moodle_exception('accessdenied', 'admin');
250 $completion = new completion_info($course);
251 $activities = $completion->get_activities();
254 foreach ($activities as $activity) {
256 // Check if current user has visibility on this activity.
257 if (!$activity->uservisible
) {
261 // Get progress information and state (we must use get_data because it works for all user roles in course).
262 $activitycompletiondata = $completion->get_data($activity, true, $user->id
);
265 'cmid' => $activity->id
,
266 'modname' => $activity->modname
,
267 'instance' => $activity->instance
,
268 'state' => $activitycompletiondata->completionstate
,
269 'timecompleted' => $activitycompletiondata->timemodified
,
270 'tracking' => $activity->completion
,
271 'overrideby' => $activitycompletiondata->overrideby
276 'statuses' => $results,
277 'warnings' => $warnings
283 * Returns description of method result value
285 * @return external_description
288 public static function get_activities_completion_status_returns() {
289 return new external_single_structure(
291 'statuses' => new external_multiple_structure(
292 new external_single_structure(
294 'cmid' => new external_value(PARAM_INT
, 'comment ID'),
295 'modname' => new external_value(PARAM_PLUGIN
, 'activity module name'),
296 'instance' => new external_value(PARAM_INT
, 'instance ID'),
297 'state' => new external_value(PARAM_INT
, 'completion state value:
298 0 means incomplete, 1 complete,
299 2 complete pass, 3 complete fail'),
300 'timecompleted' => new external_value(PARAM_INT
, 'timestamp for completed activity'),
301 'tracking' => new external_value(PARAM_INT
, 'type of tracking:
302 0 means none, 1 manual, 2 automatic'),
303 'overrideby' => new external_value(PARAM_INT
, 'The user id who has overriden the status, or null',
306 ), 'List of activities status'
308 'warnings' => new external_warnings()
314 * Returns description of method parameters
316 * @return external_function_parameters
319 public static function get_course_completion_status_parameters() {
320 return new external_function_parameters(
322 'courseid' => new external_value(PARAM_INT
, 'Course ID'),
323 'userid' => new external_value(PARAM_INT
, 'User ID'),
328 * Get Course completion status
330 * @param int $courseid ID of the Course
331 * @param int $userid ID of the User
332 * @return array of course completion status and warnings
334 * @throws moodle_exception
336 public static function get_course_completion_status($courseid, $userid) {
338 require_once($CFG->libdir
. '/grouplib.php');
341 $arrayparams = array(
342 'courseid' => $courseid,
345 $params = self
::validate_parameters(self
::get_course_completion_status_parameters(), $arrayparams);
347 $course = get_course($params['courseid']);
348 $user = core_user
::get_user($params['userid'], '*', MUST_EXIST
);
349 core_user
::require_active_user($user);
351 $context = context_course
::instance($course->id
);
352 self
::validate_context($context);
354 // Can current user see user's course completion status?
355 // This check verifies if completion is enabled because $course is mandatory.
356 if (!completion_can_view_data($user->id
, $course)) {
357 throw new moodle_exception('cannotviewreport');
360 // The previous function doesn't check groups.
361 if ($user->id
!= $USER->id
) {
362 if (!groups_user_groups_visible($course, $user->id
)) {
363 // We are not in the same group!
364 throw new moodle_exception('accessdenied', 'admin');
368 $info = new completion_info($course);
370 // Check this user is enroled.
371 if (!$info->is_tracked_user($user->id
)) {
372 if ($USER->id
== $user->id
) {
373 throw new moodle_exception('notenroled', 'completion');
375 throw new moodle_exception('usernotenroled', 'completion');
379 $completions = $info->get_completions($user->id
);
380 if (empty($completions)) {
381 throw new moodle_exception('nocriteriaset', 'completion');
384 // Load course completion.
385 $completionparams = array(
386 'userid' => $user->id
,
387 'course' => $course->id
,
389 $ccompletion = new completion_completion($completionparams);
391 $completionrows = array();
392 // Loop through course criteria.
393 foreach ($completions as $completion) {
394 $criteria = $completion->get_criteria();
396 $completionrow = array();
397 $completionrow['type'] = $criteria->criteriatype
;
398 $completionrow['title'] = $criteria->get_title();
399 $completionrow['status'] = $completion->get_status();
400 $completionrow['complete'] = $completion->is_complete();
401 $completionrow['timecompleted'] = $completion->timecompleted
;
402 $completionrow['details'] = $criteria->get_details($completion);
403 $completionrows[] = $completionrow;
407 'completed' => $info->is_course_complete($user->id
),
408 'aggregation' => $info->get_aggregation_method(),
409 'completions' => $completionrows
413 'completionstatus' => $result,
414 'warnings' => $warnings
420 * Returns description of method result value
422 * @return external_description
425 public static function get_course_completion_status_returns() {
426 return new external_single_structure(
428 'completionstatus' => new external_single_structure(
430 'completed' => new external_value(PARAM_BOOL
, 'true if the course is complete, false otherwise'),
431 'aggregation' => new external_value(PARAM_INT
, 'aggregation method 1 means all, 2 means any'),
432 'completions' => new external_multiple_structure(
433 new external_single_structure(
435 'type' => new external_value(PARAM_INT
, 'Completion criteria type'),
436 'title' => new external_value(PARAM_TEXT
, 'Completion criteria Title'),
437 'status' => new external_value(PARAM_NOTAGS
, 'Completion status (Yes/No) a % or number'),
438 'complete' => new external_value(PARAM_BOOL
, 'Completion status (true/false)'),
439 'timecompleted' => new external_value(PARAM_INT
, 'Timestamp for criteria completetion'),
440 'details' => new external_single_structure(
442 'type' => new external_value(PARAM_TEXT
, 'Type description'),
443 'criteria' => new external_value(PARAM_RAW
, 'Criteria description'),
444 'requirement' => new external_value(PARAM_TEXT
, 'Requirement description'),
445 'status' => new external_value(PARAM_RAW
, 'Status description, can be anything'),
452 'warnings' => new external_warnings()
453 ), 'Course completion status'
458 * Describes the parameters for mark_course_self_completed.
460 * @return external_function_parameters
463 public static function mark_course_self_completed_parameters() {
464 return new external_function_parameters (
466 'courseid' => new external_value(PARAM_INT
, 'Course ID')
472 * Update the course completion status for the current user (if course self-completion is enabled).
474 * @param int $courseid Course id
475 * @return array Result and possible warnings
477 * @throws moodle_exception
479 public static function mark_course_self_completed($courseid) {
483 $params = self
::validate_parameters(self
::mark_course_self_completed_parameters(),
484 array('courseid' => $courseid));
486 $course = get_course($params['courseid']);
487 $context = context_course
::instance($course->id
);
488 self
::validate_context($context);
490 // Set up completion object and check it is enabled.
491 $completion = new completion_info($course);
492 if (!$completion->is_enabled()) {
493 throw new moodle_exception('completionnotenabled', 'completion');
496 if (!$completion->is_tracked_user($USER->id
)) {
497 throw new moodle_exception('nottracked', 'completion');
500 $completion = $completion->get_completion($USER->id
, COMPLETION_CRITERIA_TYPE_SELF
);
502 // Self completion criteria not enabled.
504 throw new moodle_exception('noselfcompletioncriteria', 'completion');
507 // Check if the user has already marked himself as complete.
508 if ($completion->is_complete()) {
509 throw new moodle_exception('useralreadymarkedcomplete', 'completion');
512 // Mark the course complete.
513 $completion->mark_complete();
516 $result['status'] = true;
517 $result['warnings'] = $warnings;
522 * Describes the mark_course_self_completed return value.
524 * @return external_single_structure
527 public static function mark_course_self_completed_returns() {
529 return new external_single_structure(
531 'status' => new external_value(PARAM_BOOL
, 'status, true if success'),
532 'warnings' => new external_warnings(),