Class to represent an LTI Tool Provider. More...

Collaboration diagram for IMSGlobal\LTI\ToolProvider\ToolProvider:

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

	handleRequest ()
	Process an incoming request. More...

	setParameterConstraint ($name, $required=true, $maxLength=null, $messageTypes=null)
	Add a parameter constraint to be checked on launch. More...

	getConsumers ()
	Get an array of defined tool consumers. More...

	findService ($format, $methods)
	Find an offered service based on a media type and HTTP action(s) More...

	doToolProxyService ()
	Send the tool proxy to the Tool Consumer. More...

Static Public Member Functions
static	parseRoles ($roles)
	Get an array of fully qualified user roles. More...

static	sendForm ($url, $params, $target='')
	Generate a web page containing an auto-submitted form of parameters. More...

Data Fields
const	CONNECTION_ERROR_MESSAGE = 'Sorry, there was an error connecting you to the application.'
	Default connection error message. More...

const	LTI_VERSION1 = 'LTI-1p0'
	LTI version 1 for messages. More...

const	LTI_VERSION2 = 'LTI-2p0'
	LTI version 2 for messages. More...

const	ID_SCOPE_ID_ONLY = 0
	Use ID value only. More...

const	ID_SCOPE_GLOBAL = 1
	Prefix an ID with the consumer key. More...

const	ID_SCOPE_CONTEXT = 2
	Prefix the ID with the consumer key and context ID. More...

const	ID_SCOPE_RESOURCE = 3
	Prefix the ID with the consumer key and resource ID. More...

const	ID_SCOPE_SEPARATOR = ':'
	Character used to separate each element of an ID. More...

	$ok = true
	True if the last request was successful. More...

	$consumer = null
	Tool Consumer object. More...

	$returnUrl = null
	Return URL provided by tool consumer. More...

	$user = null
	User object. More...

	$resourceLink = null
	Resource link object. More...

	$context = null
	Context object. More...

	$dataConnector = null
	Data connector object. More...

	$defaultEmail = ''
	Default email domain. More...

	$idScope = self::ID_SCOPE_ID_ONLY
	Scope to use for user IDs. More...

	$allowSharing = false
	Whether shared resource link arrangements are permitted. More...

	$message = self::CONNECTION_ERROR_MESSAGE
	Message for last request processed. More...

	$reason = null
	Error message for last request processed. More...

	$details = array()
	Details for error message relating to last request processed. More...

	$baseUrl = null
	Base URL for tool provider service. More...

	$vendor = null
	Vendor details. More...

	$product = null
	Product details. More...

	$requiredServices = null
	Services required by Tool Provider. More...

	$optionalServices = null
	Optional services used by Tool Provider. More...

	$resourceHandlers = null
	Resource handlers for Tool Provider. More...

Protected Member Functions
	onLaunch ()
	Process a valid launch request. More...

	onContentItem ()
	Process a valid content-item request. More...

	onRegister ()
	Process a valid tool proxy registration request. More...

	onError ()
	Process a response to an invalid request. More...

Protected Attributes
	$redirectUrl = null
	URL to redirect user to on successful completion of the request. More...

	$mediaTypes = null
	URL to redirect user to on successful completion of the request. More...

	$documentTargets = null
	URL to redirect user to on successful completion of the request. More...

	$output = null
	HTML to be displayed on a successful completion of the request. More...

	$errorOutput = null
	HTML to be displayed on an unsuccessful completion of the request and no return URL is available. More...

	$debugMode = false
	Whether debug messages explaining the cause of errors are to be returned to the tool consumer. More...

Private Member Functions
	doCallback ($method=null)
	Call any callback function for the requested action. More...

	result ()
	Perform the result of an action. More...

	authenticate ()
	Check the authenticity of the LTI launch request. More...

	checkForShare ()
	Check if a share arrangement is in place. More...

	checkValue ($value, $values, $reason)
	Validate a parameter value from an array of permitted values. More...

Private Attributes
	$callbackHandler = null
	Callback functions for handling requests. More...

	$constraints = null
	LTI parameter constraints for auto validation checks. More...

Static Private Attributes
static	$LTI_VERSIONS = array(self::LTI_VERSION1, self::LTI_VERSION2)
	Permitted LTI versions for messages. More...

static	$MESSAGE_TYPES
	List of supported message types and associated class methods. More...

static	$METHOD_NAMES
	List of supported message types and associated class methods. More...

static	$LTI_CONSUMER_SETTING_NAMES = array('custom_tc_profile_url', 'custom_system_setting_url')
	Names of LTI parameters to be retained in the consumer settings property. More...

static	$LTI_CONTEXT_SETTING_NAMES
	Names of LTI parameters to be retained in the context settings property. More...

static	$LTI_RESOURCE_LINK_SETTING_NAMES
	Names of LTI parameters to be retained in the resource link settings property. More...

static	$CUSTOM_SUBSTITUTION_VARIABLES
	Names of LTI custom parameter substitution variables (or capabilities) and their associated default message parameter names. More...

Detailed Description

Class to represent an LTI Tool Provider.

Author: Stephen P Vickers svick.nosp@m.ers@.nosp@m.imsgl.nosp@m.obal.nosp@m..org

Copyright: IMS Global Learning Consortium Inc

Date: 2016

