The mod_lti\local\ltiservice\service_base class. More...

Inheritance diagram for mod_lti\local\ltiservice\service_base:

Public Member Functions
	__construct ()
	Class constructor.

	check_tool ($typeid, $body=null, $scopes=null)
	Check that the request has been properly signed and is permitted.

	check_tool_proxy ($toolproxyguid, $body=null)
	Check that the request has been properly signed.

	check_type ($typeid, $courseid, $body=null)
	Check that the request has been properly signed.

	get_component_id ()
	Get the service compoent ID.

	get_configuration_options (&$mform)
	Returns the configuration options for this service.

	get_configuration_parameter_names ()
	Return an array with the names of the parameters that the service will be saving in the configuration.

	get_id ()
	Get the service ID.

	get_jwt_claim_mappings ()
	Return an array of key/claim mapping allowing LTI 1.1 custom parameters to be transformed to LTI 1.3 claims.

	get_launch_parameters ($messagetype, $courseid, $userid, $typeid, $modlti=null)
	Return an array of key/values to add to the launch parameters.

	get_name ()
	Get the service name.

	get_permitted_scopes ()
	Get the scope(s) permitted for this service in the context of a particular tool type.

	get_resources ()
	Get the resources for this service.

	get_scopes ()
	Get the scope(s) permitted for this service.

	get_tool_proxy ()
	Get the tool proxy object.

	get_type ()
	Get the type object.

	get_typeconfig ()
	Get the type config array.

	instance_added (object $lti)
	Called when a new LTI Instance is added.

	instance_deleted (int $id)
	Called when a new LTI Instance is deleted.

	instance_updated (object $lti)
	Called when a new LTI Instance is updated.

	is_allowed_in_context ($typeid, $courseid)
	Checks if there is a site tool or a course tool for this site.

	is_unsigned ()
	Get whether the service requests need to be signed.

	is_used_in_context ($typeid, $courseid)
	Default implementation will check for the existence of at least one mod_lti entry for that tool and context.

	override_endpoint (string $messagetype, string $targetlinkuri, ?string $customstr, int $courseid, ?object $lti=null)
	Called when the launch data is created, offering a possibility to alter the target link URI.

	parse_value ($value)
	Parse a string for custom substitution parameter variables supported by this service's resources.

	set_instance_form_values (object $defaultvalues)
	Set the form data when displaying the LTI Instance form.

stdClass	set_tool_proxy ($toolproxy)
	Set the tool proxy object.

stdClass	set_type ($type)
	Set the LTI type object.

array	set_typeconfig ($typeconfig)
	Set the LTI type config object.

Static Public Member Functions
static	get_service_path ()
	Get the path for service requests.

Public Attributes
const	LTI_VERSION2P0 = 'LTI-2p0'
	Label representing an LTI 2 message type.

const	SERVICE_ENABLED = 1
	Service enabled.

Protected Attributes
string	$id
	ID for the service.

string	$name
	Human readable name for the service.

array	$resources
	Instances of the resources associated with this service.

boolean	$unsigned
	`true` if requests for this service do not need to be signed.

Detailed Description

The mod_lti\local\ltiservice\service_base class.

Since: Moodle 2.8

Copyright: 2014 Vital Source Technologies http://vitalsource.com

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

Constructor & Destructor Documentation

◆ __construct()

mod_lti\local\ltiservice\service_base::__construct ( )

Class constructor.

Reimplemented in ltiservice_basicoutcomes\local\service\basicoutcomes, ltiservice_gradebookservices\local\service\gradebookservices, ltiservice_memberships\local\service\memberships, ltiservice_profile\local\service\profile, ltiservice_toolproxy\local\service\toolproxy, and ltiservice_toolsettings\local\service\toolsettings.

Member Function Documentation

◆ check_tool()

mod_lti\local\ltiservice\service_base::check_tool	(	$typeid,
		$body = null,
		$scopes = null )

Check that the request has been properly signed and is permitted.

Parameters

string	$typeid	LTI type ID
string	$body	Request body (null if none)
string[]	$scopes	Array of required scope(s) for incoming request

Return values

boolean

◆ check_tool_proxy()

mod_lti\local\ltiservice\service_base::check_tool_proxy	(		$toolproxyguid,
			$body = null )

Check that the request has been properly signed.

Parameters

string	$toolproxyguid	Tool Proxy GUID
string	$body	Request body (null if none)

Return values

boolean

Deprecated: since Moodle 3.7 MDL-62599 - please do not use this function any more.

See also: service_base\check_tool()

◆ check_type()

