Class to represent an LTI Tool. More...

Inheritance diagram for Tool:

Public Member Functions
	__construct ($dataConnector=null)
	Class constructor.

	initialize ()
	Initialise the tool.

	save ()
	Save the tool to the database.

	delete ()
	Delete the tool from the database.

	getMessageParameters ($strictMode=false, $disableCookieCheck=false, $generateWarnings=false)
	Get the message parameters.

	handleRequest ($strictMode=false, $disableCookieCheck=false, $generateWarnings=false)
	Process an incoming request.

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

	getConsumers ()
	Get an array of defined tool consumers.

	getPlatforms ()
	Get an array of defined platforms.

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

	doToolProxyService ()
	Send the tool proxy to the platform.

Public Member Functions inherited from System
	getRecordId ()
	Get the system record ID.

	setRecordId ($id)
	Sets the system record ID.

	getKey ()
	Get the consumer key.

	setKey ($key)
	Set the consumer key.

	getSetting ($name, $default='')
	Get a setting value.

	setSetting ($name, $value=null)
	Set a setting value.

	getSettings ()
	Get an array of all setting values.

	setSettings ($settings)
	Set an array of all setting values.

	saveSettings ()
	Save setting values.

	hasJwt ()
	Check whether a JWT exists.

	getJwt ()
	Get the JWT.

	getRawParameters ()
	Get the raw POST parameters.

	getMessageClaims ($fullyQualified=false)
	Get the message claims.

	signParameters ($url, $type, $version, $params)
	Add the signature to an LTI message.

	signMessage (&$url, $type, $version, $params, $loginHint=null, $ltiMessageHint=null)
	Add the signature to an LTI message.

	sendMessage ($url, $type, $messageParams, $target='', $userId=null, $hint=null)
	Generate a web page containing an auto-submitted form of LTI message parameters.

	signServiceRequest ($url, $method, $type, $data=null)
	Generates the headers for an LTI service request.

	doServiceRequest ($service, $method, $format, $data)
	Perform a service request.

	useOAuth1 ()
	Determine whether this consumer is using the OAuth 1 security model.

	addSignature ($endpoint, $data, $method='POST', $type=null, $nonce='', $hash=null, $timestamp=null)
	Add the signature to an array of message parameters or to a header string.

	checkMessage ()
	Verify the required properties of an LTI message.

	verifySignature ()
	Verify the signature of a message.

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

static	fromConsumerKey ($key=null, $dataConnector=null, $autoEnable=false)
	Load the tool from the database by its consumer key.

static	fromInitiateLoginUrl ($initiateLoginUrl, $dataConnector=null, $autoEnable=false)
	Load the tool from the database by its initiate login URL.

static	fromRecordId ($id, $dataConnector)
	Load the tool from the database by its record ID.

Static Public Member Functions inherited from System
static	parseRoles ($roles, $ltiVersion=Util::LTI_VERSION1, $addPrincipalRole=false)
	Parse a set of roles to comply with a specified version of LTI.

Static Public Member Functions inherited from ApiHook
static	registerApiHook ($hookName, $familyCode, $className)
	Register the availability of an API hook.

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

const	ID_SCOPE_ID_ONLY = 0
	Use ID value only.

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

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

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

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

	$consumer = null
	Tool consumer object.

	$platform = null
	Platform object.

	$returnUrl = null
	Return URL provided by platform.

	$userResult = null
	UserResult object.

	$resourceLink = null
	Resource link object.

	$context = null
	Context object.

	$defaultEmail = ''
	Default email domain.

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

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

	$message = null
	Message for last request processed.

	$baseUrl = null
	Base URL for tool service.

	$vendor = null
	Vendor details.

	$product = null
	Product details.

	$requiredServices = null
	Services required by Tool.

	$optionalServices = null
	Optional services used by Tool.

	$resourceHandlers = null
	Resource handlers for Tool.

	$messageUrl = null
	Message URL for Tool.

	$initiateLoginUrl = null
	Initiate Login request URL for Tool.

	$redirectionUris = null
	Redirection URIs for Tool.

