Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
IMSGlobal\LTI\ToolProvider\OAuthDataStore Class Reference
Inheritance diagram for IMSGlobal\LTI\ToolProvider\OAuthDataStore:
IMSGlobal\LTI\OAuth\OAuthDataStore

Public Member Functions

 __construct ($toolProvider)
 Class constructor.
 
 lookup_consumer ($consumerKey)
 Create an OAuthConsumer object for the tool consumer.
 
 lookup_nonce ($consumer, $token, $value, $timestamp)
 Lookup nonce value for the tool consumer.
 
 lookup_token ($consumer, $tokenType, $token)
 Create an OAuthToken object for the tool consumer.
 
 new_access_token ($token, $consumer, $verifier=null)
 Get new access token.
 
 new_request_token ($consumer, $callback=null)
 Get new request token.
 

Constructor & Destructor Documentation

◆ __construct()

IMSGlobal\LTI\ToolProvider\OAuthDataStore::__construct ( $toolProvider)

Class constructor.

Parameters
ToolProvider$toolProviderTool_Provider object

Member Function Documentation

◆ lookup_consumer()

IMSGlobal\LTI\ToolProvider\OAuthDataStore::lookup_consumer ( $consumerKey)

Create an OAuthConsumer object for the tool consumer.

Parameters
string$consumerKeyConsumer key value
Return values
OAuthConsumerOAuthConsumer object

Reimplemented from IMSGlobal\LTI\OAuth\OAuthDataStore.

◆ lookup_nonce()

IMSGlobal\LTI\ToolProvider\OAuthDataStore::lookup_nonce ( $consumer,
$token,
$value,
$timestamp )

Lookup nonce value for the tool consumer.

Parameters
OAuthConsumer$consumerOAuthConsumer object
string$tokenToken value
string$valueNonce value
string$timestampDate/time of request
Return values
booleanTrue if the nonce value already exists

Reimplemented from IMSGlobal\LTI\OAuth\OAuthDataStore.

◆ lookup_token()

IMSGlobal\LTI\ToolProvider\OAuthDataStore::lookup_token ( $consumer,
$tokenType,
$token )

Create an OAuthToken object for the tool consumer.

Parameters
string$consumerOAuthConsumer object
string$tokenTypeToken type
string$tokenToken value
Return values
OAuthTokenOAuthToken object

Reimplemented from IMSGlobal\LTI\OAuth\OAuthDataStore.

◆ new_access_token()

IMSGlobal\LTI\ToolProvider\OAuthDataStore::new_access_token ( $token,
$consumer,
$verifier = null )

Get new access token.

Parameters
string$tokenToken value
OAuthConsumer$consumerOAuthConsumer object
string$verifierVerification code
Return values
stringNull value

Reimplemented from IMSGlobal\LTI\OAuth\OAuthDataStore.

◆ new_request_token()

IMSGlobal\LTI\ToolProvider\OAuthDataStore::new_request_token ( $consumer,
$callback = null )

Get new request token.

Parameters
OAuthConsumer$consumerOAuthConsumer object
string$callbackCallback URL
Return values
stringNull value

Reimplemented from IMSGlobal\LTI\OAuth\OAuthDataStore.


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