enrol_lti\local\ltiadvantage\lib\launch_cache_session Class Reference

Inheritance diagram for enrol_lti\local\ltiadvantage\lib\launch_cache_session:

Public Member Functions
	cacheAccessToken (string $key, string $accessToken)
	Cache the access token.
	cacheLaunchData (string $key, array $jwtBody)
	Add launch data to the cache.
	cacheNonce (string $nonce, string $state)
	Cache the nonce.
	checkNonceIsValid (string $nonce, string $state)
	Check whether the cache contains the nonce.
	clearAccessToken (string $key)
	Clear the access token from the cache.
	getAccessToken (string $key)
	Get a cached access token.
	getLaunchData (string $key)
	Get the launch data from the cache.
	purge ()
	Delete all data from the session cache.

Member Function Documentation

cacheAccessToken()

enrol_lti\local\ltiadvantage\lib\launch_cache_session::cacheAccessToken	(	string	$key,
		string	$accessToken )

Cache the access token.

Parameters

string	$key	the key
string	$accessToken	the access token

Implements Packback\Lti1p3\Interfaces\ICache.

cacheLaunchData()

enrol_lti\local\ltiadvantage\lib\launch_cache_session::cacheLaunchData	(	string	$key,
		array	$jwtBody )

Add launch data to the cache.

Parameters

string	$key	the launch id.
array	$jwtBody	the launch data.

Implements Packback\Lti1p3\Interfaces\ICache.

cacheNonce()

enrol_lti\local\ltiadvantage\lib\launch_cache_session::cacheNonce	(	string	$nonce,
		string	$state )

Cache the nonce.

Parameters

string	$nonce	the nonce.
string	$state	the state.

Implements Packback\Lti1p3\Interfaces\ICache.

checkNonceIsValid()

enrol_lti\local\ltiadvantage\lib\launch_cache_session::checkNonceIsValid	(	string	$nonce,
		string	$state )

Check whether the cache contains the nonce.

Parameters

string	$nonce	the nonce
string	$state	the state

Return values

bool	true if found, false otherwise.

Implements Packback\Lti1p3\Interfaces\ICache.

clearAccessToken()

enrol_lti\local\ltiadvantage\lib\launch_cache_session::clearAccessToken

(

string

$key

)

Clear the access token from the cache.

Parameters

string

$key

the key to purge.

Implements Packback\Lti1p3\Interfaces\ICache.

getAccessToken()

enrol_lti\local\ltiadvantage\lib\launch_cache_session::getAccessToken

(

string

$key

)

Get a cached access token.

Parameters

string

$key

the key to check.

Return values

string|null

the token string, or null if not found.

Implements Packback\Lti1p3\Interfaces\ICache.

getLaunchData()

enrol_lti\local\ltiadvantage\lib\launch_cache_session::getLaunchData

(

string

$key

)

Get the launch data from the cache.

Parameters

string

$key

the launch id.

Return values

array|null

the launch data.

Implements Packback\Lti1p3\Interfaces\ICache.

---

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

• enrol/lti/classes/local/ltiadvantage/lib/launch_cache_session.php