phpBB API Documentation
Class

phpbb\auth\provider\oauth\token_storage

class token_storage implements TokenStorageInterface

OAuth storage wrapper for phpbb's cache

Methods

__construct(driver_interface $db, user $user, $oauth_token_table, $oauth_state_table)

Creates token storage for phpBB.

retrieveAccessToken($service)

{@inheritdoc}

storeAccessToken($service, TokenInterface $token)

{@inheritdoc}

hasAccessToken($service)

{@inheritdoc}

clearToken($service)

{@inheritdoc}

clearAllTokens()

{@inheritdoc}

storeAuthorizationState($service, $state)

{@inheritdoc}

hasAuthorizationState($service)

{@inheritdoc}

retrieveAuthorizationState($service)

{@inheritdoc}

clearAuthorizationState($service)

{@inheritdoc}

clearAllAuthorizationStates()

{@inheritdoc}

set_user_id($user_id)

Updates the user_id field in the database assosciated with the token

has_access_token_by_session($service)

Checks to see if an access token exists solely by the session_id of the user

has_state_by_session($service)

Checks to see if a state exists solely by the session_id of the user

retrieve_access_token_by_session($service)

retrieve_state_by_session($service)

json_encode_token(TokenInterface $token)

json_decode_token($json)

Details

at line 73
public __construct(driver_interface $db, user $user, $oauth_token_table, $oauth_state_table)

Creates token storage for phpBB.

Parameters

driver_interface $db
user $user
$oauth_token_table
$oauth_state_table

at line 84
public retrieveAccessToken($service)

{@inheritdoc}

Parameters

$service

at line 109
public storeAccessToken($service, TokenInterface $token)

{@inheritdoc}

Parameters

$service
TokenInterface $token

at line 146
public hasAccessToken($service)

{@inheritdoc}

Parameters

$service

at line 171
public clearToken($service)

{@inheritdoc}

Parameters

$service

at line 194
public clearAllTokens()

{@inheritdoc}

at line 214
public storeAuthorizationState($service, $state)

{@inheritdoc}

Parameters

$service
$state

at line 237
public hasAuthorizationState($service)

{@inheritdoc}

Parameters

$service

at line 262
public retrieveAuthorizationState($service)

{@inheritdoc}

Parameters

$service

at line 287
public clearAuthorizationState($service)

{@inheritdoc}

Parameters

$service

at line 310
public clearAllAuthorizationStates()

{@inheritdoc}

at line 332
public set_user_id($user_id)

Updates the user_id field in the database assosciated with the token

Parameters

$user_id

at line 354
public has_access_token_by_session($service)

Checks to see if an access token exists solely by the session_id of the user

Parameters

$service

at line 377
public has_state_by_session($service)

Checks to see if a state exists solely by the session_id of the user

Parameters

$service

at line 405
public retrieve_access_token_by_session($service)

Parameters

$service

at line 422
public retrieve_state_by_session($service)

Parameters

$service

at line 523
public json_encode_token(TokenInterface $token)

Parameters

TokenInterface $token

at line 545
public json_decode_token($json)

Parameters

$json