mod_scorm_external Class Reference

SCORM module external functions. More...

Inheritance diagram for mod_scorm_external:

Static Public Member Functions
static	get_scorm_access_information ($scormid)
	Return access information for a given scorm.
static	get_scorm_access_information_parameters ()
	Describes the parameters for get_scorm_access_information.
static	get_scorm_access_information_returns ()
	Describes the get_scorm_access_information return value.
static	get_scorm_attempt_count ($scormid, $userid, $ignoremissingcompletion=false)
	Return the number of attempts done by a user in the given SCORM.
static	get_scorm_attempt_count_parameters ()
	Describes the parameters for get_scorm_attempt_count.
static	get_scorm_attempt_count_returns ()
	Describes the get_scorm_attempt_count return value.
static	get_scorm_sco_tracks ($scoid, $userid, $attempt=0)
	Retrieves SCO tracking data for the given user id and attempt number.
static	get_scorm_sco_tracks_parameters ()
	Describes the parameters for get_scorm_sco_tracks.
static	get_scorm_sco_tracks_returns ()
	Describes the get_scorm_sco_tracks return value.
static	get_scorm_scoes ($scormid, $organization='')
	Returns a list containing all the scoes data related to the given scorm id.
static	get_scorm_scoes_parameters ()
	Describes the parameters for get_scorm_scoes.
static	get_scorm_scoes_returns ()
	Describes the get_scorm_scoes return value.
static	get_scorm_user_data ($scormid, $attempt)
	Retrieves user tracking and SCO data and default SCORM values.
static	get_scorm_user_data_parameters ()
	Describes the parameters for get_scorm_user_data.
static	get_scorm_user_data_returns ()
	Describes the get_scorm_user_data return value.
static	get_scorms_by_courses ($courseids=array())
	Returns a list of scorms in a provided list of courses, if no list is provided all scorms that the user can view will be returned.
static	get_scorms_by_courses_parameters ()
	Describes the parameters for get_scorms_by_courses.
static	get_scorms_by_courses_returns ()
	Describes the get_scorms_by_courses return value.
static	insert_scorm_tracks ($scoid, $attempt, $tracks)
	Saves a SCORM tracking record.
static	insert_scorm_tracks_parameters ()
	Describes the parameters for insert_scorm_tracks.
static	insert_scorm_tracks_returns ()
	Describes the insert_scorm_tracks return value.
static	launch_sco ($scormid, $scoid=0)
	Trigger the course module viewed event.
static	launch_sco_parameters ()
	Returns description of method parameters.
static	launch_sco_returns ()
	Returns description of method result value.
static	view_scorm ($scormid)
	Trigger the course module viewed event.
static	view_scorm_parameters ()
	Returns description of method parameters.
static	view_scorm_returns ()
	Returns description of method result value.

Detailed Description

SCORM module external functions.

Copyright

2015 Juan Leyva juan@.nosp@m.mood.nosp@m.le.co.nosp@m.m

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Since

Moodle 3.0

Member Function Documentation

get_scorm_access_information()

static mod_scorm_external::get_scorm_access_information ( $scormid )

static

Return access information for a given scorm.

Parameters

int

$scormid

scorm instance id

Return values

array

of warnings and the access information

Since

Moodle 3.7

Exceptions

moodle_exception

get_scorm_access_information_parameters()

static mod_scorm_external::get_scorm_access_information_parameters ( )

static

Describes the parameters for get_scorm_access_information.

Return values

external_external_function_parameters

Since

Moodle 3.7

get_scorm_access_information_returns()

static mod_scorm_external::get_scorm_access_information_returns ( )

static

Describes the get_scorm_access_information return value.

Return values

external_single_structure

Since

Moodle 3.7

get_scorm_attempt_count()

static mod_scorm_external::get_scorm_attempt_count ( $scormid, $userid, $ignoremissingcompletion = false )

static

Return the number of attempts done by a user in the given SCORM.

Parameters

int	$scormid	the scorm id
int	$userid	the user id
bool	$ignoremissingcompletion	ignores attempts that haven't reported a grade/completion

Return values

array

of warnings and the attempts count

Since

Moodle 3.0

get_scorm_attempt_count_parameters()

static mod_scorm_external::get_scorm_attempt_count_parameters ( )

static

Describes the parameters for get_scorm_attempt_count.

Return values

external_function_parameters

Since

Moodle 3.0

get_scorm_attempt_count_returns()

static mod_scorm_external::get_scorm_attempt_count_returns ( )

static

Describes the get_scorm_attempt_count return value.

Return values

external_single_structure

Since

Moodle 3.0

get_scorm_sco_tracks()

static mod_scorm_external::get_scorm_sco_tracks ( $scoid, $userid, $attempt = 0 )

static

Retrieves SCO tracking data for the given user id and attempt number.

Parameters

int	$scoid	the sco id
int	$userid	the user id
int	$attempt	the attempt number

Return values

array