Data Fields inherited from System
	$ok = true
	True if the last request was successful.

	$ltiVersion = null
	LTI version.

	$name = null
	Local name of platform/tool.

	$secret = null
	Shared secret.

	$signatureMethod = 'HMAC-SHA1'
	Method used for signing messages.

	$encryptionMethod = ''
	Algorithm used for encrypting messages.

	$dataConnector = null
	Data connector object.

	$rsaKey = null
	RSA key in PEM or JSON format.

	$requiredScopes = array()
	Scopes to request when obtaining an access token.

	$kid = null
	Key ID.

	$jku = null
	Endpoint for public key.

	$reason = null
	Error message for last request processed.

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

	$warnings = array()
	Warnings relating to last request processed.

	$debugMode = false
	Whether debug level messages are to be reported.

	$enabled = false
	Whether the system instance is enabled to accept connection requests.

	$enableFrom = null
	Timestamp from which the the system instance is enabled to accept connection requests.

	$enableUntil = null
	Timestamp until which the system instance is enabled to accept connection requests.

	$lastAccess = null
	Timestamp for date of last connection to this system.

	$created = null
	Timestamp for when the object was created.

	$updated = null
	Timestamp for when the object was last updated.

Static Public Attributes
static	$MESSAGE_TYPES
	List of supported incoming message types.

static	$defaultTool = null
	Default tool for use with service requests.

static	$authenticateUsingGet = false
	Use GET method for authentication request messages when true.

static	$stateLife = 10
	Life in seconds for the state value issued during the OIDC login process.

static	$postMessageTimeoutDelay = 20
	Period in milliseconds to wait for a response to a postMessage.

Static Public Attributes inherited from ApiHook
static	$USER_ID_HOOK = "UserId"
	User Id hook name.

static	$CONTEXT_ID_HOOK = "ContextId"
	Context Id hook name.

static	$GROUPS_SERVICE_HOOK = "Groups"
	Course Groups service hook name.

static	$MEMBERSHIPS_SERVICE_HOOK = "Memberships"
	Memberships service hook name.

static	$OUTCOMES_SERVICE_HOOK = "Outcomes"
	Outcomes service hook name.

static	$TOOL_SETTINGS_SERVICE_HOOK = "ToolSettings"
	Tool Settings service hook name.

static	$ACCESS_TOKEN_SERVICE_HOOK = "AccessToken"
	Access Token service hook name.

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

	onConfigure ()
	Process a valid configure request.

	onDashboard ()
	Process a valid dashboard request.

	onContentItem ()
	Process a valid content-item request.

	onContentItemUpdate ()
	Process a valid content-item update request.

	onSubmissionReview ()
	Process a valid submission review request.

	onRegister ()
	Process a valid tool proxy registration request.

	onRegistration ()
	Process a dynamic registration request.

	onLtiStartProctoring ()
	Process a valid start proctoring request.

	onLtiEndAssessment ()
	Process a valid end assessment request.

	onInitiateLogin ($requestParameters, &$authParameters)
	Process a login initiation request.

	onAuthenticate ($state, $nonce, $usePlatformStorage)
	Process response to an authentication request.

	onResetSessionId ()
	Process a change in the session ID.

	onError ()
	Process a response to an invalid request.

	getPlatformConfiguration ()
	Fetch a platform's configuration data.

	getConfiguration ($platformConfig)
	Prepare the tool's configuration data.

	sendRegistration ($platformConfig, $toolConfig)
	Send the tool registration to the platform.

	getPlatformToRegister ($platformConfig, $registrationConfig, $doSave=true)
	Initialise the platform to be registered.

	getRegistrationResponsePage ($toolConfig)
	Prepare the page to complete a registration request.

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

	$mediaTypes = null
	Media types accepted by the platform.

	$contentTypes = null
	Content item types accepted by the platform.

	$fileTypes = null
	File types accepted by the platform.

	$documentTargets = null
	Document targets accepted by the platform.

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

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

Protected Attributes inherited from System
	$jwt = null
	JWT ClientInterface object.

	$rawParameters = null
	Raw message parameters.

	$messageParameters = null
	LTI message parameters.

Detailed Description

Class to represent an LTI Tool.

Author: Stephen P Vickers steph.nosp@m.en@s.nosp@m.pvsof.nosp@m.twar.nosp@m.eprod.nosp@m.ucts.nosp@m..com

Copyright: SPV Software Products

Licence: http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3

Definition at line 23 of file Tool.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( $dataConnector = null )

Class constructor.

Parameters

DataConnector $dataConnector Object containing a database connection object

Reimplemented in ToolProvider.

Definition at line 378 of file Tool.php.

References System\$dataConnector, Tool\$platform, Context\getDataConnector(), and Tool\initialize().

