mod_lti_external Class Reference

Inheritance diagram for mod_lti_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	create_tool_proxy ($name, $registrationurl, $capabilityoffered, $serviceoffered)
	Creates a new tool proxy. More...
static	create_tool_proxy_parameters ()
	Returns description of method parameters. More...
static	create_tool_proxy_returns ()
	Returns description of method result value. More...
static	create_tool_type ($cartridgeurl, $key, $secret)
	Creates a tool type. More...
static	create_tool_type_parameters ()
	Returns description of method parameters. More...
static	create_tool_type_returns ()
	Returns description of method result value. More...
static	delete_tool_proxy ($id)
	Trigger the course module viewed event and update the module completion status. More...
static	delete_tool_proxy_parameters ()
	Returns description of method parameters. More...
static	delete_tool_proxy_returns ()
	Returns description of method result value. More...
static	delete_tool_type ($id)
	Delete a tool type. More...
static	delete_tool_type_parameters ()
	Returns description of method parameters. More...
static	delete_tool_type_returns ()
	Returns description of method result value. More...
static	external_function_info ($function, $strictness=MUST_EXIST)
	Returns detailed function information. More...
static	get_ltis_by_courses ($courseids=array())
	Returns a list of external tools in a provided list of courses, if no list is provided all external tools that the user can view will be returned. More...
static	get_ltis_by_courses_parameters ()
	Describes the parameters for get_ltis_by_courses. More...
static	get_ltis_by_courses_returns ()
	Describes the get_ltis_by_courses return value. More...
static	get_tool_launch_data ($toolid)
	Return the launch data for a given external tool. More...
static	get_tool_launch_data_parameters ()
	Returns description of method parameters. More...
static	get_tool_launch_data_returns ()
	Returns description of method result value. More...
static	get_tool_proxies ($orphanedonly)
	Returns the tool types. More...
static	get_tool_proxies_parameters ()
	Returns description of method parameters. More...
static	get_tool_proxies_returns ()
	Returns description of method result value. More...
static	get_tool_proxy_registration_request ($id)
	Returns the registration request for a tool proxy. More...
static	get_tool_proxy_registration_request_parameters ()
	Returns description of method parameters. More...
static	get_tool_proxy_registration_request_returns ()
	Returns description of method result value. More...
static	get_tool_types ($toolproxyid)
	Returns the tool types. More...
static	get_tool_types_parameters ()
	Returns description of method parameters. More...
static	get_tool_types_returns ()
	Returns description of method result value. More...
static	is_cartridge ($url)
	Determine if the url to a tool is for a cartridge. More...
static	is_cartridge_parameters ()
	Returns description of method parameters. More...
static	is_cartridge_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	update_tool_type ($id, $name, $description, $state)
	Update a tool type. More...
static	update_tool_type_parameters ()
	Returns description of method parameters. More...
static	update_tool_type_returns ()
	Returns description of method result value. 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_lti ($ltiid)
	Trigger the course module viewed event and update the module completion status. More...
static	view_lti_parameters ()
	Returns description of method parameters. More...
static	view_lti_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

create_tool_proxy()

static mod_lti_external::create_tool_proxy (   $name,   $registrationurl,   $capabilityoffered,   $serviceoffered  )

static

Creates a new tool proxy.

Parameters

string	$name	Tool proxy name
string	$registrationurl	Registration url
string[]	$capabilityoffered	List of capabilities this tool proxy should be offered
string[]	$serviceoffered	List of services this tool proxy should be offered

Return values

object

The new tool proxy

Since

Moodle 3.1

Exceptions

moodle_exception

create_tool_proxy_parameters()

static mod_lti_external::create_tool_proxy_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 3.1

create_tool_proxy_returns()

static mod_lti_external::create_tool_proxy_returns ( )

static

Returns description of method result value.

Return values

external_description

Since

Moodle 3.1

create_tool_type()

static mod_lti_external::create_tool_type (   $cartridgeurl,   $key,   $secret  )

static

Creates a tool type.

Parameters

string	$cartridgeurl	Url of the xml cartridge representing the LTI tool
string	$key	The consumer key to identify this consumer
string	$secret	The secret

Return values

array

created tool type

Since

Moodle 3.1

Exceptions

moodle_exception

If the tool type could not be created

create_tool_type_parameters()

static mod_lti_external::create_tool_type_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 3.1

create_tool_type_returns()

static mod_lti_external::create_tool_type_returns ( )

static

Returns description of method result value.

Return values

external_description

Since

Moodle 3.1

delete_tool_proxy()

static mod_lti_external::delete_tool_proxy (   $id )

static

Trigger the course module viewed event and update the module completion status.

Parameters

int

$id

the lti instance id

Return values

object

The tool proxy

Since

Moodle 3.1

Exceptions

moodle_exception

delete_tool_proxy_parameters()

static mod_lti_external::delete_tool_proxy_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 3.1

delete_tool_proxy_returns()

static mod_lti_external::delete_tool_proxy_returns ( )

static

Returns description of method result value.