Version: 3.0.2 GNU Lesser General Public License, version 3 (http://www.gnu.org/licenses/lgpl.html)

Definition at line 21 of file ToolProvider.php.

Constructor & Destructor Documentation

◆ __construct()

IMSGlobal\LTI\ToolProvider\ToolProvider::__construct ( $dataConnector )

Class constructor.

Parameters

DataConnector $dataConnector Object containing a database connection object

Definition at line 311 of file ToolProvider.php.

References $_POST, IMSGlobal\LTI\ToolProvider\ToolProvider\$dataConnector, and array.

     {
 
         $this->constraints = array();
         $this->dataConnector = $dataConnector;
         $this->ok = !is_null($this->dataConnector);
 
 // Set debug mode
         $this->debugMode = isset($_POST['custom_debug']) && (strtolower($_POST['custom_debug']) === 'true');
 
 // Set return URL if available
         if (isset($_POST['launch_presentation_return_url'])) {
             $this->returnUrl = $_POST['launch_presentation_return_url'];
         } else if (isset($_POST['content_item_return_url'])) {
             $this->returnUrl = $_POST['content_item_return_url'];
         }
         $this->vendor = new Profile\Item();
         $this->product = new Profile\Item();
         $this->requiredServices = array();
         $this->optionalServices = array();
         $this->resourceHandlers = array();
 
     }

Member Function Documentation

◆ authenticate()

IMSGlobal\LTI\ToolProvider\ToolProvider::authenticate ( )

private

Check the authenticity of the LTI launch request.

The consumer, resource link and user objects will be initialised if the request is valid.

Returns: boolean True if the request has been successfully validated.

Definition at line 674 of file ToolProvider.php.

Referenced by IMSGlobal\LTI\ToolProvider\ToolProvider\handleRequest().

     {
 
 // Get the consumer
         $doSaveConsumer = false;
 // Check all required launch parameters
         $this->ok = isset($_POST['lti_message_type']) && array_key_exists($_POST['lti_message_type'], self::$MESSAGE_TYPES);
         if (!$this->ok) {
             $this->reason = 'Invalid or missing lti_message_type parameter.';
         }
         if ($this->ok) {
             $this->ok = isset($_POST['lti_version']) && in_array($_POST['lti_version'], self::$LTI_VERSIONS);
             if (!$this->ok) {
                 $this->reason = 'Invalid or missing lti_version parameter.';
             }
         }
         if ($this->ok) {
             if ($_POST['lti_message_type'] === 'basic-lti-launch-request') {
                 $this->ok = isset($_POST['resource_link_id']) && (strlen(trim($_POST['resource_link_id'])) > 0);
                 if (!$this->ok) {
                     $this->reason = 'Missing resource link ID.';
                 }
             } else if ($_POST['lti_message_type'] === 'ContentItemSelectionRequest') {
                 if (isset($_POST['accept_media_types']) && (strlen(trim($_POST['accept_media_types'])) > 0)) {
                     $mediaTypes = array_filter(explode(',', str_replace(' ', '', $_POST['accept_media_types'])), 'strlen');
                     $mediaTypes = array_unique($mediaTypes);
                     $this->ok = count($mediaTypes) > 0;
                     if (!$this->ok) {
                         $this->reason = 'No accept_media_types found.';
                     } else {
                         $this->mediaTypes = $mediaTypes;
                     }
                 } else {
                     $this->ok = false;
                 }
                 if ($this->ok && isset($_POST['accept_presentation_document_targets']) && (strlen(trim($_POST['accept_presentation_document_targets'])) > 0)) {
                     $documentTargets = array_filter(explode(',', str_replace(' ', '', $_POST['accept_presentation_document_targets'])), 'strlen');
                     $documentTargets = array_unique($documentTargets);
                     $this->ok = count($documentTargets) > 0;
                     if (!$this->ok) {
                         $this->reason = 'Missing or empty accept_presentation_document_targets parameter.';
                     } else {
                         foreach ($documentTargets as $documentTarget) {
                             $this->ok = $this->checkValue($documentTarget, array('embed', 'frame', 'iframe', 'window', 'popup', 'overlay', 'none'),
                                  'Invalid value in accept_presentation_document_targets parameter: %s.');
                             if (!$this->ok) {
                                 break;
                             }
                         }
                         if ($this->ok) {
                             $this->documentTargets = $documentTargets;
                         }
                     }
                 } else {
                     $this->ok = false;
                 }
                 if ($this->ok) {
                     $this->ok = isset($_POST['content_item_return_url']) && (strlen(trim($_POST['content_item_return_url'])) > 0);
                     if (!$this->ok) {
                         $this->reason = 'Missing content_item_return_url parameter.';
                     }
                 }
             } else if ($_POST['lti_message_type'] == 'ToolProxyRegistrationRequest') {
                 $this->ok = ((isset($_POST['reg_key']) && (strlen(trim($_POST['reg_key'])) > 0)) &&
                              (isset($_POST['reg_password']) && (strlen(trim($_POST['reg_password'])) > 0)) &&
                              (isset($_POST['tc_profile_url']) && (strlen(trim($_POST['tc_profile_url'])) > 0)) &&
                              (isset($_POST['launch_presentation_return_url']) && (strlen(trim($_POST['launch_presentation_return_url'])) > 0)));
                 if ($this->debugMode && !$this->ok) {
                     $this->reason = 'Missing message parameters.';
                 }
             }
         }
         $now = time();
 // Check consumer key
         if ($this->ok && ($_POST['lti_message_type'] != 'ToolProxyRegistrationRequest')) {
             $this->ok = isset($_POST['oauth_consumer_key']);
             if (!$this->ok) {
                 $this->reason = 'Missing consumer key.';
             }
             if ($this->ok) {
                 $this->consumer = new ToolConsumer($_POST['oauth_consumer_key'], $this->dataConnector);
                 $this->ok = !is_null($this->consumer->created);
                 if (!$this->ok) {
                     $this->reason = 'Invalid consumer key.';
                 }
             }
             if ($this->ok) {
                 $today = date('Y-m-d', $now);
                 if (is_null($this->consumer->lastAccess)) {
                     $doSaveConsumer = true;
                 } else {
                     $last = date('Y-m-d', $this->consumer->lastAccess);
                     $doSaveConsumer = $doSaveConsumer || ($last !== $today);
                 }
                 $this->consumer->last_access = $now;
                 try {
                     $store = new OAuthDataStore($this);
                     $server = new OAuth\OAuthServer($store);
                     $method = new OAuth\OAuthSignatureMethod_HMAC_SHA1();
                     $server->add_signature_method($method);
                     $request = OAuth\OAuthRequest::from_request();
                     $res = $server->verify_request($request);
                 } catch (\Exception $e) {
                     $this->ok = false;
                     if (empty($this->reason)) {
                         if ($this->debugMode) {
                             $consumer = new OAuth\OAuthConsumer($this->consumer->getKey(), $this->consumer->secret);
                             $signature = $request->build_signature($method, $consumer, false);
                             $this->reason = $e->getMessage();
                             if (empty($this->reason)) {
                                 $this->reason = 'OAuth exception';
                             }
                             $this->details[] = 'Timestamp: ' . time();
                             $this->details[] = "Signature: {$signature}";
                             $this->details[] = "Base string: {$request->base_string}]";
                         } else {
                             $this->reason = 'OAuth signature check failed - perhaps an incorrect secret or timestamp.';
                         }
                     }
                 }
             }
             if ($this->ok) {
                 $today = date('Y-m-d', $now);
                 if (is_null($this->consumer->lastAccess)) {
                     $doSaveConsumer = true;
                 } else {
                     $last = date('Y-m-d', $this->consumer->lastAccess);
                     $doSaveConsumer = $doSaveConsumer || ($last !== $today);
                 }
                 $this->consumer->last_access = $now;
                 if ($this->consumer->protected) {
                     if (!is_null($this->consumer->consumerGuid)) {
                         $this->ok = empty($_POST['tool_consumer_instance_guid']) ||
                              ($this->consumer->consumerGuid === $_POST['tool_consumer_instance_guid']);
                         if (!$this->ok) {
                             $this->reason = 'Request is from an invalid tool consumer.';
                         }
                     } else {
                         $this->ok = isset($_POST['tool_consumer_instance_guid']);
                         if (!$this->ok) {
                             $this->reason = 'A tool consumer GUID must be included in the launch request.';
                         }
                     }
                 }
                 if ($this->ok) {
                     $this->ok = $this->consumer->enabled;
                     if (!$this->ok) {
                         $this->reason = 'Tool consumer has not been enabled by the tool provider.';
                     }
                 }
                 if ($this->ok) {
                     $this->ok = is_null($this->consumer->enableFrom) || ($this->consumer->enableFrom <= $now);
                     if ($this->ok) {
                         $this->ok = is_null($this->consumer->enableUntil) || ($this->consumer->enableUntil > $now);
                         if (!$this->ok) {
                             $this->reason = 'Tool consumer access has expired.';
                         }
                     } else {
                         $this->reason = 'Tool consumer access is not yet available.';
                     }
                 }
             }
 
 // Validate other message parameter values
             if ($this->ok) {
                 if ($_POST['lti_message_type'] === 'ContentItemSelectionRequest') {
                     if (isset($_POST['accept_unsigned'])) {
                         $this->ok = $this->checkValue($_POST['accept_unsigned'], array('true', 'false'), 'Invalid value for accept_unsigned parameter: %s.');
                     }
                     if ($this->ok && isset($_POST['accept_multiple'])) {
                         $this->ok = $this->checkValue($_POST['accept_multiple'], array('true', 'false'), 'Invalid value for accept_multiple parameter: %s.');
                     }
                     if ($this->ok && isset($_POST['accept_copy_advice'])) {
                         $this->ok = $this->checkValue($_POST['accept_copy_advice'], array('true', 'false'), 'Invalid value for accept_copy_advice parameter: %s.');
                     }
                     if ($this->ok && isset($_POST['auto_create'])) {
                         $this->ok = $this->checkValue($_POST['auto_create'], array('true', 'false'), 'Invalid value for auto_create parameter: %s.');
                     }
                     if ($this->ok && isset($_POST['can_confirm'])) {
                         $this->ok = $this->checkValue($_POST['can_confirm'], array('true', 'false'), 'Invalid value for can_confirm parameter: %s.');
                     }
                 } else if (isset($_POST['launch_presentation_document_target'])) {
                     $this->ok = $this->checkValue($_POST['launch_presentation_document_target'], array('embed', 'frame', 'iframe', 'window', 'popup', 'overlay'),
                          'Invalid value for launch_presentation_document_target parameter: %s.');
                 }
             }
         }
 
         if ($this->ok && ($_POST['lti_message_type'] === 'ToolProxyRegistrationRequest')) {
             $this->ok = $_POST['lti_version'] == self::LTI_VERSION2;
             if (!$this->ok) {
                 $this->reason = 'Invalid lti_version parameter';
             }
             if ($this->ok) {
                 $http = new HTTPMessage($_POST['tc_profile_url'], 'GET', null, 'Accept: application/vnd.ims.lti.v2.toolconsumerprofile+json');
                 $this->ok = $http->send();
                 if (!$this->ok) {
                     $this->reason = 'Tool consumer profile not accessible.';
                 } else {
                     $tcProfile = json_decode($http->response);
                     $this->ok = !is_null($tcProfile);
                     if (!$this->ok) {
                         $this->reason = 'Invalid JSON in tool consumer profile.';
                     }
                 }
             }
 // Check for required capabilities
             if ($this->ok) {
                 $this->consumer = new ToolConsumer($_POST['reg_key'], $this->dataConnector);
                 $this->consumer->profile = $tcProfile;
                 $capabilities = $this->consumer->profile->capability_offered;
                 $missing = array();
                 foreach ($this->resourceHandlers as $resourceHandler) {
                     foreach ($resourceHandler->requiredMessages as $message) {
                         if (!in_array($message->type, $capabilities)) {
                             $missing[$message->type] = true;
                         }
                     }
                 }
                 foreach ($this->constraints as $name => $constraint) {
                     if ($constraint['required']) {
                         if (!in_array($name, $capabilities) && !in_array($name, array_flip($capabilities))) {
                             $missing[$name] = true;
                         }
                     }
                 }
                 if (!empty($missing)) {
                     ksort($missing);
                     $this->reason = 'Required capability not offered - \'' . implode('\', \'', array_keys($missing)) . '\'';
                     $this->ok = false;
                 }
             }
 // Check for required services
             if ($this->ok) {
                 foreach ($this->requiredServices as $service) {
                     foreach ($service->formats as $format) {
                         if (!$this->findService($format, $service->actions)) {
                             if ($this->ok) {
                                 $this->reason = 'Required service(s) not offered - ';
                                 $this->ok = false;
                             } else {
                                 $this->reason .= ', ';
                             }
                             $this->reason .= "'{$format}' [" . implode(', ', $service->actions) . ']';
                         }
                     }
                 }
             }
             if ($this->ok) {
                 if ($_POST['lti_message_type'] === 'ToolProxyRegistrationRequest') {
                     $this->consumer->profile = $tcProfile;
                     $this->consumer->secret = $_POST['reg_password'];
                     $this->consumer->ltiVersion = $_POST['lti_version'];
                     $this->consumer->name = $tcProfile->product_instance->service_owner->service_owner_name->default_value;
                     $this->consumer->consumerName = $this->consumer->name;
                     $this->consumer->consumerVersion = "{$tcProfile->product_instance->product_info->product_family->code}-{$tcProfile->product_instance->product_info->product_version}";
                     $this->consumer->consumerGuid = $tcProfile->product_instance->guid;
                     $this->consumer->enabled = true;
                     $this->consumer->protected = true;
                     $doSaveConsumer = true;
                 }
             }
         } else if ($this->ok && !empty($_POST['custom_tc_profile_url']) && empty($this->consumer->profile)) {
             $http = new HTTPMessage($_POST['custom_tc_profile_url'], 'GET', null, 'Accept: application/vnd.ims.lti.v2.toolconsumerprofile+json');
             if ($http->send()) {
                 $tcProfile = json_decode($http->response);
                 if (!is_null($tcProfile)) {
                     $this->consumer->profile = $tcProfile;
                     $doSaveConsumer = true;
                 }
             }
         }
 
 // Validate message parameter constraints
         if ($this->ok) {
             $invalidParameters = array();
             foreach ($this->constraints as $name => $constraint) {
                 if (empty($constraint['messages']) || in_array($_POST['lti_message_type'], $constraint['messages'])) {
                     $ok = true;
                     if ($constraint['required']) {
                         if (!isset($_POST[$name]) || (strlen(trim($_POST[$name])) <= 0)) {
                             $invalidParameters[] = "{$name} (missing)";
                             $ok = false;
                         }
                     }
                     if ($ok && !is_null($constraint['max_length']) && isset($_POST[$name])) {
                         if (strlen(trim($_POST[$name])) > $constraint['max_length']) {
                             $invalidParameters[] = "{$name} (too long)";
                         }
                     }
                 }
             }
             if (count($invalidParameters) > 0) {
                 $this->ok = false;
                 if (empty($this->reason)) {
                     $this->reason = 'Invalid parameter(s): ' . implode(', ', $invalidParameters) . '.';
                 }
             }
         }
 
         if ($this->ok) {
 
 // Set the request context
             if (isset($_POST['context_id'])) {
                 $this->context = Context::fromConsumer($this->consumer, trim($_POST['context_id']));
                 $title = '';
                 if (isset($_POST['context_title'])) {
                     $title = trim($_POST['context_title']);
                 }
                 if (empty($title)) {
                     $title = "Course {$this->context->getId()}";
                 }
                 $this->context->title = $title;
             }
 
 // Set the request resource link
             if (isset($_POST['resource_link_id'])) {
                 $contentItemId = '';
                 if (isset($_POST['custom_content_item_id'])) {
                     $contentItemId = $_POST['custom_content_item_id'];
                 }
                 $this->resourceLink = ResourceLink::fromConsumer($this->consumer, trim($_POST['resource_link_id']), $contentItemId);
                 if (!empty($this->context)) {
                     $this->resourceLink->setContextId($this->context->getRecordId());
                 }
                 $title = '';
                 if (isset($_POST['resource_link_title'])) {
                     $title = trim($_POST['resource_link_title']);
                 }
                 if (empty($title)) {
                     $title = "Resource {$this->resourceLink->getId()}";
                 }
                 $this->resourceLink->title = $title;
 // Delete any existing custom parameters
                 foreach ($this->consumer->getSettings() as $name => $value) {
                     if (strpos($name, 'custom_') === 0) {
                         $this->consumer->setSetting($name);
                         $doSaveConsumer = true;
                     }
                 }
                 if (!empty($this->context)) {
                     foreach ($this->context->getSettings() as $name => $value) {
                         if (strpos($name, 'custom_') === 0) {
                             $this->context->setSetting($name);
                         }
                     }
                 }
                 foreach ($this->resourceLink->getSettings() as $name => $value) {
                     if (strpos($name, 'custom_') === 0) {
                         $this->resourceLink->setSetting($name);
                     }
                 }
 // Save LTI parameters
                 foreach (self::$LTI_CONSUMER_SETTING_NAMES as $name) {
                     if (isset($_POST[$name])) {
                         $this->consumer->setSetting($name, $_POST[$name]);
                     } else {
                         $this->consumer->setSetting($name);
                     }
                 }
                 if (!empty($this->context)) {
                     foreach (self::$LTI_CONTEXT_SETTING_NAMES as $name) {
                         if (isset($_POST[$name])) {
                             $this->context->setSetting($name, $_POST[$name]);
                         } else {
                             $this->context->setSetting($name);
                         }
                     }
                 }
                 foreach (self::$LTI_RESOURCE_LINK_SETTING_NAMES as $name) {
                     if (isset($_POST[$name])) {
                         $this->resourceLink->setSetting($name, $_POST[$name]);
                     } else {
                         $this->resourceLink->setSetting($name);
                     }
                 }
 // Save other custom parameters
                 foreach ($_POST as $name => $value) {
                     if ((strpos($name, 'custom_') === 0) &&
                         !in_array($name, array_merge(self::$LTI_CONSUMER_SETTING_NAMES, self::$LTI_CONTEXT_SETTING_NAMES, self::$LTI_RESOURCE_LINK_SETTING_NAMES))) {
                         $this->resourceLink->setSetting($name, $value);
                     }
                 }
             }
 
 // Set the user instance
             $userId = '';
             if (isset($_POST['user_id'])) {
                 $userId = trim($_POST['user_id']);
             }
 
             $this->user = User::fromResourceLink($this->resourceLink, $userId);
 
 // Set the user name
             $firstname = (isset($_POST['lis_person_name_given'])) ? $_POST['lis_person_name_given'] : '';
             $lastname = (isset($_POST['lis_person_name_family'])) ? $_POST['lis_person_name_family'] : '';
             $fullname = (isset($_POST['lis_person_name_full'])) ? $_POST['lis_person_name_full'] : '';
             $this->user->setNames($firstname, $lastname, $fullname);
 
 // Set the user email
             $email = (isset($_POST['lis_person_contact_email_primary'])) ? $_POST['lis_person_contact_email_primary'] : '';
             $this->user->setEmail($email, $this->defaultEmail);
 
 // Set the user image URI
             if (isset($_POST['user_image'])) {
                 $this->user->image = $_POST['user_image'];
             }
 
 // Set the user roles
             if (isset($_POST['roles'])) {
                 $this->user->roles = self::parseRoles($_POST['roles']);
             }
 
 // Initialise the consumer and check for changes
             $this->consumer->defaultEmail = $this->defaultEmail;
             if ($this->consumer->ltiVersion !== $_POST['lti_version']) {
                 $this->consumer->ltiVersion = $_POST['lti_version'];
                 $doSaveConsumer = true;
             }
             if (isset($_POST['tool_consumer_instance_name'])) {
                 if ($this->consumer->consumerName !== $_POST['tool_consumer_instance_name']) {
                     $this->consumer->consumerName = $_POST['tool_consumer_instance_name'];
                     $doSaveConsumer = true;
                 }
             }
             if (isset($_POST['tool_consumer_info_product_family_code'])) {
                 $version = $_POST['tool_consumer_info_product_family_code'];
                 if (isset($_POST['tool_consumer_info_version'])) {
                     $version .= "-{$_POST['tool_consumer_info_version']}";
                 }
 // do not delete any existing consumer version if none is passed
                 if ($this->consumer->consumerVersion !== $version) {
                     $this->consumer->consumerVersion = $version;
                     $doSaveConsumer = true;
                 }
             } else if (isset($_POST['ext_lms']) && ($this->consumer->consumerName !== $_POST['ext_lms'])) {
                 $this->consumer->consumerVersion = $_POST['ext_lms'];
                 $doSaveConsumer = true;
             }
             if (isset($_POST['tool_consumer_instance_guid'])) {
                 if (is_null($this->consumer->consumerGuid)) {
                     $this->consumer->consumerGuid = $_POST['tool_consumer_instance_guid'];
                     $doSaveConsumer = true;
                 } else if (!$this->consumer->protected) {
                     $doSaveConsumer = ($this->consumer->consumerGuid !== $_POST['tool_consumer_instance_guid']);
                     if ($doSaveConsumer) {
                         $this->consumer->consumerGuid = $_POST['tool_consumer_instance_guid'];
                     }
                 }
             }
             if (isset($_POST['launch_presentation_css_url'])) {
                 if ($this->consumer->cssPath !== $_POST['launch_presentation_css_url']) {
                     $this->consumer->cssPath = $_POST['launch_presentation_css_url'];
                     $doSaveConsumer = true;
                 }
             } else if (isset($_POST['ext_launch_presentation_css_url']) &&
                  ($this->consumer->cssPath !== $_POST['ext_launch_presentation_css_url'])) {
                 $this->consumer->cssPath = $_POST['ext_launch_presentation_css_url'];
                 $doSaveConsumer = true;
             } else if (!empty($this->consumer->cssPath)) {
                 $this->consumer->cssPath = null;
                 $doSaveConsumer = true;
             }
         }
 
 // Persist changes to consumer
         if ($doSaveConsumer) {
             $this->consumer->save();
         }
         if ($this->ok && isset($this->context)) {
             $this->context->save();
         }
         if ($this->ok && isset($this->resourceLink)) {
 
 // Check if a share arrangement is in place for this resource link
             $this->ok = $this->checkForShare();
 
 // Persist changes to resource link
             $this->resourceLink->save();
 
 // Save the user instance
             if (isset($_POST['lis_result_sourcedid'])) {
                 if ($this->user->ltiResultSourcedId !== $_POST['lis_result_sourcedid']) {
                     $this->user->ltiResultSourcedId = $_POST['lis_result_sourcedid'];
                     $this->user->save();
                 }
             } else if (!empty($this->user->ltiResultSourcedId)) {
                 $this->user->ltiResultSourcedId = '';
                 $this->user->save();
             }
         }
 
         return $this->ok;
 
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkForShare()

IMSGlobal\LTI\ToolProvider\ToolProvider::checkForShare ( )

private

Check if a share arrangement is in place.

Returns: boolean True if no error is reported

Definition at line 1175 of file ToolProvider.php.

References $_POST, IMSGlobal\LTI\ToolProvider\ToolProvider\$consumer, $id, $key, IMSGlobal\LTI\ToolProvider\ToolProvider\$ok, IMSGlobal\LTI\ToolProvider\ToolProvider\$resourceLink, IMSGlobal\LTI\ToolProvider\ResourceLink\fromConsumer(), time, and user().

Referenced by IMSGlobal\LTI\ToolProvider\ToolProvider\authenticate().

     {
 
         $ok = true;
         $doSaveResourceLink = true;
 
         $id = $this->resourceLink->primaryResourceLinkId;
 
         $shareRequest = isset($_POST['custom_share_key']) && !empty($_POST['custom_share_key']);
         if ($shareRequest) {
             if (!$this->allowSharing) {
                 $ok = false;
                 $this->reason = 'Your sharing request has been refused because sharing is not being permitted.';
             } else {
 // Check if this is a new share key
                 $shareKey = new ResourceLinkShareKey($this->resourceLink, $_POST['custom_share_key']);
                 if (!is_null($shareKey->primaryConsumerKey) && !is_null($shareKey->primaryResourceLinkId)) {
 // Update resource link with sharing primary resource link details
                     $key = $shareKey->primaryConsumerKey;
                     $id = $shareKey->primaryResourceLinkId;
                     $ok = ($key !== $this->consumer->getKey()) || ($id != $this->resourceLink->getId());
                     if ($ok) {
                         $this->resourceLink->primaryConsumerKey = $key;
                         $this->resourceLink->primaryResourceLinkId = $id;
                         $this->resourceLink->shareApproved = $shareKey->autoApprove;
                         $ok = $this->resourceLink->save();
                         if ($ok) {
                             $doSaveResourceLink = false;
                             $this->user->getResourceLink()->primaryConsumerKey = $key;
                             $this->user->getResourceLink()->primaryResourceLinkId = $id;
                             $this->user->getResourceLink()->shareApproved = $shareKey->autoApprove;
                             $this->user->getResourceLink()->updated = time();
 // Remove share key
                             $shareKey->delete();
                         } else {
                             $this->reason = 'An error occurred initialising your share arrangement.';
                         }
                     } else {
                         $this->reason = 'It is not possible to share your resource link with yourself.';
                     }
                 }
                 if ($ok) {
                     $ok = !is_null($key);
                     if (!$ok) {
                         $this->reason = 'You have requested to share a resource link but none is available.';
                     } else {
                         $ok = (!is_null($this->user->getResourceLink()->shareApproved) && $this->user->getResourceLink()->shareApproved);
                         if (!$ok) {
                             $this->reason = 'Your share request is waiting to be approved.';
                         }
                     }
                 }
             }
         } else {
 // Check no share is in place
             $ok = is_null($id);
             if (!$ok) {
                 $this->reason = 'You have not requested to share a resource link but an arrangement is currently in place.';
             }
         }
 
 // Look up primary resource link
         if ($ok && !is_null($id)) {
             $consumer = new ToolConsumer($key, $this->dataConnector);
             $ok = !is_null($consumer->created);
             if ($ok) {
                 $resourceLink = ResourceLink::fromConsumer($consumer, $id);
                 $ok = !is_null($resourceLink->created);
             }
             if ($ok) {
                 if ($doSaveResourceLink) {
                     $this->resourceLink->save();
                 }
                 $this->resourceLink = $resourceLink;
             } else {
                 $this->reason = 'Unable to load resource link being shared.';
             }
         }
 
         return $ok;
 
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkValue()

IMSGlobal\LTI\ToolProvider\ToolProvider::checkValue	(	$value,
		$values,
		$reason
	)

private

Validate a parameter value from an array of permitted values.

Returns: boolean True if value is valid

Definition at line 1263 of file ToolProvider.php.

References IMSGlobal\LTI\ToolProvider\ToolProvider\$ok, and IMSGlobal\LTI\ToolProvider\ToolProvider\$reason.

Referenced by IMSGlobal\LTI\ToolProvider\ToolProvider\authenticate().

     {
 
         $ok = in_array($value, $values);
         if (!$ok && !empty($reason)) {
             $this->reason = sprintf($reason, $value);
         }
 
         return $ok;
 
     }

Here is the caller graph for this function:

◆ doCallback()

IMSGlobal\LTI\ToolProvider\ToolProvider::doCallback ( $method = null )

private

Call any callback function for the requested action.

This function may set the redirect_url and output properties.

Returns: boolean True if no error reported

Definition at line 583 of file ToolProvider.php.

References $_POST, and $result.

Referenced by IMSGlobal\LTI\ToolProvider\ToolProvider\handleRequest(), and IMSGlobal\LTI\ToolProvider\ToolProvider\onError().

     {
 
         $callback = $method;
         if (is_null($callback)) {
             $callback = self::$METHOD_NAMES[$_POST['lti_message_type']];
         }
         if (method_exists($this, $callback)) {
             $result = $this->$callback();
         } else if (is_null($method) && $this->ok) {
             $this->ok = false;
             $this->reason = "Message type not supported: {$_POST['lti_message_type']}";
         }
         if ($this->ok && ($_POST['lti_message_type'] == 'ToolProxyRegistrationRequest')) {
             $this->consumer->save();
         }
 
     }

Here is the caller graph for this function:

◆ doToolProxyService()

IMSGlobal\LTI\ToolProvider\ToolProvider::doToolProxyService ( )

Send the tool proxy to the Tool Consumer.

Returns: boolean True if the tool proxy was accepted

Definition at line 423 of file ToolProvider.php.

References $http, IMSGlobal\LTI\ToolProvider\ToolProvider\$ok, $secret, array, IMSGlobal\LTI\ToolProvider\ToolProvider\findService(), and IMSGlobal\LTI\ToolProvider\DataConnector\DataConnector\getRandomString().

     {
 
 // Create tool proxy
         $toolProxyService = $this->findService('application/vnd.ims.lti.v2.toolproxy+json', array('POST'));
         $secret = DataConnector::getRandomString(12);
         $toolProxy = new MediaType\ToolProxy($this, $toolProxyService, $secret);
         $http = $this->consumer->doServiceRequest($toolProxyService, 'POST', 'application/vnd.ims.lti.v2.toolproxy+json', json_encode($toolProxy));
         $ok = $http->ok && ($http->status == 201) && isset($http->responseJson->tool_proxy_guid) && (strlen($http->responseJson->tool_proxy_guid) > 0);
         if ($ok) {
             $this->consumer->setKey($http->responseJson->tool_proxy_guid);
             $this->consumer->secret = $toolProxy->security_contract->shared_secret;
             $this->consumer->toolProxy = json_encode($toolProxy);
             $this->consumer->save();
         }
 
         return $ok;
 
     }

Here is the call graph for this function:

◆ findService()

IMSGlobal\LTI\ToolProvider\ToolProvider::findService	(	$format,
		$methods
	)

Find an offered service based on a media type and HTTP action(s)

Parameters

string	$format	Media type required
array	$methods	Array of HTTP actions required

Returns: object The service object

Definition at line 388 of file ToolProvider.php.

References $format, $n, $service, and array.

Referenced by IMSGlobal\LTI\ToolProvider\ToolProvider\authenticate(), and IMSGlobal\LTI\ToolProvider\ToolProvider\doToolProxyService().

     {
 
         $found = false;
         $services = $this->consumer->profile->service_offered;
         if (is_array($services)) {
             $n = -1;
             foreach ($services as $service) {
                 $n++;
                 if (!is_array($service->format) || !in_array($format, $service->format)) {
                     continue;
                 }
                 $missing = array();
                 foreach ($methods as $method) {
                     if (!is_array($service->action) || !in_array($method, $service->action)) {
                         $missing[] = $method;
                     }
                 }
                 $methods = $missing;
                 if (count($methods) <= 0) {
                     $found = $service;
                     break;
                 }
             }
         }
 
         return $found;
 
     }

Here is the caller graph for this function:

◆ getConsumers()

IMSGlobal\LTI\ToolProvider\ToolProvider::getConsumers ( )

Get an array of defined tool consumers.

Returns: array Array of ToolConsumer objects

Definition at line 373 of file ToolProvider.php.

     {
 
         return $this->dataConnector->getToolConsumers();
 
     }

◆ handleRequest()

IMSGlobal\LTI\ToolProvider\ToolProvider::handleRequest ( )

Process an incoming request.

Definition at line 338 of file ToolProvider.php.

References IMSGlobal\LTI\ToolProvider\ToolProvider\authenticate(), IMSGlobal\LTI\ToolProvider\ToolProvider\doCallback(), and IMSGlobal\LTI\ToolProvider\ToolProvider\result().

     {
 
         if ($this->ok) {
             if ($this->authenticate()) {
                 $this->doCallback();
             }
         }
         $this->result();
 
     }

Here is the call graph for this function:

◆ onContentItem()

IMSGlobal\LTI\ToolProvider\ToolProvider::onContentItem ( )

protected

Process a valid content-item request.

Returns: boolean True if no error

Definition at line 542 of file ToolProvider.php.

References IMSGlobal\LTI\ToolProvider\ToolProvider\onError().

     {
 
         $this->onError();
 
     }

Here is the call graph for this function:

◆ onError()

IMSGlobal\LTI\ToolProvider\ToolProvider::onError ( )

protected

Process a response to an invalid request.

Returns: boolean True if no further error processing required

Definition at line 565 of file ToolProvider.php.

References IMSGlobal\LTI\ToolProvider\ToolProvider\doCallback().

Referenced by IMSGlobal\LTI\ToolProvider\ToolProvider\onContentItem(), IMSGlobal\LTI\ToolProvider\ToolProvider\onLaunch(), IMSGlobal\LTI\ToolProvider\ToolProvider\onRegister(), and IMSGlobal\LTI\ToolProvider\ToolProvider\result().

     {
 
         $this->doCallback('onError');
 
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ onLaunch()

IMSGlobal\LTI\ToolProvider\ToolProvider::onLaunch ( )

protected

Process a valid launch request.

Returns: boolean True if no error

Definition at line 530 of file ToolProvider.php.

References IMSGlobal\LTI\ToolProvider\ToolProvider\onError().

     {
 
         $this->onError();
 
     }

Here is the call graph for this function:

◆ onRegister()

IMSGlobal\LTI\ToolProvider\ToolProvider::onRegister ( )

protected

Process a valid tool proxy registration request.

Returns: boolean True if no error

Definition at line 554 of file ToolProvider.php.

References IMSGlobal\LTI\ToolProvider\ToolProvider\onError().

                                     {
 
         $this->onError();
 
     }

Here is the call graph for this function:

◆ parseRoles()

static IMSGlobal\LTI\ToolProvider\ToolProvider::parseRoles ( $roles )

static

Get an array of fully qualified user roles.

Parameters

mixed $roles Comma-separated list of roles or array of roles

Returns: array Array of roles

Definition at line 450 of file ToolProvider.php.

References array.

Referenced by IMSGlobal\LTI\ToolProvider\ResourceLink\doMembershipsService(), and IMSGlobal\LTI\ToolProvider\Service\Membership\get().

     {
 
         if (!is_array($roles)) {
             $roles = explode(',', $roles);
         }
         $parsedRoles = array();
         foreach ($roles as $role) {
             $role = trim($role);
             if (!empty($role)) {
                 if (substr($role, 0, 4) !== 'urn:') {
                     $role = 'urn:lti:role:ims/lis/' . $role;
                 }
                 $parsedRoles[] = $role;
             }
         }
 
         return $parsedRoles;
 
     }

Here is the caller graph for this function:

◆ result()

IMSGlobal\LTI\ToolProvider\ToolProvider::result ( )

private

Perform the result of an action.

This function may redirect the user to another URL rather than returning a value.

Returns: string Output to be displayed (redirection, or display HTML or message)

Definition at line 609 of file ToolProvider.php.

References $_POST, IMSGlobal\LTI\ToolProvider\ToolProvider\$errorOutput, IMSGlobal\LTI\ToolProvider\ToolProvider\$ok, IMSGlobal\LTI\ToolProvider\ToolProvider\$output, IMSGlobal\LTI\ToolProvider\ToolProvider\$returnUrl, $version, array, exit, header, and IMSGlobal\LTI\ToolProvider\ToolProvider\onError().

Referenced by IMSGlobal\LTI\ToolProvider\ToolProvider\handleRequest().

     {
 
         $ok = false;
         if (!$this->ok) {
             $ok = $this->onError();
         }
         if (!$ok) {
             if (!$this->ok) {
 
 // If not valid, return an error message to the tool consumer if a return URL is provided
                 if (!empty($this->returnUrl)) {
                     $errorUrl = $this->returnUrl;
                     if (strpos($errorUrl, '?') === false) {
                         $errorUrl .= '?';
                     } else {
                         $errorUrl .= '&';
                     }
                     if ($this->debugMode && !is_null($this->reason)) {
                         $errorUrl .= 'lti_errormsg=' . urlencode("Debug error: $this->reason");
                     } else {
                         $errorUrl .= 'lti_errormsg=' . urlencode($this->message);
                         if (!is_null($this->reason)) {
                             $errorUrl .= '&lti_errorlog=' . urlencode("Debug error: $this->reason");
                         }
                     }
                     if (!is_null($this->consumer) && isset($_POST['lti_message_type']) && ($_POST['lti_message_type'] === 'ContentItemSelectionRequest')) {
                         $formParams = array();
                         if (isset($_POST['data'])) {
                             $formParams['data'] = $_POST['data'];
                         }
                         $version = (isset($_POST['lti_version'])) ? $_POST['lti_version'] : self::LTI_VERSION1;
                         $formParams = $this->consumer->signParameters($errorUrl, 'ContentItemSelection', $version, $formParams);
                         $page = self::sendForm($errorUrl, $formParams);
                         echo $page;
                     } else {
                         header("Location: {$errorUrl}");
                     }
                     exit;
                 } else {
                     if (!is_null($this->errorOutput)) {
                         echo $this->errorOutput;
                     } else if ($this->debugMode && !empty($this->reason)) {
                         echo "Debug error: {$this->reason}";
                     } else {
                         echo "Error: {$this->message}";
                     }
                 }
             } else if (!is_null($this->redirectUrl)) {
                 header("Location: {$this->redirectUrl}");
                 exit;
             } else if (!is_null($this->output)) {
                 echo $this->output;
             }
         }
 
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendForm()

static IMSGlobal\LTI\ToolProvider\ToolProvider::sendForm	(	$url,
		$params,
		$target = `''`
	)

static

Generate a web page containing an auto-submitted form of parameters.

Parameters

string	$url	URL to which the form should be submitted
array	$params	Array of form parameters
string	$target	Name of target (optional)

Returns: string

Definition at line 479 of file ToolProvider.php.

References $key, $params, EOD, and html().

     {
 
         $page = <<< EOD
 <html>
 <head>
 <title>IMS LTI message</title>
 <script type="text/javascript">
 //<![CDATA[
 function doOnLoad() {
     document.forms[0].submit();
 }
 
 window.onload=doOnLoad;
 //]]>
 </script>
 </head>
 <body>
 <form action="{$url}" method="post" target="" encType="application/x-www-form-urlencoded">
 
 EOD;
 
         foreach($params as $key => $value ) {
             $key = htmlentities($key, ENT_COMPAT | ENT_HTML401, 'UTF-8');
             $value = htmlentities($value, ENT_COMPAT | ENT_HTML401, 'UTF-8');
             $page .= <<< EOD
     <input type="hidden" name="{$key}" value="{$value}" />
 
 EOD;
 
         }
 
         $page .= <<< EOD
 </form>
 </body>
 </html>
 EOD;
 
         return $page;
 
     }

Here is the call graph for this function:

◆ setParameterConstraint()

IMSGlobal\LTI\ToolProvider\ToolProvider::setParameterConstraint	(	$name,
		$required = `true`,
		$maxLength = `null`,
		$messageTypes = `null`
	)

Add a parameter constraint to be checked on launch.

Parameters

string	$name	Name of parameter to be checked
boolean	$required	True if parameter is required (optional, default is true)
int	$maxLength	Maximum permitted length of parameter value (optional, default is null)
array	$messageTypes	Array of message types to which the constraint applies (optional, default is all)

Definition at line 358 of file ToolProvider.php.

References $name, and array.

     {
 
         $name = trim($name);
         if (strlen($name) > 0) {
             $this->constraints[$name] = array('required' => $required, 'max_length' => $maxLength, 'messages' => $messageTypes);
         }
 
     }

Field Documentation

◆ $allowSharing

boolean IMSGlobal\LTI\ToolProvider\ToolProvider::$allowSharing = false

Whether shared resource link arrangements are permitted.

Definition at line 200 of file ToolProvider.php.

◆ $baseUrl

string IMSGlobal\LTI\ToolProvider\ToolProvider::$baseUrl = null

Base URL for tool provider service.

Definition at line 224 of file ToolProvider.php.

◆ $callbackHandler

array IMSGlobal\LTI\ToolProvider\ToolProvider::$callbackHandler = null

private

Callback functions for handling requests.

Definition at line 298 of file ToolProvider.php.

◆ $constraints

array IMSGlobal\LTI\ToolProvider\ToolProvider::$constraints = null

private

LTI parameter constraints for auto validation checks.

Definition at line 304 of file ToolProvider.php.

◆ $consumer

ToolConsumer IMSGlobal\LTI\ToolProvider\ToolProvider::$consumer = null

Tool Consumer object.

Definition at line 152 of file ToolProvider.php.

Referenced by IMSGlobal\LTI\ToolProvider\ToolProvider\authenticate(), and IMSGlobal\LTI\ToolProvider\ToolProvider\checkForShare().

◆ $context

Context IMSGlobal\LTI\ToolProvider\ToolProvider::$context = null

Context object.

Definition at line 176 of file ToolProvider.php.

◆ $CUSTOM_SUBSTITUTION_VARIABLES

array IMSGlobal\LTI\ToolProvider\ToolProvider::$CUSTOM_SUBSTITUTION_VARIABLES

staticprivate

Names of LTI custom parameter substitution variables (or capabilities) and their associated default message parameter names.

Definition at line 106 of file ToolProvider.php.

◆ $dataConnector

DataConnector IMSGlobal\LTI\ToolProvider\ToolProvider::$dataConnector = null

Data connector object.

Definition at line 182 of file ToolProvider.php.

Referenced by IMSGlobal\LTI\ToolProvider\ToolProvider\__construct().

◆ $debugMode

boolean IMSGlobal\LTI\ToolProvider\ToolProvider::$debugMode = false

protected

Whether debug messages explaining the cause of errors are to be returned to the tool consumer.

Definition at line 291 of file ToolProvider.php.

◆ $defaultEmail

string IMSGlobal\LTI\ToolProvider\ToolProvider::$defaultEmail = ''

Default email domain.

Definition at line 188 of file ToolProvider.php.

Referenced by IMSGlobal\LTI\ToolProvider\ToolProvider\authenticate().

◆ $details

array IMSGlobal\LTI\ToolProvider\ToolProvider::$details = array()

Details for error message relating to last request processed.

Definition at line 218 of file ToolProvider.php.

◆ $documentTargets

string IMSGlobal\LTI\ToolProvider\ToolProvider::$documentTargets = null

protected

URL to redirect user to on successful completion of the request.

Definition at line 273 of file ToolProvider.php.

Referenced by IMSGlobal\LTI\ToolProvider\ToolProvider\authenticate().

◆ $errorOutput

string IMSGlobal\LTI\ToolProvider\ToolProvider::$errorOutput = null

protected

HTML to be displayed on an unsuccessful completion of the request and no return URL is available.

Definition at line 285 of file ToolProvider.php.

Referenced by IMSGlobal\LTI\ToolProvider\ToolProvider\result().

◆ $idScope

int IMSGlobal\LTI\ToolProvider\ToolProvider::$idScope = self::ID_SCOPE_ID_ONLY

Scope to use for user IDs.

Definition at line 194 of file ToolProvider.php.

◆ $LTI_CONSUMER_SETTING_NAMES

array IMSGlobal\LTI\ToolProvider\ToolProvider::$LTI_CONSUMER_SETTING_NAMES = array('custom_tc_profile_url', 'custom_system_setting_url')

staticprivate

Names of LTI parameters to be retained in the consumer settings property.

Definition at line 81 of file ToolProvider.php.

◆ $LTI_CONTEXT_SETTING_NAMES

array IMSGlobal\LTI\ToolProvider\ToolProvider::$LTI_CONTEXT_SETTING_NAMES

staticprivate

Initial value:

= array('custom_context_setting_url',
                                                      'custom_lineitems_url', 'custom_results_url',
                                                      'custom_context_memberships_url')

Names of LTI parameters to be retained in the context settings property.

Definition at line 87 of file ToolProvider.php.

◆ $LTI_RESOURCE_LINK_SETTING_NAMES

array IMSGlobal\LTI\ToolProvider\ToolProvider::$LTI_RESOURCE_LINK_SETTING_NAMES

staticprivate

Initial value:

= array('lis_result_sourcedid', 'lis_outcome_service_url',
                                                            'ext_ims_lis_basic_outcome_url', 'ext_ims_lis_resultvalue_sourcedids',
                                                            'ext_ims_lis_memberships_id', 'ext_ims_lis_memberships_url',
                                                            'ext_ims_lti_tool_setting', 'ext_ims_lti_tool_setting_id', 'ext_ims_lti_tool_setting_url',
                                                            'custom_link_setting_url',
                                                            'custom_lineitem_url', 'custom_result_url')

Names of LTI parameters to be retained in the resource link settings property.

Definition at line 95 of file ToolProvider.php.

◆ $LTI_VERSIONS

IMSGlobal\LTI\ToolProvider\ToolProvider::$LTI_VERSIONS = array(self::LTI_VERSION1, self::LTI_VERSION2)

staticprivate

Permitted LTI versions for messages.

Definition at line 61 of file ToolProvider.php.

◆ $mediaTypes

string IMSGlobal\LTI\ToolProvider\ToolProvider::$mediaTypes = null

protected

URL to redirect user to on successful completion of the request.

Definition at line 267 of file ToolProvider.php.

Referenced by IMSGlobal\LTI\ToolProvider\ToolProvider\authenticate().

◆ $message

string IMSGlobal\LTI\ToolProvider\ToolProvider::$message = self::CONNECTION_ERROR_MESSAGE

Message for last request processed.

Definition at line 206 of file ToolProvider.php.

Referenced by IMSGlobal\LTI\ToolProvider\ToolProvider\authenticate().

◆ $MESSAGE_TYPES

IMSGlobal\LTI\ToolProvider\ToolProvider::$MESSAGE_TYPES

staticprivate

Initial value:

= array('basic-lti-launch-request' => 'onLaunch',
                                          'ContentItemSelectionRequest' => 'onContentItem',
                                          'ToolProxyRegistrationRequest' => 'register')

List of supported message types and associated class methods.

Definition at line 65 of file ToolProvider.php.

◆ $METHOD_NAMES

array IMSGlobal\LTI\ToolProvider\ToolProvider::$METHOD_NAMES

staticprivate

Initial value:

= array('basic-lti-launch-request' => 'onLaunch',
                                         'ContentItemSelectionRequest' => 'onContentItem',
                                         'ToolProxyRegistrationRequest' => 'onRegister')

List of supported message types and associated class methods.

Definition at line 73 of file ToolProvider.php.

◆ $ok

boolean IMSGlobal\LTI\ToolProvider\ToolProvider::$ok = true

True if the last request was successful.

Definition at line 146 of file ToolProvider.php.

Referenced by IMSGlobal\LTI\ToolProvider\ToolProvider\authenticate(), IMSGlobal\LTI\ToolProvider\ToolProvider\checkForShare(), IMSGlobal\LTI\ToolProvider\ToolProvider\checkValue(), IMSGlobal\LTI\ToolProvider\ToolProvider\doToolProxyService(), and IMSGlobal\LTI\ToolProvider\ToolProvider\result().

◆ $optionalServices

array IMSGlobal\LTI\ToolProvider\ToolProvider::$optionalServices = null

Optional services used by Tool Provider.

Definition at line 248 of file ToolProvider.php.

◆ $output

string IMSGlobal\LTI\ToolProvider\ToolProvider::$output = null

protected

HTML to be displayed on a successful completion of the request.

Definition at line 279 of file ToolProvider.php.

Referenced by IMSGlobal\LTI\ToolProvider\ToolProvider\result().

◆ $product

Item IMSGlobal\LTI\ToolProvider\ToolProvider::$product = null

Product details.

Definition at line 236 of file ToolProvider.php.

◆ $reason

string IMSGlobal\LTI\ToolProvider\ToolProvider::$reason = null

Error message for last request processed.

Definition at line 212 of file ToolProvider.php.

Referenced by IMSGlobal\LTI\ToolProvider\ToolProvider\checkValue().

◆ $redirectUrl

string IMSGlobal\LTI\ToolProvider\ToolProvider::$redirectUrl = null

protected

URL to redirect user to on successful completion of the request.

Definition at line 261 of file ToolProvider.php.

◆ $requiredServices

array IMSGlobal\LTI\ToolProvider\ToolProvider::$requiredServices = null

Services required by Tool Provider.

Definition at line 242 of file ToolProvider.php.

◆ $resourceHandlers

array IMSGlobal\LTI\ToolProvider\ToolProvider::$resourceHandlers = null

Resource handlers for Tool Provider.

Definition at line 254 of file ToolProvider.php.

◆ $resourceLink

ResourceLink IMSGlobal\LTI\ToolProvider\ToolProvider::$resourceLink = null

Resource link object.

Definition at line 170 of file ToolProvider.php.

Referenced by IMSGlobal\LTI\ToolProvider\ToolProvider\checkForShare().

◆ $returnUrl

string IMSGlobal\LTI\ToolProvider\ToolProvider::$returnUrl = null

Return URL provided by tool consumer.

Definition at line 158 of file ToolProvider.php.

Referenced by IMSGlobal\LTI\ToolProvider\ToolProvider\result().

◆ $user

User IMSGlobal\LTI\ToolProvider\ToolProvider::$user = null

User object.

Definition at line 164 of file ToolProvider.php.

◆ $vendor

Item IMSGlobal\LTI\ToolProvider\ToolProvider::$vendor = null

Vendor details.

Definition at line 230 of file ToolProvider.php.

◆ CONNECTION_ERROR_MESSAGE

const IMSGlobal\LTI\ToolProvider\ToolProvider::CONNECTION_ERROR_MESSAGE = 'Sorry, there was an error connecting you to the application.'

Default connection error message.

Definition at line 27 of file ToolProvider.php.

◆ ID_SCOPE_CONTEXT

const IMSGlobal\LTI\ToolProvider\ToolProvider::ID_SCOPE_CONTEXT = 2

Prefix the ID with the consumer key and context ID.

Definition at line 48 of file ToolProvider.php.

Referenced by IMSGlobal\LTI\ToolProvider\User\getId().

◆ ID_SCOPE_GLOBAL

const IMSGlobal\LTI\ToolProvider\ToolProvider::ID_SCOPE_GLOBAL = 1

Prefix an ID with the consumer key.

Definition at line 44 of file ToolProvider.php.

Referenced by IMSGlobal\LTI\ToolProvider\User\getId().

◆ ID_SCOPE_ID_ONLY

const IMSGlobal\LTI\ToolProvider\ToolProvider::ID_SCOPE_ID_ONLY = 0

Use ID value only.

Definition at line 40 of file ToolProvider.php.

Referenced by IMSGlobal\LTI\ToolProvider\User\getId(), IMSGlobal\LTI\ToolProvider\ToolConsumer\initialize(), IMSGlobal\LTI\ToolProvider\DataConnector\DataConnector_mysql\loadUser(), IMSGlobal\LTI\ToolProvider\DataConnector\DataConnector_pdo\loadUser(), IMSGlobal\LTI\ToolProvider\DataConnector\DataConnector_mysql\saveUser(), and IMSGlobal\LTI\ToolProvider\DataConnector\DataConnector_pdo\saveUser().

◆ ID_SCOPE_RESOURCE

const IMSGlobal\LTI\ToolProvider\ToolProvider::ID_SCOPE_RESOURCE = 3

Prefix the ID with the consumer key and resource ID.

Definition at line 52 of file ToolProvider.php.

Referenced by IMSGlobal\LTI\ToolProvider\ResourceLink\doMembershipsService(), IMSGlobal\LTI\ToolProvider\Service\Membership\get(), and IMSGlobal\LTI\ToolProvider\User\getId().

◆ ID_SCOPE_SEPARATOR

const IMSGlobal\LTI\ToolProvider\ToolProvider::ID_SCOPE_SEPARATOR = ':'

Character used to separate each element of an ID.

Definition at line 56 of file ToolProvider.php.

Referenced by IMSGlobal\LTI\ToolProvider\User\getId().

◆ LTI_VERSION1

const IMSGlobal\LTI\ToolProvider\ToolProvider::LTI_VERSION1 = 'LTI-1p0'

LTI version 1 for messages.

Definition at line 32 of file ToolProvider.php.

◆ LTI_VERSION2

const IMSGlobal\LTI\ToolProvider\ToolProvider::LTI_VERSION2 = 'LTI-2p0'

LTI version 2 for messages.

Definition at line 36 of file ToolProvider.php.

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

libs/composer/vendor/imsglobal/lti/src/ToolProvider/ToolProvider.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ authenticate()

◆ checkForShare()

◆ checkValue()

◆ doCallback()

◆ doToolProxyService()

◆ findService()

◆ getConsumers()

◆ handleRequest()

◆ onContentItem()

◆ onError()

◆ onLaunch()

◆ onRegister()

◆ parseRoles()

◆ result()

◆ sendForm()

◆ setParameterConstraint()

Field Documentation

◆ $allowSharing

◆ $baseUrl

◆ $callbackHandler

◆ $constraints

◆ $consumer

◆ $context

◆ $CUSTOM_SUBSTITUTION_VARIABLES

◆ $dataConnector

◆ $debugMode

◆ $defaultEmail

◆ $details

◆ $documentTargets

◆ $errorOutput

◆ $idScope

◆ $LTI_CONSUMER_SETTING_NAMES

◆ $LTI_CONTEXT_SETTING_NAMES

◆ $LTI_RESOURCE_LINK_SETTING_NAMES

◆ $LTI_VERSIONS

◆ $mediaTypes

◆ $message

◆ $MESSAGE_TYPES

◆ $METHOD_NAMES

◆ $ok

◆ $optionalServices

◆ $output

◆ $product

◆ $reason

◆ $redirectUrl

◆ $requiredServices

◆ $resourceHandlers

◆ $resourceLink

◆ $returnUrl

◆ $user

◆ $vendor

◆ CONNECTION_ERROR_MESSAGE

◆ ID_SCOPE_CONTEXT

◆ ID_SCOPE_GLOBAL

◆ ID_SCOPE_ID_ONLY

◆ ID_SCOPE_RESOURCE

◆ ID_SCOPE_SEPARATOR

◆ LTI_VERSION1

◆ LTI_VERSION2