)
);
}
+
+ /**
+ * Describes the parameters for get_scorms_by_courses.
+ *
+ * @return external_function_parameters
+ * @since Moodle 3.0
+ */
+ public static function get_scorm_sco_tracks_parameters() {
+ return new external_function_parameters(
+ array(
+ 'scoid' => new external_value(PARAM_INT, 'sco id'),
+ 'userid' => new external_value(PARAM_INT, 'user id'),
+ 'attempt' => new external_value(PARAM_INT, 'attempt number (0 for last attempt)', VALUE_DEFAULT, 0)
+ )
+ );
+ }
+
+ /**
+ * Retrieves SCO tracking data for the given user id and attempt number
+ *
+ * @param int $scoid the sco id
+ * @param int $userid the user id
+ * @param int $attempt the attempt number
+ * @return array warnings and the scoes data
+ * @since Moodle 3.0
+ */
+ public static function get_scorm_sco_tracks($scoid, $userid, $attempt = 0) {
+ global $USER, $DB;
+
+ $params = self::validate_parameters(self::get_scorm_sco_tracks_parameters(),
+ array('scoid' => $scoid, 'userid' => $userid, 'attempt' => $attempt));
+
+ $data = array();
+ $warnings = array();
+
+ $sco = scorm_get_sco($params['scoid'], SCO_ONLY);
+ if (!$sco) {
+ throw new moodle_exception('cannotfindsco', 'scorm');
+ }
+
+ $scorm = $DB->get_record('scorm', array('id' => $sco->scorm), '*', MUST_EXIST);
+ $cm = get_coursemodule_from_instance('scorm', $scorm->id);
+
+ $context = context_module::instance($cm->id);
+ self::validate_context($context);
+
+ // Validate the user obtaining the context, it will fail if the user doesn't exists or have been deleted.
+ context_user::instance($params['userid']);
+
+ // Extra checks so only users with permissions can view other users attempts.
+ if ($USER->id != $params['userid']) {
+ require_capability('mod/scorm:viewreport', $context);
+ }
+
+ scorm_require_available($scorm, true, $context);
+
+ if ($tracks = scorm_get_tracks($sco->id, $params['userid'], $params['attempt'])) {
+ foreach ($tracks as $element => $value) {
+ $data[] = array(
+ 'element' => $element,
+ 'value' => $value,
+ );
+ }
+ }
+
+ $result = array();
+ $result['data'] = $data;
+ $result['warnings'] = $warnings;
+ return $result;
+ }
+
+ /**
+ * Describes the get_scorm_sco_tracks return value.
+ *
+ * @return external_single_structure
+ * @since Moodle 3.0
+ */
+ public static function get_scorm_sco_tracks_returns() {
+
+ return new external_single_structure(
+ array(
+ 'data' => new external_multiple_structure(
+ new external_single_structure(
+ array(
+ 'element' => new external_value(PARAM_RAW, 'element name'),
+ 'value' => new external_value(PARAM_RAW, 'element value')
+ ), 'SCO data'
+ )
+ ),
+ 'warnings' => new external_warnings(),
+ )
+ );
+ }
}
$expectedkeys = array_keys($trackids);
$this->assertEquals(asort($expectedkeys), asort($result['trackids']));
}
+
+ /**
+ * Test get scorm sco tracks
+ */
+ public function test_mod_scorm_get_scorm_sco_tracks() {
+ global $DB;
+
+ $this->resetAfterTest(true);
+
+ // Create users.
+ $student = self::getDataGenerator()->create_user();
+ $otherstudent = self::getDataGenerator()->create_user();
+ $teacher = self::getDataGenerator()->create_user();
+
+ // Set to the student user.
+ self::setUser($student);
+
+ // Create courses to add the modules.
+ $course = self::getDataGenerator()->create_course();
+
+ // First scorm.
+ $record = new stdClass();
+ $record->course = $course->id;
+ $scorm = self::getDataGenerator()->create_module('scorm', $record);
+
+ // Users enrolments.
+ $studentrole = $DB->get_record('role', array('shortname' => 'student'));
+ $teacherrole = $DB->get_record('role', array('shortname' => 'teacher'));
+ $this->getDataGenerator()->enrol_user($student->id, $course->id, $studentrole->id, 'manual');
+ $this->getDataGenerator()->enrol_user($teacher->id, $course->id, $teacherrole->id, 'manual');
+
+ // Create attempts.
+ $scoes = scorm_get_scoes($scorm->id);
+ $sco = array_shift($scoes);
+ scorm_insert_track($student->id, $scorm->id, $sco->id, 1, 'cmi.core.lesson_status', 'completed');
+ scorm_insert_track($student->id, $scorm->id, $sco->id, 1, 'cmi.core.score.raw', '80');
+ scorm_insert_track($student->id, $scorm->id, $sco->id, 2, 'cmi.core.lesson_status', 'completed');
+
+ $result = mod_scorm_external::get_scorm_sco_tracks($sco->id, $student->id, 1);
+ $result = external_api::clean_returnvalue(mod_scorm_external::get_scorm_sco_tracks_returns(), $result);
+ // 7 default elements + 2 custom ones.
+ $this->assertCount(9, $result['data']);
+ // Find our tracking data.
+ $found = 0;
+ foreach ($result['data'] as $userdata) {
+ if ($userdata['element'] == 'cmi.core.lesson_status' and $userdata['value'] == 'completed') {
+ $found++;
+ }
+ if ($userdata['element'] == 'cmi.core.score.raw' and $userdata['value'] == '80') {
+ $found++;
+ }
+ }
+ $this->assertEquals(2, $found);
+
+ // Capabilities check.
+ try {
+ mod_scorm_external::get_scorm_sco_tracks($sco->id, $otherstudent->id);
+ $this->fail('Exception expected due to invalid instance id.');
+ } catch (required_capability_exception $e) {
+ $this->assertEquals('nopermissions', $e->errorcode);
+ }
+
+ self::setUser($teacher);
+ $result = mod_scorm_external::get_scorm_sco_tracks($sco->id, $student->id);
+ $result = external_api::clean_returnvalue(mod_scorm_external::get_scorm_sco_tracks_returns(), $result);
+ // 7 default elements + 1 custom one.
+ $this->assertCount(8, $result['data']);
+
+ // Test invalid instance id.
+ try {
+ mod_scorm_external::get_scorm_sco_tracks(0, 1);
+ $this->fail('Exception expected due to invalid instance id.');
+ } catch (moodle_exception $e) {
+ $this->assertEquals('cannotfindsco', $e->errorcode);
+ }
+ // Invalid user.
+ try {
+ mod_scorm_external::get_scorm_sco_tracks($sco->id, 0);
+ $this->fail('Exception expected due to invalid instance id.');
+ } catch (moodle_exception $e) {
+ $this->assertEquals('invaliduser', $e->errorcode);
+ }
+ }
}
