A resource implementing the Tool Proxy. More...

Inheritance diagram for ltiservice_toolproxy\local\resources\toolproxy:

Public Member Functions
	__construct ($service)
	Class constructor. More...

	check_tool ($typeid, $body=null, $scopes=null)
	Check to make sure the request is valid. More...

	check_tool_proxy ($toolproxyguid, $body=null)
	Check to make sure the request is valid. More...

	check_type ($typeid, $contextid, $permissionrequested, $body=null)
	Check to make sure the request is valid. More...

	execute ($response)
	Execute the request for this resource. More...

	get_endpoint ()
	Get the resource fully qualified endpoint. More...

	get_formats ()
	Get the resource media types. More...

	get_id ()
	Get the resource ID. More...

	get_methods ()
	Get the resource methods. More...

	get_path ()
	Get the resource path. More...

	get_permissions ($ltitype)
	get permissions from the config of the tool for that resource More...

	get_service ()
	Get the resource's service. More...

	get_template ()
	Get the resource template. More...

	get_type ()
	Get the resource type. More...

	get_variables ()
	Get the resource template variables. More...

	parse_value ($value)
	Parse a value for custom parameter substitution variables. More...

Public Attributes
const	HTTP_DELETE = 'DELETE'
	HTTP Delete method.

const	HTTP_GET = 'GET'
	HTTP Get method.

const	HTTP_POST = 'POST'
	HTTP Post method.

const	HTTP_PUT = 'PUT'
	HTTP Put method.

Protected Member Functions
	parse_template ()
	Parse the template for variables. More...

Protected Attributes
array	$formats
	Media types supported by this resource.

string	$id
	ID for this resource.

array	$methods
	HTTP actions supported by this resource.

array	$params
	Template variables parsed from the resource template.

string	$template
	Template for this resource.

string	$type
	Type for this resource.

array	$variables
	Custom parameter substitution variables associated with this resource.

Detailed Description

A resource implementing the Tool Proxy.

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

ltiservice_toolproxy\local\resources\toolproxy::__construct ( $service )

Class constructor.

Parameters

ltiservice_toolproxy\local\resources\toolproxy $service Service instance

Reimplemented from mod_lti\local\ltiservice\resource_base.

Member Function Documentation

◆ check_tool()

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

inherited

Check to make sure the request is valid.

Parameters

int	$typeid	The typeid we want to use
string	$body	Body of HTTP request message
string[]	$scopes	Array of scope(s) required for incoming request

Return values

boolean

◆ check_tool_proxy()

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

inherited

Check to make sure the request is valid.

Parameters

string	$toolproxyguid	Consumer key
string	$body	Body of HTTP request message

Return values

boolean

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

See also: resource_base::check_tool()

◆ check_type()

mod_lti\local\ltiservice\resource_base::check_type	(	$typeid,
		$contextid,
		$permissionrequested,
		$body = `null`
	)

inherited

Check to make sure the request is valid.

Parameters

int	$typeid	The typeid we want to use
int	$contextid	The course we are at
string	$permissionrequested	The permission to be checked
string	$body	Body of HTTP request message

Return values

boolean

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

See also: resource_base::check_tool()

◆ execute()

ltiservice_toolproxy\local\resources\toolproxy::execute ( $response )

Execute the request for this resource.

Parameters

mod_lti\local\ltiservice\response $response Response object for this request.

Reimplemented from mod_lti\local\ltiservice\resource_base.

◆ get_endpoint()

mod_lti\local\ltiservice\resource_base::get_endpoint ( )

inherited

Get the resource fully qualified endpoint.

Return values

string

Reimplemented in ltiservice_basicoutcomes\local\resources\basicoutcomes.

◆ get_formats()

mod_lti\local\ltiservice\resource_base::get_formats ( )

inherited

Get the resource media types.

Return values

array

◆ get_id()

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

inherited

Get the resource ID.

Return values

string

◆ get_methods()

mod_lti\local\ltiservice\resource_base::get_methods ( )

inherited

Get the resource methods.

Return values

array

◆ get_path()

mod_lti\local\ltiservice\resource_base::get_path ( )

inherited

Get the resource path.

Return values

string

◆ get_permissions()

mod_lti\local\ltiservice\resource_base::get_permissions ( $ltitype )

inherited

get permissions from the config of the tool for that resource

Parameters

int $ltitype Type of LTI

Return values

array with the permissions related to this resource by the $ltitype or empty if none.

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

See also: resource_base::check_tool()

Reimplemented in ltiservice_memberships\local\resources\linkmemberships.

◆ get_service()

mod_lti\local\ltiservice\resource_base::get_service ( )

inherited

Get the resource's service.

Return values

mixed

◆ get_template()

mod_lti\local\ltiservice\resource_base::get_template ( )

inherited

Get the resource template.

Return values

string

◆ get_type()

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

inherited

Get the resource type.

Return values

string

◆ get_variables()

mod_lti\local\ltiservice\resource_base::get_variables ( )

inherited

Get the resource template variables.

Return values

array

◆ parse_template()

mod_lti\local\ltiservice\resource_base::parse_template ( )

protectedinherited

Parse the template for variables.

Return values

array

◆ parse_value()

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

inherited

Parse a value for custom parameter substitution variables.

Parameters

string $value String to be parsed

Return values

string

Reimplemented in ltiservice_toolsettings\local\resources\systemsettings, ltiservice_toolsettings\local\resources\linksettings, ltiservice_toolsettings\local\resources\contextsettings, ltiservice_memberships\local\resources\linkmemberships, ltiservice_memberships\local\resources\contextmemberships, ltiservice_gradebookservices\local\resources\scores, ltiservice_gradebookservices\local\resources\results, ltiservice_gradebookservices\local\resources\lineitems, and ltiservice_gradebookservices\local\resources\lineitem.

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

mod/lti/service/toolproxy/classes/local/resources/toolproxy.php

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ check_tool()

◆ check_tool_proxy()

◆ check_type()

◆ execute()

◆ get_endpoint()

◆ get_formats()

◆ get_id()

◆ get_methods()

◆ get_path()

◆ get_permissions()

◆ get_service()

◆ get_template()

◆ get_type()

◆ get_variables()

◆ parse_template()

◆ parse_value()