Class to represent a platform. More...

Inheritance diagram for Platform:

Public Member Functions
	__construct (?DataConnector $dataConnector=null)
	Class constructor.
void	initialize ()
	Initialise the platform.
void	initialise ()
	Initialise the platform.
bool	save ()
	Save the platform to the database.
bool	delete ()
	Delete the platform from the database.
string null	getId ()
	Get the platform ID.
string	getFamilyCode ()
	Get platform family code (as reported by last platform connection).
DataConnector null	getDataConnector ()
	Get the data connector.
AccessToken null	getAccessToken ()
	Get the authorization access token.
void	setAccessToken (AccessToken $accessToken)
	Set the authorization access token.
bool	getIsAvailable ()
	Is the platform available to accept launch requests?
bool	hasToolSettingsService ()
	Check if the Tool Settings service is supported.
array bool	getToolSettings (bool $simple=true)
	Get Tool Settings.
bool	setToolSettings (array $settings=[])
	Set Tool Settings.
array	getTools ()
	Get an array of defined tools.
bool	hasAccessTokenService ()
	Check if the Access Token service is supported.
array null	getMessageParameters ()
	Get the message parameters.
void	handleRequest (bool $generateWarnings=false)
	Process an incoming request.
never	sendAccessToken ($supportedScopes)
	Generate an access token value.
bool	verifyAuthorization (array &$allowedScopes)
	Verify the authorisation of a service request.
Public Member Functions inherited from System
int string null	getRecordId ()
	Get the system record ID.
void	setRecordId (int\|string\|null $id)
	Sets the system record ID.
string null	getKey ()
	Get the consumer key.
void	setKey (?string $key)
	Set the consumer key.
string null	getSetting (string $name, ?string $default="")
	Get a setting value.
void	setSetting (string $name, string\|array\|null $value=null)
	Set a setting value.
array	getSettings ()
	Get an array of all setting values.
void	setSettings (array $settings)
	Set an array of all setting values.
bool	saveSettings ()
	Save setting values.
bool	hasJwt ()
	Check whether a JWT exists.
ClientInterface	getJwt ()
	Get the JWT.
array	getRawParameters ()
	Get the raw POST parameters.
array	getMessageClaims (bool $fullyQualified=false)
	Get the message claims.
array string	signParameters (string $url, string $type, string $ltiVersionString, array $params)
	Add the signature to an LTI message.
array string	signMessage (string &$url, string $type, string $ltiVersionString, array $params, ?string $loginHint=null, ?string $ltiMessageHint=null)
	Add the signature to an LTI message.
string	sendMessage (string $url, string $type, array $messageParams, string $target="", ?string $userId=null, ?string $hint=null)
	Generate a web page containing an auto-submitted form of LTI message parameters.
array string	signServiceRequest (string $url, string $method, string $type, array\|string\|null $data=null)
	Generates the headers for an LTI service request.
HttpMessage	doServiceRequest (ServiceDefinition $service, string $method, string $format, array\|string $data)
	Perform a service request.
bool	useOAuth1 ()
	Determine whether this consumer is using the OAuth 1 security model.
array string	addSignature (string $endpoint, array\|string\|null $data, string $method="POST", ?string $type=null, ?string $nonce="", ?string $hash=null, ?int $timestamp=null)
	Add the signature to an array of message parameters or to a header string.
string null	getBaseString ()
	Get the last signature base string.
bool	checkMessage (bool $generateWarnings=false)
	Verify the required properties of an LTI message.
bool	verifySignature ($generateWarnings=false)
	Verify the signature of a message.
bool	setReason (string $reason)
	Set the error reason.

Static Public Member Functions
static Platform	fromConsumerKey (?string $key=null, ?DataConnector $dataConnector=null, bool $autoEnable=false)
	Load the platform from the database by its consumer key.
static Platform	fromPlatformId (string $platformId, ?string $clientId, ?string $deploymentId, ?DataConnector $dataConnector=null, bool $autoEnable=false)
	Load the platform from the database by its platform, client and deployment IDs.
static Platform	fromRecordId (int\|string $id, DataConnector $dataConnector)
	Load the platform from the database by its record ID.
static string	getStorageJS ()
	Get the JavaScript for handling storage postMessages from a tool.
Static Public Member Functions inherited from System
static array	parseRoles (array\|string $roles, LtiVersion $ltiVersion=LtiVersion::V1, bool $addPrincipalRole=false)
	Parse a set of roles to comply with a specified version of LTI.

Public Attributes
string	$platformId = null
	Platform ID.
string	$clientId = null
	Client ID.
string	$deploymentId = null
	Deployment ID.
string	$authorizationServerId = null
	Authorization server ID.
string	$authenticationUrl = null
	Login authentication URL.
string	$accessTokenUrl = null
	Access Token service URL.
string	$consumerName = null
	Name of platform (as reported by last platform connection).
string	$consumerVersion = null
	Platform version (as reported by last platform connection).
