OAuth2\Storage\AccessTokenInterface Interface Reference

Inheritance diagram for OAuth2\Storage\AccessTokenInterface:

Public Member Functions
	getAccessToken ($oauth_token)
	setAccessToken ($oauth_token, $client_id, $user_id, $expires, $scope=null)

Detailed Description

Implement this interface to specify where the OAuth2 Server should get/save access tokens

Author

Brent Shaffer <bshafs at gmail dot com>

Definition at line 11 of file AccessTokenInterface.php.

Member Function Documentation

getAccessToken()

OAuth2\Storage\AccessTokenInterface::getAccessToken

(

$oauth_token

)

Look up the supplied oauth_token from storage.

We need to retrieve access token data as we create and verify tokens.

Parameters

$oauth_token

oauth_token to be check with.

Returns

An associative array as below, and return NULL if the supplied oauth_token is invalid:

• expires: Stored expiration in unix timestamp.
• client_id: (optional) Stored client identifier.
• user_id: (optional) Stored user identifier.
• scope: (optional) Stored scope values in space-separated string.
• id_token: (optional) Stored id_token (if "use_openid_connect" is true).

Implemented in OAuth2\Storage\JwtAccessToken, OAuth2\Storage\Redis, OAuth2\Storage\Pdo, OAuth2\Storage\Mongo, OAuth2\Storage\Memory, OAuth2\Storage\DynamoDB, OAuth2\Storage\CouchbaseDB, and OAuth2\Storage\Cassandra.

setAccessToken()

OAuth2\Storage\AccessTokenInterface::setAccessToken	(		$oauth_token,
			$client_id,
			$user_id,
			$expires,
			$scope = null
	)

Store the supplied access token values to storage.

We need to store access token data as we create and verify tokens.

Parameters

	$oauth_token	oauth_token to be stored.
	$client_id	client identifier to be stored.
	$user_id	user identifier to be stored.
int	$expires	expiration to be stored as a Unix timestamp.
string	$scope	OPTIONAL Scopes to be stored in space-separated string.

Implemented in OAuth2\Storage\JwtAccessToken, OAuth2\Storage\Redis, OAuth2\Storage\Pdo, OAuth2\Storage\Mongo, OAuth2\Storage\DynamoDB, OAuth2\Storage\CouchbaseDB, and OAuth2\Storage\Cassandra.

---

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

• plugins/OAuth2/Storage/AccessTokenInterface.php