warnings and the scoes data

Since

Moodle 3.0

get_scorm_sco_tracks_parameters()

static mod_scorm_external::get_scorm_sco_tracks_parameters ( )

static

Describes the parameters for get_scorm_sco_tracks.

Return values

external_function_parameters

Since

Moodle 3.0

get_scorm_sco_tracks_returns()

static mod_scorm_external::get_scorm_sco_tracks_returns ( )

static

Describes the get_scorm_sco_tracks return value.

Return values

external_single_structure

Since

Moodle 3.0

get_scorm_scoes()

static mod_scorm_external::get_scorm_scoes ( $scormid, $organization = '' )

static

Returns a list containing all the scoes data related to the given scorm id.

Parameters

int	$scormid	the scorm id
string	$organization	the organization id

Return values

array

warnings and the scoes data

Since

Moodle 3.0

get_scorm_scoes_parameters()

static mod_scorm_external::get_scorm_scoes_parameters ( )

static

Describes the parameters for get_scorm_scoes.

Return values

external_function_parameters

Since

Moodle 3.0

get_scorm_scoes_returns()

static mod_scorm_external::get_scorm_scoes_returns ( )

static

Describes the get_scorm_scoes return value.

Return values

external_single_structure

Since

Moodle 3.0

get_scorm_user_data()

static mod_scorm_external::get_scorm_user_data ( $scormid, $attempt )

static

Retrieves user tracking and SCO data and default SCORM values.

Parameters

int	$scormid	the scorm id
int	$attempt	the attempt number

Return values

array

warnings and the scoes data

Exceptions

moodle_exception

Since

Moodle 3.0

get_scorm_user_data_parameters()

static mod_scorm_external::get_scorm_user_data_parameters ( )

static

Describes the parameters for get_scorm_user_data.

Return values

external_function_parameters

Since

Moodle 3.0

get_scorm_user_data_returns()

static mod_scorm_external::get_scorm_user_data_returns ( )

static

Describes the get_scorm_user_data return value.

Return values

external_single_structure

Since

Moodle 3.0

get_scorms_by_courses()

static mod_scorm_external::get_scorms_by_courses ( $courseids = array() )

static

Returns a list of scorms in a provided list of courses, if no list is provided all scorms that the user can view will be returned.

Parameters

array

$courseids

the course ids

Return values

array

the scorm details

Since

Moodle 3.0

get_scorms_by_courses_parameters()

static mod_scorm_external::get_scorms_by_courses_parameters ( )

static

Describes the parameters for get_scorms_by_courses.

Return values

external_function_parameters

Since

Moodle 3.0

get_scorms_by_courses_returns()

static mod_scorm_external::get_scorms_by_courses_returns ( )

static

Describes the get_scorms_by_courses return value.

Return values

external_single_structure

Since

Moodle 3.0

insert_scorm_tracks()

static mod_scorm_external::insert_scorm_tracks ( $scoid, $attempt, $tracks )

static

Saves a SCORM tracking record.

It will overwrite any existing tracking data for this attempt. Validation should be performed before running the function to ensure the user will not lose any existing attempt data.

Parameters

int	$scoid	the SCO id
string	$attempt	the attempt number
array	$tracks	the track records to be stored

Return values

array

warnings and the scoes data

Exceptions

moodle_exception

Since

Moodle 3.0

insert_scorm_tracks_parameters()

static mod_scorm_external::insert_scorm_tracks_parameters ( )

static

Describes the parameters for insert_scorm_tracks.

Return values

external_function_parameters

Since

Moodle 3.0

insert_scorm_tracks_returns()

static mod_scorm_external::insert_scorm_tracks_returns ( )

static

Describes the insert_scorm_tracks return value.

Return values

external_single_structure

Since

Moodle 3.0

launch_sco()

static mod_scorm_external::launch_sco ( $scormid, $scoid = 0 )

static

Trigger the course module viewed event.

Parameters

int	$scormid	the SCORM instance id
int	$scoid	the SCO id

Return values

array

of warnings and status result

Since

Moodle 3.1

Exceptions

moodle_exception

launch_sco_parameters()

static mod_scorm_external::launch_sco_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 3.1

launch_sco_returns()

static mod_scorm_external::launch_sco_returns ( )

static

Returns description of method result value.

Return values

core_external\external_description

Since

Moodle 3.1

view_scorm()

static mod_scorm_external::view_scorm ( $scormid )

static

Trigger the course module viewed event.

Parameters

int

$scormid

the scorm instance id

Return values

array

of warnings and status result

Since

Moodle 3.0

Exceptions

moodle_exception

view_scorm_parameters()

static mod_scorm_external::view_scorm_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 3.0

view_scorm_returns()

static mod_scorm_external::view_scorm_returns ( )

static

Returns description of method result value.

Return values

core_external\external_description

Since

Moodle 3.0

---

The documentation for this class was generated from the following file:

• mod/scorm/classes/external.php