mod_scorm_external Class Reference

Inheritance diagram for mod_scorm_external:

Static Public Member Functions
static	call_external_function ($function, $args, $ajaxonly=false)
	Call an external function validating all params/returns correctly. More...
static	clean_returnvalue (external_description $description, $response)
	Clean response If a response attribute is unknown from the description, we just ignore the attribute. More...
static	external_function_info ($function, $strictness=MUST_EXIST)
	Returns detailed function information. More...
static	get_scorm_access_information ($scormid)
	Return access information for a given scorm. More...
static	get_scorm_access_information_parameters ()
	Describes the parameters for get_scorm_access_information. More...
static	get_scorm_access_information_returns ()
	Describes the get_scorm_access_information return value. More...
static	get_scorm_attempt_count ($scormid, $userid, $ignoremissingcompletion=false)
	Return the number of attempts done by a user in the given SCORM. More...
static	get_scorm_attempt_count_parameters ()
	Describes the parameters for get_scorm_attempt_count. More...
static	get_scorm_attempt_count_returns ()
	Describes the get_scorm_attempt_count return value. More...
static	get_scorm_sco_tracks ($scoid, $userid, $attempt=0)
	Retrieves SCO tracking data for the given user id and attempt number. More...
static	get_scorm_sco_tracks_parameters ()
	Describes the parameters for get_scorm_sco_tracks. More...
static	get_scorm_sco_tracks_returns ()
	Describes the get_scorm_sco_tracks return value. More...
static	get_scorm_scoes ($scormid, $organization='')
	Returns a list containing all the scoes data related to the given scorm id. More...
static	get_scorm_scoes_parameters ()
	Describes the parameters for get_scorm_scoes. More...
static	get_scorm_scoes_returns ()
	Describes the get_scorm_scoes return value. More...
static	get_scorm_user_data ($scormid, $attempt)
	Retrieves user tracking and SCO data and default SCORM values. More...
static	get_scorm_user_data_parameters ()
	Describes the parameters for get_scorm_user_data. More...
static	get_scorm_user_data_returns ()
	Describes the get_scorm_user_data return value. More...
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. More...
static	get_scorms_by_courses_parameters ()
	Describes the parameters for get_scorms_by_courses. More...
static	get_scorms_by_courses_returns ()
	Describes the get_scorms_by_courses return value. More...
static	insert_scorm_tracks ($scoid, $attempt, $tracks)
	Saves a SCORM tracking record. More...
static	insert_scorm_tracks_parameters ()
	Describes the parameters for insert_scorm_tracks. More...
static	insert_scorm_tracks_returns ()
	Describes the insert_scorm_tracks return value. More...
static	launch_sco ($scormid, $scoid=0)
	Trigger the course module viewed event. More...
static	launch_sco_parameters ()
	Returns description of method parameters. More...
static	launch_sco_returns ()
	Returns description of method result value. More...
static	set_context_restriction ($context)
	Set context restriction for all following subsequent function calls. More...
static	set_timeout ($seconds=360)
	This method has to be called before every operation that takes a longer time to finish! More...
static	validate_context ($context)
	Makes sure user may execute functions in this context. More...
static	validate_parameters (external_description $description, $params)
	Validates submitted function parameters, if anything is incorrect invalid_parameter_exception is thrown. More...
static	view_scorm ($scormid)
	Trigger the course module viewed event. More...
static	view_scorm_parameters ()
	Returns description of method parameters. More...
static	view_scorm_returns ()
	Returns description of method result value. More...

Static Protected Member Functions
static	get_context_from_params ($param)
	Get context from passed parameters. More...
static	get_context_parameters ()
	Returns a prepared structure to use a context parameters. More...

Member Function Documentation

call_external_function()

static external_api::call_external_function (   $function,   $args,   $ajaxonly = false  )

staticinherited

Call an external function validating all params/returns correctly.

Note that an external function may modify the state of the current page, so this wrapper saves and restores tha PAGE and COURSE global variables before/after calling the external function.

Parameters

string	$function	A webservice function name.
array	$args	Params array (named params)
boolean	$ajaxonly	If true, an extra check will be peformed to see if ajax is required.

Return values

array

containing keys for error (bool), exception and data.

clean_returnvalue()

static external_api::clean_returnvalue ( external_description  $description,   $response  )

staticinherited

Clean response If a response attribute is unknown from the description, we just ignore the attribute.

If a response attribute is incorrect, invalid_response_exception is thrown. Note: this function is similar to validate parameters, however it is distinct because parameters validation must be distinct from cleaning return values.

Parameters

external_description	$description	description of the return values
mixed	$response	the actual response

Return values

mixed

response with added defaults for optional items, invalid_response_exception thrown if any problem found

Author

2010 Jerome Mouneyrac

Since

Moodle 2.0

external_function_info()

static external_api::external_function_info (   $function,   $strictness = MUST_EXIST  )

staticinherited

Returns detailed function information.

Parameters

string | object	$function	name of external function or record from external_function
int	$strictness	IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found; MUST_EXIST means throw exception if no record or multiple records found

Return values

stdClass

description or false if not found or exception thrown

Since

Moodle 2.0

get_context_from_params()

static external_api::get_context_from_params (   $param )

staticprotectedinherited

Get context from passed parameters.

The passed array must either contain a contextid or a combination of context level and instance id to fetch the context. For example, the context level can be "course" and instanceid can be courseid.

See context_helper::get_all_levels() for a list of valid context levels.

Parameters

array

$param

Since

Moodle 2.6

Exceptions

invalid_parameter_exception

Return values

context

get_context_parameters()

static external_api::get_context_parameters ( )

staticprotectedinherited

Returns a prepared structure to use a context parameters.

Return values

external_single_structure

Reimplemented in tool_lp\external, and core_competency\external.

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

external_description

Since

Moodle 3.1

set_context_restriction()

static external_api::set_context_restriction (   $context )

staticinherited

Set context restriction for all following subsequent function calls.

Parameters

stdClass

$context

the context restriction

Since

Moodle 2.0

set_timeout()

static external_api::set_timeout (   $seconds = 360 )

staticinherited

This method has to be called before every operation that takes a longer time to finish!

Parameters

int

$seconds

max expected time the next operation needs

Since

Moodle 2.0

validate_context()

static external_api::validate_context (   $context )

staticinherited

Makes sure user may execute functions in this context.

Parameters

stdClass

$context

Since

Moodle 2.0

validate_parameters()

static external_api::validate_parameters ( external_description  $description,   $params  )

staticinherited

Validates submitted function parameters, if anything is incorrect invalid_parameter_exception is thrown.

This is a simple recursive method which is intended to be called from each implementation method of external API.

Parameters

external_description	$description	description of parameters
mixed	$params	the actual parameters

Return values

mixed

params with added defaults for optional items, invalid_parameters_exception thrown if any problem found

Since

Moodle 2.0

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

external_description

Since

Moodle 3.0

---

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

• mod/scorm/classes/external.php