mod_lti\local\ltiservice\service_base::check_type	(	$typeid,
		$courseid,
		$body = null )

Check that the request has been properly signed.

Parameters

int	$typeid	The tool id
int	$courseid	The course we are at
string	$body	Request body (null if none)

Return values

bool

Deprecated: since Moodle 3.7 MDL-62599 - please do not use this function any more.

See also: service_base\check_tool()

◆ get_component_id()

mod_lti\local\ltiservice\service_base::get_component_id ( )

Get the service compoent ID.

Return values

string

◆ get_configuration_options()

mod_lti\local\ltiservice\service_base::get_configuration_options ( & $mform )

Returns the configuration options for this service.

Parameters

MoodleQuickForm $mform Moodle quickform object definition

Reimplemented in ltiservice_gradebookservices\local\service\gradebookservices, ltiservice_memberships\local\service\memberships, and ltiservice_toolsettings\local\service\toolsettings.

◆ get_configuration_parameter_names()

mod_lti\local\ltiservice\service_base::get_configuration_parameter_names ( )

Return an array with the names of the parameters that the service will be saving in the configuration.

Return values

array Names list of the parameters that the service will be saving in the configuration

Deprecated: since Moodle 3.7 - please do not use this function any more.

◆ get_id()

mod_lti\local\ltiservice\service_base::get_id ( )

Get the service ID.

Return values

string

◆ get_jwt_claim_mappings()

mod_lti\local\ltiservice\service_base::get_jwt_claim_mappings ( )

Return an array of key/claim mapping allowing LTI 1.1 custom parameters to be transformed to LTI 1.3 claims.

Return values

array Key/value pairs of params to claim mapping.

Reimplemented in ltiservice_basicoutcomes\local\service\basicoutcomes, ltiservice_gradebookservices\local\service\gradebookservices, and ltiservice_memberships\local\service\memberships.

◆ get_launch_parameters()

mod_lti\local\ltiservice\service_base::get_launch_parameters	(	$messagetype,
		$courseid,
		$userid,
		$typeid,
		$modlti = null )

Return an array of key/values to add to the launch parameters.

Parameters

string	$messagetype	'basic-lti-launch-request' or 'ContentItemSelectionRequest'.
string	$courseid	The course id.
string	$userid	The user id.
string	$typeid	The tool lti type id.
string	$modlti	The id of the lti activity.

The type is passed to check the configuration and not return parameters for services not used.

Return values

array Key/value pairs to add as launch parameters.

Reimplemented in ltiservice_gradebookservices\local\service\gradebookservices, ltiservice_memberships\local\service\memberships, and ltiservice_toolsettings\local\service\toolsettings.

◆ get_name()

mod_lti\local\ltiservice\service_base::get_name ( )

Get the service name.

Return values

string

◆ get_permitted_scopes()

mod_lti\local\ltiservice\service_base::get_permitted_scopes ( )

Get the scope(s) permitted for this service in the context of a particular tool type.

A null value indicates that no scopes are required to access the service.

Return values

array|null

Reimplemented in ltiservice_basicoutcomes\local\service\basicoutcomes, ltiservice_gradebookservices\local\service\gradebookservices, ltiservice_memberships\local\service\memberships, and ltiservice_toolsettings\local\service\toolsettings.

◆ get_resources()

mod_lti\local\ltiservice\service_base::get_resources ( )

abstract

Get the resources for this service.

Return values

resource_base[]

Reimplemented in ltiservice_basicoutcomes\local\service\basicoutcomes, ltiservice_gradebookservices\local\service\gradebookservices, ltiservice_memberships\local\service\memberships, ltiservice_profile\local\service\profile, ltiservice_toolproxy\local\service\toolproxy, and ltiservice_toolsettings\local\service\toolsettings.

◆ get_scopes()

mod_lti\local\ltiservice\service_base::get_scopes ( )

Get the scope(s) permitted for this service.

A null value indicates that no scopes are required to access the service.

Return values

array|null

Reimplemented in ltiservice_basicoutcomes\local\service\basicoutcomes, ltiservice_gradebookservices\local\service\gradebookservices, ltiservice_memberships\local\service\memberships, and ltiservice_toolsettings\local\service\toolsettings.

◆ get_service_path()

static mod_lti\local\ltiservice\service_base::get_service_path ( )

static

Get the path for service requests.

Return values

string

◆ get_tool_proxy()

mod_lti\local\ltiservice\service_base::get_tool_proxy ( )

Get the tool proxy object.

Return values

stdClass

◆ get_type()

mod_lti\local\ltiservice\service_base::get_type ( )

Get the type object.

