\OAuth2\StorageAccessTokenInterface

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

Summary

Methods

Constants

getAccessToken()
setAccessToken()

No constants found

No protected methods found

N/A

No private methods found

N/A

getAccessToken(string  $oauth_token) : array|null

Look up the supplied oauth_token from storage.

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

string

$oauth_token

array|null —

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

code	array( 'expires' => $expires, // Stored expiration in unix timestamp. 'client_id' => $client_id, // (optional) Stored client identifier. 'user_id' => $user_id, // (optional) Stored user identifier. 'scope' => $scope, // (optional) Stored scope values in space-separated string. 'id_token' => $id_token // (optional) Stored id_token (if "use_openid_connect" is true). );
endcode
ingroup	oauth2_section_7

setAccessToken(string  $oauth_token, mixed  $client_id, mixed  $user_id, integer  $expires, string  $scope = null)

Store the supplied access token values to storage.

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

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