Member Function Documentation

◆ delete()

delete ( )

Delete the tool from the database.

Returns: bool True if the object was successfully deleted

Definition at line 434 of file Tool.php.

◆ doToolProxyService()

doToolProxyService ( )

Send the tool proxy to the platform.

Returns: bool True if the tool proxy was accepted

Definition at line 610 of file Tool.php.

References System\$ok, System\$secret, Tool\findService(), and Util\getRandomString().

◆ findService()

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 577 of file Tool.php.

Referenced by Tool\doToolProxyService().

◆ fromConsumerKey()

static fromConsumerKey	(	$key = `null`,
		$dataConnector = `null`,
		$autoEnable = `false`
	)

static

Load the tool from the database by its consumer key.

Parameters

string \| null	$key	Consumer key
DataConnector	$dataConnector	A data connector object
bool	$autoEnable	True if the tool is to be enabled automatically (optional, default is false)

Returns: Tool The tool object

Definition at line 1187 of file Tool.php.

References System\$dataConnector, and System\$ok.

◆ fromInitiateLoginUrl()

static fromInitiateLoginUrl	(	$initiateLoginUrl,
		$dataConnector = `null`,
		$autoEnable = `false`
	)

static

Load the tool from the database by its initiate login URL.

Parameters

string	$initiateLoginUrl	The initiate login URL
DataConnector	$dataConnector	A data connector object
bool	$autoEnable	True if the tool is to be enabled automatically (optional, default is false)

Returns: Tool The tool object

Definition at line 1210 of file Tool.php.

References System\$dataConnector, and Tool\$initiateLoginUrl.

◆ fromRecordId()

static fromRecordId	(	$id,
		$dataConnector
	)

static

Load the tool from the database by its record ID.

Parameters

int	$id	The tool record ID
DataConnector	$dataConnector	A data connector object

Returns: Tool The tool object

Definition at line 1231 of file Tool.php.

References System\$dataConnector.

◆ getConfiguration()

getConfiguration ( $platformConfig )

protected

Prepare the tool's configuration data.

Parameters

array $platformConfig Platform configuration data

Returns: array Tool configuration data

Definition at line 895 of file Tool.php.

References System\$jku, Tool\$message, System\$name, and Util\MESSAGE_TYPE_MAPPING.

Referenced by Tool\onRegistration().

◆ getConsumers()

getConsumers ( )

Get an array of defined tool consumers.

Deprecated:: Use getPlatforms() instead

See also: Tool::getPlatforms()

Returns: array Array of ToolConsumer objects

Definition at line 552 of file Tool.php.

References Tool\getPlatforms(), and Util\logDebug().

◆ getMessageParameters()

getMessageParameters	(	$strictMode = `false`,
		$disableCookieCheck = `false`,
		$generateWarnings = `false`
	)

Get the message parameters.

Parameters

bool	$strictMode	True if full compliance with the LTI specification is required (optional, default is false)
bool	$disableCookieCheck	True if no cookie check should be made (optional, default is false)
bool	$generateWarnings	True if warning messages should be generated (optional, default is false)

Returns: array The message parameter array

Definition at line 448 of file Tool.php.

References Util\$logLevel, System\$messageParameters, and Util\LOGLEVEL_DEBUG.

Referenced by Tool\handleRequest().

◆ getPlatformConfiguration()

getPlatformConfiguration ( )

protected

Fetch a platform's configuration data.

Returns: array|null Platform configuration data

Definition at line 839 of file Tool.php.

References Util\getRequestParameters(), and Util\jsonDecode().

Referenced by Tool\onRegistration().

◆ getPlatforms()

getPlatforms ( )

Get an array of defined platforms.

Returns: array Array of Platform objects

Definition at line 564 of file Tool.php.

Referenced by Tool\getConsumers().

◆ getPlatformToRegister()

getPlatformToRegister	(	$platformConfig,
		$registrationConfig,
		$doSave = `true`
	)

protected

Initialise the platform to be registered.

Parameters

array	$platformConfig	Platform configuration data
array	$registrationConfig	Registration data
bool	$doSave	True if the platform should be saved (optional, default is true)

Returns: Platform Platform object

Definition at line 1041 of file Tool.php.

References Tool\$platform, and Util\LTI_VERSION1P3.

Referenced by Tool\onRegistration().

◆ getRegistrationResponsePage()

getRegistrationResponsePage ( $toolConfig )

