OAuthDataStore Class Reference

Class to represent an OAuth datastore. More...

Inheritance diagram for OAuthDataStore:

Public Member Functions
	__construct ($system)
	Class constructor.
	lookup_consumer ($consumerKey)
	Create an OAuthConsumer object for the system.
	lookup_token ($consumer, $tokenType, $token)
	Create an OAuthToken object for the system.
	lookup_nonce ($consumer, $token, $value, $timestamp)
	Lookup nonce value for the system.
	new_request_token ($consumer, $callback=null)
	Get new request token.
	new_access_token ($token, $consumer, $verifier=null)
	Get new access token.
	lookup_consumer ($consumer_key)
	Find consumer based on key.
	lookup_token ($consumer, $token_type, $token)
	Find token.
	lookup_nonce ($consumer, $token, $nonce, $timestamp)
	Check nonce value.
	new_request_token ($consumer, $callback=null)
	Get new request token.
	new_access_token ($token, $consumer, $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

Definition at line 19 of file OAuthDataStore.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$system

)

Class constructor.

Parameters

Platform | Tool

$system

System object

Definition at line 34 of file OAuthDataStore.php.

Member Function Documentation

lookup_consumer()

lookup_consumer

(

$consumerKey

)

Create an OAuthConsumer object for the system.

Parameters

string

$consumerKey

Consumer key value

Returns

OAuthConsumer OAuthConsumer object

Reimplemented from OAuthDataStore.

Definition at line 46 of file OAuthDataStore.php.

References Tool\$defaultTool.

lookup_nonce()

lookup_nonce	(		$consumer,
			$token,
			$value,
			$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 OAuthDataStore.

Definition at line 90 of file OAuthDataStore.php.

lookup_token()

lookup_token	(		$consumer,
			$tokenType,
			$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 OAuthDataStore.

Definition at line 75 of file OAuthDataStore.php.

new_access_token()

new_access_token	(		$token,
			$consumer,
			$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 OAuthDataStore.

Definition at line 131 of file OAuthDataStore.php.

new_request_token()

new_request_token	(		$consumer,
			$callback = null
	)

Get new request token.

Parameters

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

Returns

string|null Null value

Reimplemented from OAuthDataStore.

Definition at line 117 of file OAuthDataStore.php.

---

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

• OAuthDataStore.php