Return values

stdClass

◆ get_typeconfig()

mod_lti\local\ltiservice\service_base::get_typeconfig ( )

Get the type config array.

Return values

array|null

◆ instance_added()

mod_lti\local\ltiservice\service_base::instance_added ( object $lti )

Called when a new LTI Instance is added.

Parameters

object $lti LTI Instance.

Reimplemented in ltiservice_gradebookservices\local\service\gradebookservices.

◆ instance_deleted()

mod_lti\local\ltiservice\service_base::instance_deleted ( int $id )

Called when a new LTI Instance is deleted.

Parameters

int $id LTI Instance.

◆ instance_updated()

mod_lti\local\ltiservice\service_base::instance_updated ( object $lti )

Called when a new LTI Instance is updated.

Parameters

object $lti LTI Instance.

Reimplemented in ltiservice_gradebookservices\local\service\gradebookservices.

◆ is_allowed_in_context()

mod_lti\local\ltiservice\service_base::is_allowed_in_context	(		$typeid,
			$courseid )

Checks if there is a site tool or a course tool for this site.

Parameters

int	$typeid	The tool lti type id.
int	$courseid	The course id.

Return values

bool	returns True if tool is allowed in context, false otherwise.

◆ is_unsigned()

mod_lti\local\ltiservice\service_base::is_unsigned ( )

Get whether the service requests need to be signed.

Return values

boolean

◆ is_used_in_context()

mod_lti\local\ltiservice\service_base::is_used_in_context	(		$typeid,
			$courseid )

Default implementation will check for the existence of at least one mod_lti entry for that tool and context.

It may be overridden if other inferences can be done.

Ideally a Site Tool should be explicitly engaged with a course, the check on the presence of a link is a proxy to infer a Site Tool engagement until an explicit Site Tool - Course relationship exists.

Parameters

int	$typeid	The tool lti type id.
int	$courseid	The course id.

Return values

bool	returns True if tool is used in context, false otherwise.

◆ override_endpoint()

mod_lti\local\ltiservice\service_base::override_endpoint	(	string	$messagetype,
		string	$targetlinkuri,
		?string	$customstr,
		int	$courseid,
		?object	$lti = null )

Called when the launch data is created, offering a possibility to alter the target link URI.

Parameters

string	$messagetype	message type for this launch
string	$targetlinkuri	current target link uri
null \| string	$customstr	concatenated list of custom parameters
int	$courseid
null \| object	$lti	LTI Instance.

Return values

array containing the target link URL and the custom params string to use.

Reimplemented in ltiservice_gradebookservices\local\service\gradebookservices.

◆ parse_value()

mod_lti\local\ltiservice\service_base::parse_value ( $value )

Parse a string for custom substitution parameter variables supported by this service's resources.

Parameters

string $value Value to be parsed

Return values

string

◆ set_instance_form_values()

mod_lti\local\ltiservice\service_base::set_instance_form_values ( object $defaultvalues )

Set the form data when displaying the LTI Instance form.

Parameters

object $defaultvalues Default form values.

Reimplemented in ltiservice_gradebookservices\local\service\gradebookservices.

◆ set_tool_proxy()

stdClass mod_lti\local\ltiservice\service_base::set_tool_proxy ( $toolproxy )

Set the tool proxy object.

Parameters

object $toolproxy The tool proxy for this service request

◆ set_type()

stdClass mod_lti\local\ltiservice\service_base::set_type ( $type )

Set the LTI type object.

Parameters

object $type The LTI type for this service request

◆ set_typeconfig()

array mod_lti\local\ltiservice\service_base::set_typeconfig ( $typeconfig )

Set the LTI type config object.

Parameters

array $typeconfig The LTI type config for this service request

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

mod/lti/classes/local/ltiservice/service_base.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ check_tool()

◆ check_tool_proxy()

◆ check_type()

◆ get_component_id()

◆ get_configuration_options()

◆ get_configuration_parameter_names()

◆ get_id()

◆ get_jwt_claim_mappings()

◆ get_launch_parameters()

◆ get_name()

◆ get_permitted_scopes()

◆ get_resources()

◆ get_scopes()

◆ get_service_path()

◆ get_tool_proxy()

◆ get_type()

◆ get_typeconfig()

◆ instance_added()

◆ instance_deleted()

◆ instance_updated()

◆ is_allowed_in_context()

◆ is_unsigned()

◆ is_used_in_context()

◆ override_endpoint()

◆ parse_value()

◆ set_instance_form_values()

◆ set_tool_proxy()

◆ set_type()

◆ set_typeconfig()