protected

Prepare the page to complete a registration request.

Parameters

array $toolConfig Tool configuration data

Definition at line 1077 of file Tool.php.

References System\$enabled.

Referenced by Tool\onRegistration().

◆ handleRequest()

handleRequest	(	$strictMode = `false`,
		$disableCookieCheck = `false`,
		$generateWarnings = `false`
	)

Process an incoming request.

Parameters

bool	$strictMode	True if full compliance with the LTI specification is required (optional, default is false)
bool	$disableCookieCheck	True if no cookie check should be made (optional, default is false)
bool	$generateWarnings	True if warning messages should be generated (optional, default is false)

Definition at line 481 of file Tool.php.

References Util\$logLevel, Tool\getMessageParameters(), Util\getRequestParameters(), Util\logError(), Util\LOGLEVEL_DEBUG, Util\logRequest(), and Tool\onRegistration().

◆ initialize()

initialize ( )

Initialise the tool.

Definition at line 391 of file Tool.php.

Referenced by Tool\__construct().

◆ onAuthenticate()

onAuthenticate	(	$state,
		$nonce,
		$usePlatformStorage
	)

protected

Process response to an authentication request.

Parameters

string	$state	State value
string	$nonce	Nonce value
bool	$usePlatformStorage	True if platform storage is being used

Definition at line 778 of file Tool.php.

References Util\sendForm().

◆ onConfigure()

onConfigure ( )

protected

Process a valid configure request.

Definition at line 664 of file Tool.php.

References Tool\onError().

◆ onContentItem()

onContentItem ( )

protected

Process a valid content-item request.

Definition at line 682 of file Tool.php.

References Tool\onError().

◆ onContentItemUpdate()

onContentItemUpdate ( )

protected

Process a valid content-item update request.

Definition at line 691 of file Tool.php.

References Tool\onError().

◆ onDashboard()

onDashboard ( )

protected

Process a valid dashboard request.

Definition at line 673 of file Tool.php.

References Tool\onError().

◆ onError()

onError ( )

protected

Process a response to an invalid request.

Definition at line 829 of file Tool.php.

Referenced by Tool\onConfigure(), Tool\onContentItem(), Tool\onContentItemUpdate(), Tool\onDashboard(), Tool\onLaunch(), Tool\onLtiEndAssessment(), Tool\onLtiStartProctoring(), Tool\onRegister(), and Tool\onSubmissionReview().

◆ onInitiateLogin()

onInitiateLogin	(		$requestParameters,
		&	$authParameters
	)

protected

Process a login initiation request.

Parameters

array	$requestParameters	Request parameters
array	$authParameters	Authentication request parameters

Definition at line 756 of file Tool.php.

◆ onLaunch()

onLaunch ( )

protected

Process a valid launch request.

Definition at line 655 of file Tool.php.

References Tool\onError().

◆ onLtiEndAssessment()

onLtiEndAssessment ( )

protected

Process a valid end assessment request.

Definition at line 744 of file Tool.php.

References Tool\onError().

◆ onLtiStartProctoring()

onLtiStartProctoring ( )

protected

Process a valid start proctoring request.

Definition at line 735 of file Tool.php.

References Tool\onError().

◆ onRegister()

onRegister ( )

protected

Process a valid tool proxy registration request.

Definition at line 709 of file Tool.php.

References Tool\onError().

◆ onRegistration()

onRegistration ( )

protected

Process a dynamic registration request.

Definition at line 718 of file Tool.php.

References Tool\getConfiguration(), Tool\getPlatformConfiguration(), Tool\getPlatformToRegister(), Tool\getRegistrationResponsePage(), and Tool\sendRegistration().

Referenced by Tool\handleRequest().

◆ onResetSessionId()

onResetSessionId ( )

protected

Process a change in the session ID.

Definition at line 821 of file Tool.php.

◆ onSubmissionReview()

onSubmissionReview ( )

protected

Process a valid submission review request.

Definition at line 700 of file Tool.php.

References Tool\onError().

◆ save()

save ( )

Save the tool to the database.

Returns: bool True if the object was successfully saved

Definition at line 424 of file Tool.php.

◆ sendForm()

static sendForm	(	$url,
		$params,
		$target = `''`
	)

static

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

Deprecated:: Use Util::sendForm() instead

See also: Util::sendForm()

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 641 of file Tool.php.

References Util\logDebug(), and Util\sendForm().

