mod_lti_external Class Reference

External tool module external functions. More...

Inheritance diagram for mod_lti_external:

Static Public Member Functions
static	create_tool_proxy ($name, $registrationurl, $capabilityoffered, $serviceoffered)
	Creates a new tool proxy.
static	create_tool_proxy_parameters ()
	Returns description of method parameters.
static	create_tool_proxy_returns ()
	Returns description of method result value.
static	create_tool_type ($cartridgeurl, $key, $secret)
	Creates a tool type.
static	create_tool_type_parameters ()
	Returns description of method parameters.
static	create_tool_type_returns ()
	Returns description of method result value.
static	delete_tool_proxy ($id)
	Trigger the course module viewed event and update the module completion status.
static	delete_tool_proxy_parameters ()
	Returns description of method parameters.
static	delete_tool_proxy_returns ()
	Returns description of method result value.
static	delete_tool_type ($id)
	Delete a tool type.
static	delete_tool_type_parameters ()
	Returns description of method parameters.
static	delete_tool_type_returns ()
	Returns description of method result value.
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.
static	get_ltis_by_courses_parameters ()
	Describes the parameters for get_ltis_by_courses.
static	get_ltis_by_courses_returns ()
	Describes the get_ltis_by_courses return value.
static	get_tool_launch_data ($toolid)
	Return the launch data for a given external tool.
static	get_tool_launch_data_parameters ()
	Returns description of method parameters.
static	get_tool_launch_data_returns ()
	Returns description of method result value.
static	get_tool_proxies ($orphanedonly)
	Returns the tool types.
static	get_tool_proxies_parameters ()
	Returns description of method parameters.
static	get_tool_proxies_returns ()
	Returns description of method result value.
static	get_tool_proxy_registration_request ($id)
	Returns the registration request for a tool proxy.
static	get_tool_proxy_registration_request_parameters ()
	Returns description of method parameters.
static	get_tool_proxy_registration_request_returns ()
	Returns description of method result value.
static	get_tool_types ($toolproxyid)
	Returns the tool types.
static	get_tool_types_parameters ()
	Returns description of method parameters.
static	get_tool_types_returns ()
	Returns description of method result value.
static	is_cartridge ($url)
	Determine if the url to a tool is for a cartridge.
static	is_cartridge_parameters ()
	Returns description of method parameters.
static	is_cartridge_returns ()
	Returns description of method result value.
static	update_tool_type ($id, $name, $description, $state)
	Update a tool type.
static	update_tool_type_parameters ()
	Returns description of method parameters.
static	update_tool_type_returns ()
	Returns description of method result value.
static	view_lti ($ltiid)
	Trigger the course module viewed event and update the module completion status.
static	view_lti_parameters ()
	Returns description of method parameters.
static	view_lti_returns ()
	Returns description of method result value.

Detailed Description

External tool 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

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

core_external\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

core_external\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

core_external\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

core_external\external_description

Since

Moodle 3.1

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

core_external\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

core_external\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

core_external\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

core_external\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

core_external\external_description

Since

Moodle 3.1

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

core_external\external_description

Since

Moodle 3.1

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

core_external\external_description

Since

Moodle 3.0

---

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

• mod/lti/classes/external.php