mod_lti\local\ltiservice\resource_base Class Reference

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

Inheritance diagram for mod_lti\local\ltiservice\resource_base:

Public Member Functions
	__construct ($service)
	Class constructor.
	check_tool ($typeid, $body=null, $scopes=null)
	Check to make sure the request is valid.
	check_tool_proxy ($toolproxyguid, $body=null)
	Check to make sure the request is valid.
	check_type ($typeid, $contextid, $permissionrequested, $body=null)
	Check to make sure the request is valid.
	execute ($response)
	Execute the request for this resource.
	get_endpoint ()
	Get the resource fully qualified endpoint.
	get_formats ()
	Get the resource media types.
	get_id ()
	Get the resource ID.
	get_methods ()
	Get the resource methods.
	get_path ()
	Get the resource path.
	get_permissions ($ltitype)
	get permissions from the config of the tool for that resource
	get_service ()
	Get the resource's service.
	get_template ()
	Get the resource template.
	get_type ()
	Get the resource type.
	get_variables ()
	Get the resource template variables.
	parse_value ($value)
	Parse a value for custom parameter substitution variables.

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.

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

The mod_lti\local\ltiservice\resource_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\resource_base::__construct

(

$service

)

Class constructor.

Parameters

service_base

$service

Service instance

Reimplemented in ltiservice_basicoutcomes\local\resources\basicoutcomes, ltiservice_gradebookservices\local\resources\lineitem, ltiservice_gradebookservices\local\resources\lineitems, ltiservice_gradebookservices\local\resources\results, ltiservice_gradebookservices\local\resources\scores, ltiservice_memberships\local\resources\contextmemberships, ltiservice_memberships\local\resources\linkmemberships, ltiservice_profile\local\resources\profile, ltiservice_toolproxy\local\resources\toolproxy, ltiservice_toolsettings\local\resources\contextsettings, ltiservice_toolsettings\local\resources\linksettings, and ltiservice_toolsettings\local\resources\systemsettings.

Member Function Documentation

check_tool()

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

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 )

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 )

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

mod_lti\local\ltiservice\resource_base::execute ( $response )

abstract

Execute the request for this resource.

Parameters

response

$response

Response object for this request.

Reimplemented in ltiservice_basicoutcomes\local\resources\basicoutcomes, ltiservice_gradebookservices\local\resources\lineitem, ltiservice_gradebookservices\local\resources\lineitems, ltiservice_gradebookservices\local\resources\results, ltiservice_gradebookservices\local\resources\scores, ltiservice_memberships\local\resources\contextmemberships, ltiservice_memberships\local\resources\linkmemberships, ltiservice_profile\local\resources\profile, ltiservice_toolproxy\local\resources\toolproxy, ltiservice_toolsettings\local\resources\contextsettings, ltiservice_toolsettings\local\resources\linksettings, and ltiservice_toolsettings\local\resources\systemsettings.

get_endpoint()

mod_lti\local\ltiservice\resource_base::get_endpoint

(

)

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

(

)

Get the resource media types.

Return values

array

get_id()

mod_lti\local\ltiservice\resource_base::get_id

(

)

Get the resource ID.

Return values

string

get_methods()

mod_lti\local\ltiservice\resource_base::get_methods

(

)

Get the resource methods.

Return values

array

get_path()

mod_lti\local\ltiservice\resource_base::get_path

(

)

Get the resource path.

Return values

string

Reimplemented in ltiservice_profile\local\resources\profile.

get_permissions()

mod_lti\local\ltiservice\resource_base::get_permissions

(

$ltitype

)

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

(

)

Get the resource's service.

Return values

service_base

get_template()

mod_lti\local\ltiservice\resource_base::get_template

(

)

Get the resource template.

Return values

string

get_type()

mod_lti\local\ltiservice\resource_base::get_type

(

)

Get the resource type.

Return values

string

get_variables()

mod_lti\local\ltiservice\resource_base::get_variables

(

)

Get the resource template variables.

Return values

array

parse_template()

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

protected

Parse the template for variables.

Return values

array

parse_value()

mod_lti\local\ltiservice\resource_base::parse_value

(

$value

)

Parse a value for custom parameter substitution variables.

Parameters

string

$value

String to be parsed

Return values

string

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

---

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

• mod/lti/classes/local/ltiservice/resource_base.php