ceLTIc\LTI\OAuthDataStore Class Reference

Class to represent an OAuth datastore. More...

Inheritance diagram for ceLTIc\LTI\OAuthDataStore:

Public Member Functions
	__construct (Platform|Tool $system)
	Class constructor.
	lookup_consumer (string $consumerKey)
	Create an OAuthConsumer object for the system.
	lookup_token (OAuthConsumer $consumer, ?string $tokenType, ?string $token)
	Create an OAuthToken object for the system.
	lookup_nonce (OAuthConsumer $consumer, OAuthToken $token, string $value, string $timestamp)
	Lookup nonce value for the system.
	new_request_token (OAuthConsumer $consumer, ?string $callback=null)
	Get new request token.
	new_access_token (string $token, OAuthConsumer $consumer, ?string $verifier=null)
	Get new access token.

Detailed Description

Class to represent an OAuth datastore.

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()

ceLTIc\LTI\OAuthDataStore::__construct

(

Platform|Tool

$system

)

Class constructor.

Parameters

Platform | Tool

$system

System object

Member Function Documentation

lookup_consumer()

ceLTIc\LTI\OAuthDataStore::lookup_consumer

(

string

$consumerKey

)

Create an OAuthConsumer object for the system.

Parameters

string

$consumerKey

Consumer key value

Returns

OAuthConsumer OAuthConsumer object

Reimplemented from ceLTIc\LTI\OAuth\OAuthDataStore.

lookup_nonce()

ceLTIc\LTI\OAuthDataStore::lookup_nonce	(	OAuthConsumer	$consumer,
		OAuthToken	$token,
		string	$value,
		string	$timestamp )

Lookup nonce value for the system.

Parameters

OAuthConsumer	$consumer	OAuthConsumer object
OAuthToken	$token	Token value
string	$value	Nonce value
string	$timestamp	Date/time of request

Returns

bool True if the nonce value already exists

Reimplemented from ceLTIc\LTI\OAuth\OAuthDataStore.

lookup_token()

ceLTIc\LTI\OAuthDataStore::lookup_token	(	OAuthConsumer	$consumer,
		?string	$tokenType,
		?string	$token )

Create an OAuthToken object for the system.

Parameters

string	$consumer	OAuthConsumer object
string | null	$tokenType	Token type
string | null	$token	Token value

Returns

OAuthToken OAuthToken object

Reimplemented from ceLTIc\LTI\OAuth\OAuthDataStore.

new_access_token()

ceLTIc\LTI\OAuthDataStore::new_access_token	(	string	$token,
		OAuthConsumer	$consumer,
		?string	$verifier = null )

Get new access token.

Parameters

string	$token	Token value
OAuthConsumer	$consumer	OAuthConsumer object
string | null	$verifier	Verification code

Returns

string|null Null value

Reimplemented from ceLTIc\LTI\OAuth\OAuthDataStore.

new_request_token()

ceLTIc\LTI\OAuthDataStore::new_request_token	(	OAuthConsumer	$consumer,
		?string	$callback = null )

Get new request token.

Parameters

OAuthConsumer	$consumer	OAuthConsumer object
string | null	$callback	Callback URL

Returns

string|null Null value

Reimplemented from ceLTIc\LTI\OAuth\OAuthDataStore.