1. class
  2. Hypervel
  3. \
  4. Socialite
  5. \
  6. Two
  7. \
  8. AbstractProvider

AbstractProvider

abstract class AbstractProvider extends AbstractProvider implements Provider

Traits

HasProviderContext

Properties

protected string|null $contextNamespace

The unique context namespace for this provider instance.

 from  HasProviderContext
protected array $parameters

The custom parameters to be sent with the request.

 from  AbstractProvider
protected bool $stateless

Indicates if the session state should be utilized.

 from  AbstractProvider
protected array $additionalConfig

The provider's baseline configuration.

 from  AbstractProvider
protected array $scopes

The scopes being requested.
protected string $scopeSeparator

The separating character for the requested scopes.
protected int $encodingType

The type of the encoding in the query.
protected bool $usesPKCE

Indicates if PKCE should be used.

Methods

mixed
getContext(string $key, mixed $default = null)

No description

from  HasProviderContext
mixed
setContext(string $key, mixed $value)

No description

from  HasProviderContext
mixed
getOrSetContext(string $key, mixed $value)

No description

from  HasProviderContext
string
getContextKey(string $key)

No description

from  HasProviderContext
__construct(Request $request, string $clientId, string $clientSecret, string $redirectUrl, array $guzzle = [])

Create a new provider instance.

AbstractProvider
withConfig(array $config)

Set the baseline provider configuration.

from  AbstractProvider
AbstractProvider
setConfig(array $config)

Override provider configuration for the current request.

mixed
getConfig(string|null $key = null, mixed $default = null)

Get a value from the provider configuration.

from  AbstractProvider
Client
getHttpClient()

Get an instance of the Guzzle HTTP client.

from  AbstractProvider
AbstractProvider
setHttpClient(Client $client)

Set the Guzzle HTTP client instance.

from  AbstractProvider
AbstractProvider
setRequest(Request $request)

Set the request instance.

from  AbstractProvider
Request
getRequest()

Get the request instance.

from  AbstractProvider
bool
usesState()

Determine if the provider is operating with state.

from  AbstractProvider
bool
isStateless()

Determine if the provider is operating as stateless.

from  AbstractProvider
AbstractProvider
stateless()

Indicate that the provider should operate as stateless.

from  AbstractProvider
string
getState()

Get the string used for session state.

from  AbstractProvider
AbstractProvider
with(array $parameters)

Set the custom parameters of the request.

from  AbstractProvider
array
getParameters()

Get the custom parameters of the request.

from  AbstractProvider
string
getAuthUrl(string|null $state)

Get the authentication URL for the provider.

string
getTokenUrl()

Get the token URL for the provider.

mixed
getUserByToken(string $token)

Get the raw user for the given access token.

User
mapUserToObject(array $user)

Map the raw user array to a Socialite User instance.

RedirectResponse
redirect()

Redirect the user of the application to the provider's authentication screen.

string
buildAuthUrlFromBase(string $url, string|null $state)

Build the authentication URL for the provider from the given base URL.

array
getCodeFields(string|null $state = null)

Get the GET parameters for the code request.

string
formatScopes(array $scopes, string $scopeSeparator)

Format the given scopes.

User
user()

Get the User instance for the authenticated user.

User|null
getUser()

Get the user instance from the context.

AbstractProvider
setUser(User $user)

Set the user instance in the context.

User
userInstance(array $response, array $user)

Create a user instance from the given data.

User
userFromToken(string $token)

Get a Social User instance from a known access token.

bool
hasInvalidState()

Determine if the current request / session has a mismatching "state".

mixed
getAccessTokenResponse(string $code)

Get the access token response for the given code.

array
getTokenHeaders(string $code)

Get the headers for the access token request.

array
getTokenFields(string $code)

Get the POST fields for the token request.

Token
refreshToken(string $refreshToken)

Refresh a user's access token with a refresh token.

mixed
getRefreshTokenResponse(string $refreshToken)

Get the refresh token response for the given refresh token.

string
getCode()