◆ sendRegistration()

sendRegistration	(	$platformConfig,
		$toolConfig
	)

protected

Send the tool registration to the platform.

Parameters

array	$platformConfig	Platform configuration data
array	$toolConfig	Tool configuration data

Returns: array Registration data

Definition at line 1006 of file Tool.php.

References Util\getRequestParameters(), and Util\jsonDecode().

Referenced by Tool\onRegistration().

◆ setParameterConstraint()

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
bool	$required	True if parameter is required (optional, default is true)
int \| null	$maxLength	Maximum permitted length of parameter value (optional, default is null)
array \| null	$messageTypes	Array of message types to which the constraint applies (optional, default is all)

Definition at line 536 of file Tool.php.

References System\$name.

Field Documentation

◆ $allowSharing

bool $allowSharing = false

Whether shared resource link arrangements are permitted.

Definition at line 217 of file Tool.php.

◆ $authenticateUsingGet

bool $authenticateUsingGet = false

static

Use GET method for authentication request messages when true.

Definition at line 301 of file Tool.php.

◆ $baseUrl

string null $baseUrl = null

Base URL for tool service.

Definition at line 231 of file Tool.php.

◆ $consumer

ToolConsumer null $consumer = null

Tool consumer object.

Deprecated:: Use Tool::$platform instead

See also: platform

Definition at line 161 of file Tool.php.

◆ $contentTypes

array null $contentTypes = null

protected

Content item types accepted by the platform.

Definition at line 336 of file Tool.php.

◆ $context

Context null $context = null

Context object.

Definition at line 196 of file Tool.php.

◆ $defaultEmail

string $defaultEmail = ''

Default email domain.

Definition at line 203 of file Tool.php.

◆ $defaultTool

Tool null $defaultTool = null

static

Default tool for use with service requests.

Definition at line 294 of file Tool.php.

Referenced by AccessToken\get(), OAuthDataStore\lookup_consumer(), System\signMessage(), and System\verifySignature().

◆ $documentTargets

array null $documentTargets = null

protected

Document targets accepted by the platform.

Definition at line 350 of file Tool.php.

◆ $errorOutput

string null $errorOutput = null

protected

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

Definition at line 364 of file Tool.php.

◆ $fileTypes

array null $fileTypes = null

protected

File types accepted by the platform.

Definition at line 343 of file Tool.php.

◆ $idScope

int $idScope = self::ID_SCOPE_ID_ONLY

Scope to use for user IDs.

Definition at line 210 of file Tool.php.

◆ $initiateLoginUrl

string null $initiateLoginUrl = null

Initiate Login request URL for Tool.

Definition at line 280 of file Tool.php.

Referenced by Tool\fromInitiateLoginUrl().

◆ $mediaTypes

array null $mediaTypes = null

protected

Media types accepted by the platform.

Definition at line 329 of file Tool.php.

◆ $message

string null $message = null

Message for last request processed.

Definition at line 224 of file Tool.php.

Referenced by Tool\getConfiguration().

◆ $MESSAGE_TYPES

$MESSAGE_TYPES

static

Initial value:

= array(
        'basic-lti-launch-request',
        'ConfigureLaunchRequest',
        'DashboardRequest',
        'ContentItemSelectionRequest',
        'ContentItemUpdateRequest',
        'LtiSubmissionReviewRequest',
        'ToolProxyRegistrationRequest',
        'LtiStartProctoring',
        'LtiEndAssessment'
    )

List of supported incoming message types.

Definition at line 59 of file Tool.php.

◆ $messageUrl

string null $messageUrl = null

Message URL for Tool.

Definition at line 273 of file Tool.php.

◆ $optionalServices

array null $optionalServices = null

Optional services used by Tool.

Definition at line 259 of file Tool.php.

◆ $output

string null $output = null

protected

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

Definition at line 357 of file Tool.php.

◆ $platform

Platform null $platform = null

Platform object.

Definition at line 168 of file Tool.php.

Referenced by Tool\__construct(), and Tool\getPlatformToRegister().

◆ $postMessageTimeoutDelay

int $postMessageTimeoutDelay = 20

static

Period in milliseconds to wait for a response to a postMessage.

Definition at line 315 of file Tool.php.

◆ $product

Profile Item null $product = null

Product details.

Definition at line 245 of file Tool.php.

◆ $redirectionUris

array null $redirectionUris = null

Redirection URIs for Tool.