object	$profile = null
	The platform profile data.
string	$toolProxy = null
	The tool proxy.
string	$consumerGuid = null
	Platform GUID (as reported by first platform connection).
string	$cssPath = null
	Optional CSS path (as reported by last platform connection).
bool	$protected = false
	Whether the platform instance is protected by matching the consumer_guid value in incoming requests.
string	$defaultEmail = ''
	Default email address (or email domain) to use when no email address is provided for a user.
HttpMessage	$lastServiceRequest = null
	HttpMessage object for last service request.
Public Attributes inherited from System
bool	$ok = true
	True if the last request was successful.
LtiVersion	$ltiVersion = null
	LTI version.
string	$name = null
	Local name of platform/tool.
string	$secret = null
	Shared secret.
string	$signatureMethod = 'HMAC-SHA1'
	Method used for signing messages.
string	$encryptionMethod = ''
	Algorithm used for encrypting messages.
DataConnector	$dataConnector = null
	Data connector object.
string	$rsaKey = null
	RSA/EC key in PEM or JSON format.
array	$requiredScopes = []
	Scopes to request when obtaining an access token.
string	$kid = null
	Key ID.
string	$jku = null
	Endpoint for public key.
string	$reason = null
	Error message for last request processed.
array	$details = []
	Details for error message relating to last request processed.
array	$warnings = []
	Warnings relating to last request processed.
bool	$debugMode = false
	Whether debug level messages are to be reported.
bool	$enabled = false
	Whether the system instance is enabled to accept connection requests.
int	$enableFrom = null
	Timestamp from which the the system instance is enabled to accept connection requests.
int	$enableUntil = null
	Timestamp until which the system instance is enabled to accept connection requests.
int	$lastAccess = null
	Timestamp for date of last connection to this system.
int	$created = null
	Timestamp for when the object was created.
int	$updated = null
	Timestamp for when the object was last updated.
IdScope	$idScope = IdScope::IdOnly
	Default scope to use when generating an Id value for a user.
string	$onExitExceptionClass = null
	Class of exception to be thrown instead of calling exit.

Static Public Attributes
static array	$MESSAGE_TYPES
	List of supported incoming message types.
static string	$browserStorageFrame = null
	Name of browser storage frame.
static int	$accessTokenLife = 3600
	Life (in seconds) of an issued access token (default is 1 hour).

Protected Member Functions
void	onInitiateLogin (string &$url, string &$loginHint, ?string &$ltiMessageHint, array $params)
	Save the hint and message parameters when sending an initiate login request.
void	onAuthenticate ()
	Check the hint and recover the message parameters for an authentication request.
void	onContentItem ()
	Process a valid content-item message.
void	onLtiStartAssessment ()
	Process a valid start assessment message.
void	onError ()
	Process a response to an invalid message.

Additional Inherited Members
Protected Attributes inherited from System
ClientInterface	$jwt = null
	JWT ClientInterface object.
array	$rawParameters = null
	Raw message parameters.
array	$messageParameters = null
	LTI message parameters.

Detailed Description

Class to represent a platform.

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

Constructor & Destructor Documentation

◆ __construct()

__construct ( ?DataConnector $dataConnector = null )

Class constructor.

Parameters

DataConnector | null $dataConnector A data connector object

Member Function Documentation

◆ delete()

bool delete ( )

Delete the platform from the database.

Returns: bool True if the object was successfully deleted

◆ fromConsumerKey()

Platform fromConsumerKey	(	?string	$key = null,
		?DataConnector	$dataConnector = null,
		bool	$autoEnable = false )

static

Load the platform from the database by its consumer key.

Parameters

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

Returns: Platform The platform object

References System\$dataConnector, Util\decrypt(), and System\setRecordId().

◆ fromPlatformId()

Platform fromPlatformId	(	string	$platformId,
		?string	$clientId,
		?string	$deploymentId,
		?DataConnector	$dataConnector = null,
		bool	$autoEnable = false )

static

Load the platform from the database by its platform, client and deployment IDs.

Parameters

string	$platformId	The platform ID
string \| null	$clientId	The client ID
string \| null	$deploymentId	The deployment ID
DataConnector	$dataConnector	A data connector object
bool	$autoEnable	True if the platform is to be enabled automatically (optional, default is false)

Returns: Platform The platform object

◆ fromRecordId()

Platform fromRecordId	(	int\|string	$id,
		DataConnector	$dataConnector )

static

Load the platform from the database by its record ID.

Parameters

int \| string	$id	The platform record ID
DataConnector	$dataConnector	A data connector object

Returns: Platform The platform object

Referenced by Context\initialize().

◆ getAccessToken()

AccessToken null getAccessToken ( )

Get the authorization access token.

Returns: AccessToken|null Access token

◆ getDataConnector()

DataConnector null getDataConnector ( )

Get the data connector.

Returns: DataConnector|null Data connector object or string

References System\$ok.

◆ getFamilyCode()

string getFamilyCode ( )

