| Methods |
abstract
protected
|
getListener(): ?Server
Get an in-process HTTP server to receive OAuth 2.0 redirects from the
provider to the client, or null if flows that…
Get an in-process HTTP server to receive OAuth 2.0 redirects from the
provider to the client, or null if flows that require it are disabled
|
#
|
abstract
protected
|
getProvider(): AbstractProvider
Get an OAuth 2.0 provider for the client
Get an OAuth 2.0 provider for the client
|
#
|
abstract
protected
|
getFlow(): OAuth2Client::GRANT_*
Get the client's OAuth 2.0 flow
Get the client's OAuth 2.0 flow
|
#
|
abstract
protected
|
getJsonWebKeySetUrl(): ?string
Get the URL of the OAuth 2.0 provider's JSON Web Key Set, or null to
disable JWT signature validation and decoding
Get the URL of the OAuth 2.0 provider's JSON Web Key Set, or null to
disable JWT signature validation and decoding
Required for token signature validation. Check the provider's
https://server.com/.well-known/openid-configuration if unsure.
|
#
|
abstract
protected
|
receiveToken(OAuth2AccessToken $token, array<string, mixed>|null $idToken, OAuth2Client::GRANT_* $grantType): void
Called when an access token is received from the OAuth 2.0 provider
Called when an access token is received from the OAuth 2.0 provider
|
#
|
final
protected
|
getRedirectUri(): ?string
Get the URI that receives redirects from the OAuth 2.0 provider
Get the URI that receives redirects from the OAuth 2.0 provider
Returns null if {@see OAuth2Client::getListener()} does not return an
HTTP listener.
|
#
|
final
public
|
getAccessToken(string[]|null $scopes = null): OAuth2AccessToken
Get an OAuth 2.0 access token from the cache if possible, otherwise use a
refresh token to acquire one from the…
Get an OAuth 2.0 access token from the cache if possible, otherwise use a
refresh token to acquire one from the provider if possible, otherwise
flush all tokens and authorize with the provider from scratch
|
#
|
final
protected
|
refreshAccessToken(): ?OAuth2AccessToken
If an unexpired refresh token is available, use it to get a new access
token from the provider if possible
If an unexpired refresh token is available, use it to get a new access
token from the provider if possible
|
#
|
final
protected
|
authorize(array<string, mixed> $options = []): OAuth2AccessToken
Get an access token from the OAuth 2.0 provider
Get an access token from the OAuth 2.0 provider
|
#
|
final
public
|
flushTokens(): $this
Remove any tokens issued by the OAuth 2.0 provider from the cache
Remove any tokens issued by the OAuth 2.0 provider from the cache
|
#
|
final
public
|
getIdToken(): array<string, mixed>|null
Get the decoded ID token most recently issued with an access token by the
OAuth 2.0 provider
Get the decoded ID token most recently issued with an access token by the
OAuth 2.0 provider
|
#
|