Return values

external_description

Since

Moodle 3.1

delete_tool_type()

static mod_lti_external::delete_tool_type (   $id )

static

Delete a tool type.

Parameters

int

$id

The id of the tool type to be deleted

Return values

array

deleted tool type

Since

Moodle 3.1

Exceptions

moodle_exception

delete_tool_type_parameters()

static mod_lti_external::delete_tool_type_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 3.1

delete_tool_type_returns()

static mod_lti_external::delete_tool_type_returns ( )

static

Returns description of method result value.

Return values

external_description

Since

Moodle 3.1

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_ltis_by_courses()

static mod_lti_external::get_ltis_by_courses (   $courseids = array() )

static

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

Parameters

array

$courseids

the course ids

Return values

array

the lti details

Since

Moodle 3.0

get_ltis_by_courses_parameters()

static mod_lti_external::get_ltis_by_courses_parameters ( )

static

Describes the parameters for get_ltis_by_courses.

Return values

external_function_parameters

Since

Moodle 3.0

get_ltis_by_courses_returns()

static mod_lti_external::get_ltis_by_courses_returns ( )

static

Describes the get_ltis_by_courses return value.

Return values

external_single_structure

Since

Moodle 3.0

get_tool_launch_data()

static mod_lti_external::get_tool_launch_data (   $toolid )

static

Return the launch data for a given external tool.

Parameters

int

$toolid

the external tool instance id

Return values

array

of warnings and launch data

Since

Moodle 3.0

Exceptions

moodle_exception

get_tool_launch_data_parameters()

static mod_lti_external::get_tool_launch_data_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 3.0

get_tool_launch_data_returns()

static mod_lti_external::get_tool_launch_data_returns ( )

static

Returns description of method result value.

Return values

external_description

Since

Moodle 3.0

get_tool_proxies()

static mod_lti_external::get_tool_proxies (   $orphanedonly )

static

Returns the tool types.

Parameters

bool

$orphanedonly

Retrieve only tool proxies that do not have a corresponding tool type

Return values

array

of tool types

Since

Moodle 3.1

Exceptions

moodle_exception

get_tool_proxies_parameters()

static mod_lti_external::get_tool_proxies_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 3.1

get_tool_proxies_returns()

static mod_lti_external::get_tool_proxies_returns ( )

static

Returns description of method result value.

Return values

external_description

Since

Moodle 3.1

get_tool_proxy_registration_request()

static mod_lti_external::get_tool_proxy_registration_request (   $id )

static

Returns the registration request for a tool proxy.

Parameters

int

$id

the lti instance id

Return values

array

of registration parameters

Since

Moodle 3.1

Exceptions

moodle_exception

get_tool_proxy_registration_request_parameters()

static mod_lti_external::get_tool_proxy_registration_request_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 3.0

get_tool_proxy_registration_request_returns()

static mod_lti_external::get_tool_proxy_registration_request_returns ( )

static

Returns description of method result value.

Return values

external_description

Since

Moodle 3.1

get_tool_types()

static mod_lti_external::get_tool_types (   $toolproxyid )

static

Returns the tool types.

Parameters

int

$toolproxyid

The tool proxy id

Return values

array

of tool types

Since

Moodle 3.1

Exceptions

moodle_exception

get_tool_types_parameters()

static mod_lti_external::get_tool_types_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 3.1

get_tool_types_returns()

static mod_lti_external::get_tool_types_returns ( )

static

Returns description of method result value.

Return values

external_description

Since

Moodle 3.1

is_cartridge()

static mod_lti_external::is_cartridge (   $url )

static

Determine if the url to a tool is for a cartridge.

Parameters

string

$url

Url that may or may not be an xml cartridge

Return values

bool	True if the url is for a cartridge.

Since

Moodle 3.1

Exceptions

moodle_exception

is_cartridge_parameters()

static mod_lti_external::is_cartridge_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 3.1

is_cartridge_returns()

static mod_lti_external::is_cartridge_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

update_tool_type()

static mod_lti_external::update_tool_type (   $id,   $name,   $description,   $state  )

static

Update a tool type.

Parameters

int	$id	The id of the tool type to update
string	$name	The name of the tool type
string	$description	The name of the tool type
int	$state	The state of the tool type

Return values

array

updated tool type

Since

Moodle 3.1

Exceptions

moodle_exception

update_tool_type_parameters()

static mod_lti_external::update_tool_type_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 3.1

update_tool_type_returns()

static mod_lti_external::update_tool_type_returns ( )

static

Returns description of method result value.

Return values

external_description

Since

Moodle 3.1

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_lti()

static mod_lti_external::view_lti (   $ltiid )

static

Trigger the course module viewed event and update the module completion status.

Parameters

int

$ltiid

the lti instance id

Return values

array

of warnings and status result

Since

Moodle 3.0

Exceptions

moodle_exception

view_lti_parameters()

static mod_lti_external::view_lti_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 3.0

view_lti_returns()

static mod_lti_external::view_lti_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/lti/classes/external.php