MDL-49313 webservices: New WS get_course_completion_status
This commit is contained in:
Costantino Cito
committed by
Juan Leyva
Juan Leyva
parent
1d3fd63f97
commit
90c326640d
@@ -234,4 +234,147 @@ class core_completion_external extends external_api {
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns description of method parameters
|
||||
*
|
||||
* @return external_function_parameters
|
||||
* @since Moodle 2.9
|
||||
*/
|
||||
public static function get_course_completion_status_parameters() {
|
||||
return new external_function_parameters(
|
||||
array(
|
||||
'courseid' => new external_value(PARAM_INT, 'Course ID'),
|
||||
'userid' => new external_value(PARAM_INT, 'User ID'),
|
||||
)
|
||||
);
|
||||
}
|
||||
/**
|
||||
* Get Course completion status
|
||||
*
|
||||
* @param int $courseid ID of the Course
|
||||
* @param int $userid ID of the User
|
||||
* @return array of course completion status and warnings
|
||||
* @since Moodle 2.9
|
||||
* @throws moodle_exception
|
||||
*/
|
||||
public static function get_course_completion_status($courseid, $userid) {
|
||||
global $CFG, $USER;
|
||||
require_once($CFG->libdir . '/grouplib.php');
|
||||
|
||||
$warnings = array();
|
||||
$arrayparams = array(
|
||||
'courseid' => $courseid,
|
||||
'userid' => $userid,
|
||||
);
|
||||
$params = self::validate_parameters(self::get_course_completion_status_parameters(), $arrayparams);
|
||||
|
||||
$course = get_course($params['courseid']);
|
||||
$user = core_user::get_user($params['userid'], 'id', MUST_EXIST);
|
||||
$context = context_course::instance($course->id);
|
||||
self::validate_context($context);
|
||||
|
||||
// Can current user see user's course completion status?
|
||||
// This check verifies if completion is enabled because $course is mandatory.
|
||||
if (!completion_can_view_data($user->id, $course)) {
|
||||
throw new moodle_exception('cannotviewreport');
|
||||
}
|
||||
|
||||
// The previous function doesn't check groups.
|
||||
if ($user->id != $USER->id) {
|
||||
if (!groups_user_groups_visible($course, $user->id)) {
|
||||
// We are not in the same group!
|
||||
throw new moodle_exception('accessdenied', 'admin');
|
||||
}
|
||||
}
|
||||
|
||||
$info = new completion_info($course);
|
||||
|
||||
// Check this user is enroled.
|
||||
if (!$info->is_tracked_user($user->id)) {
|
||||
if ($USER->id == $user->id) {
|
||||
throw new moodle_exception('notenroled', 'completion');
|
||||
} else {
|
||||
throw new moodle_exception('usernotenroled', 'completion');
|
||||
}
|
||||
}
|
||||
|
||||
$completions = $info->get_completions($user->id);
|
||||
if (empty($completions)) {
|
||||
throw new moodle_exception('err_nocriteria', 'completion');
|
||||
}
|
||||
|
||||
// Load course completion.
|
||||
$completionparams = array(
|
||||
'userid' => $user->id,
|
||||
'course' => $course->id,
|
||||
);
|
||||
$ccompletion = new completion_completion($completionparams);
|
||||
|
||||
$completionrows = array();
|
||||
// Loop through course criteria.
|
||||
foreach ($completions as $completion) {
|
||||
$criteria = $completion->get_criteria();
|
||||
|
||||
$completionrow = array();
|
||||
$completionrow['type'] = $criteria->criteriatype;
|
||||
$completionrow['title'] = $criteria->get_title();
|
||||
$completionrow['status'] = $completion->get_status();
|
||||
$completionrow['complete'] = $completion->is_complete();
|
||||
$completionrow['timecompleted'] = $completion->timecompleted;
|
||||
$completionrow['details'] = $criteria->get_details($completion);
|
||||
$completionrows[] = $completionrow;
|
||||
}
|
||||
|
||||
$result = array(
|
||||
'completed' => $info->is_course_complete($user->id),
|
||||
'aggregation' => $info->get_aggregation_method(),
|
||||
'completions' => $completionrows
|
||||
);
|
||||
|
||||
$results = array(
|
||||
'completionstatus' => $result,
|
||||
'warnings' => $warnings
|
||||
);
|
||||
return $results;
|
||||
|
||||
}
|
||||
/**
|
||||
* Returns description of method result value
|
||||
*
|
||||
* @return external_description
|
||||
* @since Moodle 2.9
|
||||
*/
|
||||
public static function get_course_completion_status_returns() {
|
||||
return new external_single_structure(
|
||||
array(
|
||||
'completionstatus' => new external_single_structure(
|
||||
array(
|
||||
'completed' => new external_value(PARAM_BOOL, 'true if the course is complete, false otherwise'),
|
||||
'aggregation' => new external_value(PARAM_INT, 'aggregation method 1 means all, 2 means any'),
|
||||
'completions' => new external_multiple_structure(
|
||||
new external_single_structure(
|
||||
array(
|
||||
'type' => new external_value(PARAM_INT, 'Completion criteria type'),
|
||||
'title' => new external_value(PARAM_TEXT, 'Completion criteria Title'),
|
||||
'status' => new external_value(PARAM_NOTAGS, 'Completion status (Yes/No) a % or number'),
|
||||
'complete' => new external_value(PARAM_BOOL, 'Completion status (true/false)'),
|
||||
'timecompleted' => new external_value(PARAM_INT, 'Timestamp for criteria completetion'),
|
||||
'details' => new external_single_structure(
|
||||
array(
|
||||
'type' => new external_value(PARAM_TEXT, 'Type description'),
|
||||
'criteria' => new external_value(PARAM_RAW, 'Criteria description'),
|
||||
'requirement' => new external_value(PARAM_TEXT, 'Requirement description'),
|
||||
'status' => new external_value(PARAM_TEXT, 'Status description'),
|
||||
), 'details'),
|
||||
), 'Completions'
|
||||
), ''
|
||||
)
|
||||
), 'Course status'
|
||||
),
|
||||
'warnings' => new external_warnings()
|
||||
), 'Course completion status'
|
||||
);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@@ -120,6 +120,13 @@ $functions = array(
|
||||
'capabilities' => '',
|
||||
),
|
||||
|
||||
'core_completion_get_course_completion_status' => array(
|
||||
'classname' => 'core_completion_external',
|
||||
'methodname' => 'get_course_completion_status',
|
||||
'description' => 'Returns course completion status.',
|
||||
'type' => 'read',
|
||||
'capabilities' => 'moodle/user:viewuseractivitiesreport, report/completion:view',
|
||||
),
|
||||
// Grade related functions.
|
||||
|
||||
'core_grades_get_grades' => array(
|
||||
|
||||
Reference in New Issue
Block a user