Get the code from the request.

AbstractProvider
scopes(array|string $scopes)

Merge the scopes of the requested access.

AbstractProvider
setScopes(array|string $scopes)

Set the scopes of the requested access.

array
getScopes()

Get the current scopes.

AbstractProvider
redirectUrl(string $url)

Set the redirect URL.

string
getRedirectUrl()

Get the redirect URL.

string
getClientId()

Get the client ID.

string
getClientSecret()

Get the client secret.

bool
usesPKCE()

Determine if the provider uses PKCE.

AbstractProvider
enablePKCE()

Enable PKCE for the provider.

string
getCodeVerifier()

Generate a random string of the right length for the PKCE code verifier.

string
getCodeChallenge()

Generate the PKCE code challenge based on the PKCE code verifier in the session.

string
getCodeChallengeMethod()

Return the hash method used to calculate the PKCE code challenge.

Details

in HasProviderContext at line 19
mixed getContext(string $key, mixed $default = null)

No description

Parameters

string $key
mixed $default

Return Value

mixed

in HasProviderContext at line 24
mixed setContext(string $key, mixed $value)

No description

Parameters

string $key
mixed $value

Return Value

mixed

in HasProviderContext at line 29
mixed getOrSetContext(string $key, mixed $value)

No description

Parameters

string $key
mixed $value

Return Value

mixed

in HasProviderContext at line 34
protected string getContextKey(string $key)

No description

Parameters

string $key

Return Value

string

at line 48
__construct(Request $request, string $clientId, string $clientSecret, string $redirectUrl, array $guzzle = [])

Create a new provider instance.

Parameters

Request $request
string $clientId

the client ID
string $clientSecret

the client secret
string $redirectUrl

the redirect URL
array $guzzle

in AbstractProvider at line 58
AbstractProvider withConfig(array $config)

Set the baseline provider configuration.

Called once at registration time (e.g. from a builder or an extend callback). Writes to the instance property so config survives across coroutines. For per-request overrides, use setConfig() instead.

Parameters

array $config

Return Value

AbstractProvider

at line 409
AbstractProvider setConfig(array $config)

Override provider configuration for the current request.

Extends the base setConfig to also handle OAuth2-specific credential keys (client_id, client_secret, redirect) in coroutine context.

Parameters

array $config

Return Value

AbstractProvider

in AbstractProvider at line 83
protected mixed getConfig(string|null $key = null, mixed $default = null)

Get a value from the provider configuration.

Reads per-request context first, falls back to baseline instance property.

Parameters

string|null $key
mixed $default

Return Value

mixed

in AbstractProvider at line 93
protected Client getHttpClient()

Get an instance of the Guzzle HTTP client.

Return Value

Client

in AbstractProvider at line 103
AbstractProvider setHttpClient(Client $client)

Set the Guzzle HTTP client instance.

Parameters

Client $client

Return Value

AbstractProvider

in AbstractProvider at line 116
AbstractProvider setRequest(Request $request)

Set the request instance.

Stores the request in coroutine context so cached providers read the current request without leaking it to concurrent coroutines.

Parameters

Request $request

Return Value

AbstractProvider

in AbstractProvider at line 126
protected Request getRequest()

Get the request instance.

Return Value

Request

in AbstractProvider at line 135
protected bool usesState()

Determine if the provider is operating with state.

Return Value

bool

in AbstractProvider at line 143
protected bool isStateless()

Determine if the provider is operating as stateless.

Return Value

bool

in AbstractProvider at line 151
AbstractProvider stateless()

Indicate that the provider should operate as stateless.

Return Value

AbstractProvider

in AbstractProvider at line 161
protected string getState()

Get the string used for session state.

Return Value

string

in AbstractProvider at line 169
AbstractProvider with(array $parameters)

Set the custom parameters of the request.

Parameters

array $parameters

Return Value

AbstractProvider

in AbstractProvider at line 179
protected array getParameters()

Get the custom parameters of the request.

Return Value

array