Get platform family code (as reported by last platform connection).

Returns: string Family code

Referenced by hasToolSettingsService().

◆ getId()

string null getId ( )

Get the platform ID.

The ID will be the consumer key if one exists, otherwise a concatenation of the platform/client/deployment IDs

Returns: string|null Platform ID value

References System\$dataConnector.

◆ getIsAvailable()

bool getIsAvailable ( )

Is the platform available to accept launch requests?

Returns: bool True if the platform is enabled and within any date constraints

References System\$ok.

◆ getMessageParameters()

array null getMessageParameters ( )

Get the message parameters.

Returns: array|null The message parameter array

Referenced by getTools().

◆ getStorageJS()

string getStorageJS ( )

static

Get the JavaScript for handling storage postMessages from a tool.

Returns: string The JavaScript to handle storage postMessages

◆ getTools()

array getTools ( )

Get an array of defined tools.

Returns: array Array of Tool objects

References Util\$logLevel, getMessageParameters(), Util\getRequestParameters(), and Util\logRequest().

◆ getToolSettings()

array bool getToolSettings ( bool $simple = true )

Get Tool Settings.

Parameters

bool $simple True if all the simple media type is to be used (optional, default is true)

Returns: array|bool The array of settings if successful, otherwise false

References Util\decrypt().

◆ handleRequest()

void handleRequest ( bool $generateWarnings = false )

Process an incoming request.

Parameters

bool $generateWarnings True if warning messages should be generated (optional, default is false)

References $clientId, System\$jwt, OAuthRequest\$POST_INPUT, System\$reason, OAuthUtil\parse_parameters(), and Util\sendResponse().

◆ hasAccessTokenService()

bool hasAccessTokenService ( )

Check if the Access Token service is supported.

Returns: bool True if this platform supports the Access Token service

◆ hasToolSettingsService()

bool hasToolSettingsService ( )

Check if the Tool Settings service is supported.

Returns: bool True if this platform supports the Tool Settings service

References System\$ok, getFamilyCode(), and System\getSetting().

◆ initialise()

void initialise ( )

Initialise the platform.

Synonym for initialize().

◆ onAuthenticate()

void onAuthenticate ( )

protected

Check the hint and recover the message parameters for an authentication request.

Override this method if the data has been saved elsewhere.

◆ onInitiateLogin()

void onInitiateLogin	(	string &	$url,
		string &	$loginHint,
		?string &	$ltiMessageHint,
		array	$params )

protected

Save the hint and message parameters when sending an initiate login request.

Override this method to save the data elsewhere.

Parameters

string	$url	The message URL
string	$loginHint	The ID of the user
string \| null	$ltiMessageHint	The message hint being sent to the tool
array	$params	An associative array of message parameters

References onContentItem(), and onLtiStartAssessment().

◆ save()

bool save ( )

Save the platform to the database.

Returns: bool True if the object was successfully saved

◆ sendAccessToken()

never sendAccessToken ( $supportedScopes )

Generate an access token value.

Parameters

array $supportedScopes Supported scopes

Returns: never

References System\$jwt, System\$ok, OAuthUtil\get_headers(), and System\verifySignature().

◆ setAccessToken()

void setAccessToken ( AccessToken $accessToken )

Set the authorization access token.

Parameters

AccessToken $accessToken Access token

References System\$ok, and System\getSetting().

◆ setToolSettings()

bool setToolSettings ( array $settings = [] )

Set Tool Settings.

Parameters

array $settings An associative array of settings (optional, default is none)

Returns: bool True if action was successful, otherwise false

◆ verifyAuthorization()

bool verifyAuthorization ( array & $allowedScopes )

Verify the authorisation of a service request.

Parameters

array $allowedScopes Array of scopes at least one of which is required to authorise the request (passed by reference)

Returns: bool True if the request is authorised

Member Data Documentation

◆ $accessTokenLife

int $accessTokenLife = 3600

static

Life (in seconds) of an issued access token (default is 1 hour).

$accessTokenLife

◆ $MESSAGE_TYPES

array $MESSAGE_TYPES

static

Initial value:

= [
        'ContentItemSelection',
        'LtiStartAssessment'
    ]

List of supported incoming message types.

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ delete()

◆ fromConsumerKey()

◆ fromPlatformId()

◆ fromRecordId()

◆ getAccessToken()

◆ getDataConnector()

◆ getFamilyCode()

◆ getId()

◆ getIsAvailable()

◆ getMessageParameters()

◆ getStorageJS()

◆ getTools()

◆ getToolSettings()

◆ handleRequest()

◆ hasAccessTokenService()

◆ hasToolSettingsService()

◆ initialise()

◆ onAuthenticate()

◆ onInitiateLogin()

◆ save()

◆ sendAccessToken()

◆ setAccessToken()

◆ setToolSettings()

◆ verifyAuthorization()

Member Data Documentation

◆ $accessTokenLife

◆ $MESSAGE_TYPES