enrol_lti\local\ltiadvantage\entity\migration_claim Class Reference

Public Member Functions
	__construct (array $claim, string $deploymentid, string $platform, string $clientid, string $exp, string $nonce, legacy_consumer_repository $legacyconsumerrepo)
	The migration_claim constructor.
	get_consumer_key ()
	Return the consumer key stored in the claim.
	get_context_id ()
	Return the LTI 1.1 context id stored in the claim.
	get_resource_link_id ()
	Return the LTI 1.1 resource link id stored in the claim.
	get_tool_consumer_instance_guid ()
	Return the LTI 1.1 tool consumer instance GUID stored in the claim.
	get_user_id ()
	Return the LTI 1.1 user id stored in the claim.

Constructor & Destructor Documentation

__construct()

enrol_lti\local\ltiadvantage\entity\migration_claim::__construct	(	array	$claim,
		string	$deploymentid,
		string	$platform,
		string	$clientid,
		string	$exp,
		string	$nonce,
		legacy_consumer_repository	$legacyconsumerrepo )

The migration_claim constructor.

Parameters

array	$claim	the array of claim data, as received in a resource link launch.
string	$deploymentid	the deployment id included in the launch.
string	$platform	the platform included in the launch.
string	$clientid	the client id included in the launch.
string	$exp	the exp included in the launch.
string	$nonce	the nonce included in the launch.
legacy_consumer_repository	$legacyconsumerrepo	a legacy consumer repository instance.

Exceptions

coding_exception

if the claim data is invalid.

Member Function Documentation

get_consumer_key()

enrol_lti\local\ltiadvantage\entity\migration_claim::get_consumer_key

(

)

Return the consumer key stored in the claim.

Return values

string

the consumer key included in the claim.

get_context_id()

enrol_lti\local\ltiadvantage\entity\migration_claim::get_context_id

(

)

Return the LTI 1.1 context id stored in the claim.

Return values

string|null

the context id, or null if not provided in the claim.

get_resource_link_id()

enrol_lti\local\ltiadvantage\entity\migration_claim::get_resource_link_id

(

)

Return the LTI 1.1 resource link id stored in the claim.

Return values

string|null

the resource link id, or null if not provided in the claim.

get_tool_consumer_instance_guid()

enrol_lti\local\ltiadvantage\entity\migration_claim::get_tool_consumer_instance_guid

(

)

Return the LTI 1.1 tool consumer instance GUID stored in the claim.

Return values

string|null

the tool consumer instance GUID, or null if not provided in the claim.

get_user_id()

enrol_lti\local\ltiadvantage\entity\migration_claim::get_user_id

(

)

Return the LTI 1.1 user id stored in the claim.

Return values

string|null

the user id, or null if not provided in the claim.

---

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

• enrol/lti/classes/local/ltiadvantage/entity/migration_claim.php