ILIAS\LTI\ToolProvider\OAuthDataStore Class Reference

Class to represent an OAuth datastore. More...

Inheritance diagram for ILIAS\LTI\ToolProvider\OAuthDataStore:

Collaboration diagram for ILIAS\LTI\ToolProvider\OAuthDataStore:

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

Private Attributes
	$system = null
	System object. More...

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 http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3

Definition at line 33 of file OAuthDataStore.php.

Constructor & Destructor Documentation

__construct()

ILIAS\LTI\ToolProvider\OAuthDataStore::__construct

(

$system

)

Class constructor.

Parameters

Tool | Platform

$system

System object

Definition at line 47 of file OAuthDataStore.php.

References ILIAS\LTI\ToolProvider\OAuthDataStore\$system.

    {
        $this->system = $system;
    }

Member Function Documentation

lookup_consumer()

ILIAS\LTI\ToolProvider\OAuthDataStore::lookup_consumer

(

string

$consumerKey

)

Create an OAuthConsumer object for the system.

Parameters

string

$consumerKey

Consumer key value

Returns

OAuthConsumer OAuthConsumer object

Definition at line 57 of file OAuthDataStore.php.

References ILIAS\LTI\ToolProvider\Tool\$defaultTool, ILIAS\LTI\ToolProvider\$key, and ILIAS\LTI\ToolProvider\$secret.

                                                        : OAuthConsumer
    {
        $key = $this->system->getKey();
        $secret = '';
        if (!empty($key)) {
            $secret = $this->system->secret;
        } elseif (($this->system instanceof Tool) && !empty($this->system->platform)) {
            $key = $this->system->platform->getKey();
            $secret = $this->system->platform->secret;
        } elseif (($this->system instanceof Platform) && !empty(Tool::$defaultTool)) {
            $key = Tool::$defaultTool->getKey();
            $secret = Tool::$defaultTool->secret;
        }
        if ($key !== $consumerKey) {
            throw new OAuthException('Consumer key not found');
        }

        return new OAuthConsumer($key, $secret);
    }

lookup_nonce()

ILIAS\LTI\ToolProvider\OAuthDataStore::lookup_nonce	(	OAuthConsumer	$consumer,
		?OAuthToken	$token,
		string	$value,
		int	$timestamp
	)

Lookup nonce value for the system.

Parameters

OAuthConsumer	$consumer	OAuthConsumer object
OAuthToken | null	$token	Token value //UK: removed string
string	$value	Nonce value
int	$timestamp	Date/time of request //UK: removed string

Returns

bool True if the nonce value already exists

Definition at line 97 of file OAuthDataStore.php.

References ILIAS\LTI\ToolProvider\OAuthDataStore\$system.

                                                                                                            : bool
    {
        if ($this->system instanceof Platform) {
            $platform = $this->system;
        } else {
            $platform = $this->system->platform;
        }
        $nonce = new PlatformNonce($platform, $value);
        $ok = !$nonce->load();
        if ($ok) {
            $ok = $nonce->save();
        }
        if (!$ok) {
            $this->system->reason = 'Invalid nonce.';
        }

        return !$ok;
    }

lookup_token()

ILIAS\LTI\ToolProvider\OAuthDataStore::lookup_token	(	OAuthConsumer	$consumer,
		string	$tokenType,
		string	$token
	)

Create an OAuthToken object for the system.

Parameters

OAuthConsumer	$consumer	OAuthConsumer object //UK: removed string
string	$tokenType	Token type
string	$token	Token value

Returns

OAuthToken OAuthToken object

Definition at line 84 of file OAuthDataStore.php.

                                                                                           : OAuthToken
    {
        return new OAuthToken($consumer, '');
    }

new_access_token()

ILIAS\LTI\ToolProvider\OAuthDataStore::new_access_token	(	OAuthToken	$token,
		OAuthConsumer	$consumer,
			$verifier = null
	)

Get new access token.

Parameters

OAuthToken	$token	Token value //UK: removed string CHECK
OAuthConsumer	$consumer	OAuthConsumer object
string	$verifier	Verification code

Returns

string Null value

Definition at line 134 of file OAuthDataStore.php.

                                                                                                  : ?string
    {
        return null;
    }

new_request_token()

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

Get new request token.

Parameters

OAuthConsumer	$consumer	OAuthConsumer object
mixed	$callback	Callback URL //UK: removed string CHECK

Returns

string Null value

Definition at line 122 of file OAuthDataStore.php.

                                                                                : ?string
    {
        return null;
    }

Field Documentation

$system

Tool Platform null ILIAS\LTI\ToolProvider\OAuthDataStore::$system = null

private

System object.

Definition at line 40 of file OAuthDataStore.php.

Referenced by ILIAS\LTI\ToolProvider\OAuthDataStore\__construct(), and ILIAS\LTI\ToolProvider\OAuthDataStore\lookup_nonce().

---

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

• Services/LTI/src/ToolProvider/OAuthDataStore.php