at line 61
abstract protected string getAuthUrl(string|null $state)

Get the authentication URL for the provider.

Parameters

string|null $state

Return Value

string

at line 66
abstract protected string getTokenUrl()

Get the token URL for the provider.

Return Value

string

at line 71
abstract protected mixed getUserByToken(string $token)

Get the raw user for the given access token.

Parameters

string $token

Return Value

mixed

at line 76
abstract protected User mapUserToObject(array $user)

Map the raw user array to a Socialite User instance.

Parameters

array $user

Return Value

User

at line 81
RedirectResponse redirect()

Redirect the user of the application to the provider's authentication screen.

Return Value

RedirectResponse

at line 99
protected string buildAuthUrlFromBase(string $url, string|null $state)

Build the authentication URL for the provider from the given base URL.

Parameters

string $url
string|null $state

Return Value

string

at line 107
protected array getCodeFields(string|null $state = null)

Get the GET parameters for the code request.

Parameters

string|null $state

Return Value

array

at line 131
protected string formatScopes(array $scopes, string $scopeSeparator)

Format the given scopes.

Parameters

array $scopes
string $scopeSeparator

Return Value

string

at line 136
User user()

Get the User instance for the authenticated user.

Return Value

User

at line 156
protected User|null getUser()

Get the user instance from the context.

Return Value

User|null

at line 164
protected AbstractProvider setUser(User $user)

Set the user instance in the context.

Parameters

User $user

Return Value

AbstractProvider

at line 174
protected User userInstance(array $response, array $user)

Create a user instance from the given data.

Parameters

array $response
array $user

Return Value

User

at line 189
User userFromToken(string $token)

Get a Social User instance from a known access token.

Parameters

string $token

Return Value

User

at line 199
protected bool hasInvalidState()

Determine if the current request / session has a mismatching "state".

Return Value

bool

at line 213
mixed getAccessTokenResponse(string $code)

Get the access token response for the given code.

Parameters

string $code

Return Value

mixed

at line 226
protected array getTokenHeaders(string $code)

Get the headers for the access token request.

Parameters

string $code

Return Value

array

at line 234
protected array getTokenFields(string $code)

Get the POST fields for the token request.

Parameters

string $code

Return Value

array

at line 254
Token refreshToken(string $refreshToken)

Refresh a user's access token with a refresh token.

Parameters

string $refreshToken

Return Value

Token

at line 269
protected mixed getRefreshTokenResponse(string $refreshToken)

Get the refresh token response for the given refresh token.

Parameters

string $refreshToken

Return Value

mixed

at line 285
protected string getCode()

Get the code from the request.

Return Value

string

at line 293
AbstractProvider scopes(array|string $scopes)

Merge the scopes of the requested access.

Parameters

array|string $scopes

Return Value

AbstractProvider

at line 305
AbstractProvider setScopes(array|string $scopes)

Set the scopes of the requested access.

Parameters

array|string $scopes

Return Value

AbstractProvider

at line 318
array getScopes()

Get the current scopes.

Return Value

array

at line 328
AbstractProvider redirectUrl(string $url)

Set the redirect URL.

Parameters

string $url

Return Value

AbstractProvider

at line 338
protected string getRedirectUrl()

Get the redirect URL.

Return Value

string

at line 346
protected string getClientId()

Get the client ID.

Return Value

string

at line 354
protected string getClientSecret()

Get the client secret.

Return Value

string

at line 362
protected bool usesPKCE()

Determine if the provider uses PKCE.

Return Value

bool

at line 370
AbstractProvider enablePKCE()

Enable PKCE for the provider.

Return Value

AbstractProvider

at line 380
protected string getCodeVerifier()

Generate a random string of the right length for the PKCE code verifier.

Return Value

string

at line 388
protected string getCodeChallenge()

Generate the PKCE code challenge based on the PKCE code verifier in the session.

Return Value

string

at line 398
protected string getCodeChallengeMethod()

Return the hash method used to calculate the PKCE code challenge.

Return Value

string