Definition at line 287 of file Tool.php.

◆ $redirectUrl

string null $redirectUrl = null

protected

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

Definition at line 322 of file Tool.php.

◆ $requiredServices

array null $requiredServices = null

Services required by Tool.

Definition at line 252 of file Tool.php.

◆ $resourceHandlers

array null $resourceHandlers = null

Resource handlers for Tool.

Definition at line 266 of file Tool.php.

◆ $resourceLink

ResourceLink null $resourceLink = null

Resource link object.

Definition at line 189 of file Tool.php.

◆ $returnUrl

string null $returnUrl = null

Return URL provided by platform.

Definition at line 175 of file Tool.php.

◆ $stateLife

int $stateLife = 10

static

Life in seconds for the state value issued during the OIDC login process.

Definition at line 308 of file Tool.php.

◆ $userResult

UserResult null $userResult = null

UserResult object.

Definition at line 182 of file Tool.php.

◆ $vendor

Profile Item null $vendor = null

Vendor details.

Definition at line 238 of file Tool.php.

◆ CONNECTION_ERROR_MESSAGE

const CONNECTION_ERROR_MESSAGE = 'Sorry, there was an error connecting you to the application.'

Default connection error message.

Definition at line 29 of file Tool.php.

◆ ID_SCOPE_CONTEXT

const ID_SCOPE_CONTEXT = 2

Prefix the ID with the consumer key and context ID.

Definition at line 44 of file Tool.php.

Referenced by UserResult\getId().

◆ ID_SCOPE_GLOBAL

const ID_SCOPE_GLOBAL = 1

Prefix an ID with the consumer key.

Definition at line 39 of file Tool.php.

Referenced by UserResult\getId().

◆ ID_SCOPE_ID_ONLY

const ID_SCOPE_ID_ONLY = 0

Use ID value only.

Definition at line 34 of file Tool.php.

◆ ID_SCOPE_RESOURCE

const ID_SCOPE_RESOURCE = 3

Prefix the ID with the consumer key and resource ID.

Definition at line 49 of file Tool.php.

Referenced by UserResult\getId(), and ResourceLink\getMemberships().

◆ ID_SCOPE_SEPARATOR

const ID_SCOPE_SEPARATOR = ':'

Character used to separate each element of an ID.

Definition at line 54 of file Tool.php.

Referenced by UserResult\getId().

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

Tool.php

Public Member Functions

Static Public Member Functions

Data Fields

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ delete()

◆ doToolProxyService()

◆ findService()

◆ fromConsumerKey()

◆ fromInitiateLoginUrl()

◆ fromRecordId()

◆ getConfiguration()

◆ getConsumers()

◆ getMessageParameters()

◆ getPlatformConfiguration()

◆ getPlatforms()

◆ getPlatformToRegister()

◆ getRegistrationResponsePage()

◆ handleRequest()

◆ initialize()

◆ onAuthenticate()

◆ onConfigure()

◆ onContentItem()

◆ onContentItemUpdate()

◆ onDashboard()

◆ onError()

◆ onInitiateLogin()

◆ onLaunch()

◆ onLtiEndAssessment()

◆ onLtiStartProctoring()

◆ onRegister()

◆ onRegistration()

◆ onResetSessionId()

◆ onSubmissionReview()

◆ save()

◆ sendForm()

◆ sendRegistration()

◆ setParameterConstraint()

Field Documentation

◆ $allowSharing

◆ $authenticateUsingGet

◆ $baseUrl

◆ $consumer

◆ $contentTypes

◆ $context

◆ $defaultEmail

◆ $defaultTool

◆ $documentTargets

◆ $errorOutput

◆ $fileTypes

◆ $idScope

◆ $initiateLoginUrl

◆ $mediaTypes

◆ $message

◆ $MESSAGE_TYPES

◆ $messageUrl

◆ $optionalServices

◆ $output

◆ $platform

◆ $postMessageTimeoutDelay

◆ $product

◆ $redirectionUris

◆ $redirectUrl

◆ $requiredServices

◆ $resourceHandlers

◆ $resourceLink

◆ $returnUrl

◆ $stateLife

◆ $userResult

◆ $vendor

◆ CONNECTION_ERROR_MESSAGE

◆ ID_SCOPE_CONTEXT

◆ ID_SCOPE_GLOBAL

◆ ID_SCOPE_ID_ONLY

◆ ID_SCOPE_RESOURCE