IMSGlobal\LTI\ToolProvider\OAuthDataStore Class Reference

Class to represent an OAuth datastore. More...

Inheritance diagram for IMSGlobal\LTI\ToolProvider\OAuthDataStore:

Collaboration diagram for IMSGlobal\LTI\ToolProvider\OAuthDataStore:

Public Member Functions
	__construct ($toolProvider)
	Class constructor. More...
	lookup_consumer ($consumerKey)
	Create an OAuthConsumer object for the tool consumer. More...
	lookup_token ($consumer, $tokenType, $token)
	Create an OAuthToken object for the tool consumer. More...
	lookup_nonce ($consumer, $token, $value, $timestamp)
	Lookup nonce value for the tool consumer. More...
	new_request_token ($consumer, $callback=null)
	Get new request token. More...
	new_access_token ($token, $consumer, $verifier=null)
	Get new access token. More...
Public Member Functions inherited from IMSGlobal\LTI\OAuth\OAuthDataStore
	lookup_consumer ($consumer_key)
	lookup_token ($consumer, $token_type, $token)
	lookup_nonce ($consumer, $token, $nonce, $timestamp)
	new_request_token ($consumer, $callback=null)
	new_access_token ($token, $consumer, $verifier=null)

Private Attributes
	$toolProvider = null
	Tool Provider object. More...

Detailed Description

Class to represent an OAuth datastore.

Author

Stephen P Vickers svick.nosp@m.ers@.nosp@m.imsgl.nosp@m.obal.nosp@m..org

Copyright

IMS Global Learning Consortium Inc

Date

2016

Version

3.0.2 http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0

Definition at line 16 of file OAuthDataStore.php.

Constructor & Destructor Documentation

__construct()

IMSGlobal\LTI\ToolProvider\OAuthDataStore::__construct

(

$toolProvider

)

Class constructor.

Parameters

ToolProvider

$toolProvider

Tool_Provider object

Definition at line 31 of file OAuthDataStore.php.

References IMSGlobal\LTI\ToolProvider\OAuthDataStore\$toolProvider.

    {

        $this->toolProvider = $toolProvider;

    }

Member Function Documentation

lookup_consumer()

IMSGlobal\LTI\ToolProvider\OAuthDataStore::lookup_consumer

(

$consumerKey

)

Create an OAuthConsumer object for the tool consumer.

Parameters

string

$consumerKey

Consumer key value

Returns

OAuthConsumer OAuthConsumer object

Definition at line 45 of file OAuthDataStore.php.

    {

        return new OAuth\OAuthConsumer($this->toolProvider->consumer->getKey(),
           $this->toolProvider->consumer->secret);

    }

lookup_nonce()

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

Lookup nonce value for the tool consumer.

Parameters

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

Returns

boolean True if the nonce value already exists

Definition at line 79 of file OAuthDataStore.php.

References $ok.

    {

        $nonce = new ConsumerNonce($this->toolProvider->consumer, $value);
        $ok = !$nonce->load();
        if ($ok) {
            $ok = $nonce->save();
        }
        if (!$ok) {
            $this->toolProvider->reason = 'Invalid nonce.';
        }

        return !$ok;

    }

lookup_token()

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

Create an OAuthToken object for the tool consumer.

Parameters

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

Returns

OAuthToken OAuthToken object

Definition at line 62 of file OAuthDataStore.php.

References $consumer.

    {

        return new OAuth\OAuthToken($consumer, '');

    }

new_access_token()

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

Get new access token.

Parameters

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

Returns

string Null value

Definition at line 119 of file OAuthDataStore.php.

    {

        return null;

    }

new_request_token()

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

Get new request token.

Parameters

OAuthConsumer	$consumer	OAuthConsumer object
string	$callback	Callback URL

Returns

string Null value

Definition at line 103 of file OAuthDataStore.php.

    {

        return null;

    }

Field Documentation

$toolProvider

ToolProvider OAuthDataStore::$toolProvider = null

private

Tool Provider object.

Definition at line 24 of file OAuthDataStore.php.

Referenced by IMSGlobal\LTI\ToolProvider\OAuthDataStore\__construct().

---

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

• libs/composer/vendor/imsglobal/lti/src/ToolProvider/OAuthDataStore.php