interface OAuthAuthenticator implements Authenticator

Methods

void
set(PendingRequest $pendingRequest)

Apply the authentication to the request.

string
getAccessToken()

Get the access token.

string|null
getRefreshToken()

Get the refresh token.

getExpiresAt()

Get the expiry.

array|null
getScopes()

Get the reported scopes, or null when the provider did not report them.

bool
hasExpired()

Determine if the authenticator has expired.

bool
hasNotExpired()

Determine if the authenticator has not expired.

bool
isRefreshable()

Determine if the authenticator is refreshable.

bool
isNotRefreshable()

Determine if the authenticator is not refreshable.

Details

in Authenticator at line 14
void set(PendingRequest $pendingRequest)

Apply the authentication to the request.

Parameters

PendingRequest $pendingRequest

Return Value

void

at line 14
string getAccessToken()

Get the access token.

Return Value

string

at line 19
string|null getRefreshToken()

Get the refresh token.

Return Value

string|null

at line 24
DateTimeImmutable|null getExpiresAt()

Get the expiry.

Return Value

DateTimeImmutable|null

at line 31
array|null getScopes()

Get the reported scopes, or null when the provider did not report them.

Return Value

array|null

at line 36
bool hasExpired()

Determine if the authenticator has expired.

Return Value

bool

at line 41
bool hasNotExpired()

Determine if the authenticator has not expired.

Return Value

bool

at line 46
bool isRefreshable()

Determine if the authenticator is refreshable.

Return Value

bool

at line 51
bool isNotRefreshable()

Determine if the authenticator is not refreshable.

Return Value

bool