\Overtrue\Socialite\ProvidersGoogleProvider

__construct()

__construct(\Symfony\Component\HttpFoundation\Request  $request, string  $clientId, string  $clientSecret, string|null  $redirectUrl = null) 

Create a new provider instance.

Parameters

redirect()

redirect(string  $redirectUrl = null) : \Symfony\Component\HttpFoundation\RedirectResponse

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

Parameters

Returns

user()

user(\Overtrue\Socialite\AccessTokenInterface  $token = null) : \Overtrue\Socialite\User

Get the User instance for the authenticated user.

Parameters

Returns

setRedirectUrl()

setRedirectUrl(string  $redirectUrl) : $this

Set redirect url.

Parameters

Returns

withRedirectUrl()

withRedirectUrl(string  $redirectUrl) : $this

Set redirect url.

Parameters

Returns

getRedirectUrl()

getRedirectUrl() : string

Return the redirect url.

Returns

setAccessToken()

setAccessToken(\Overtrue\Socialite\AccessTokenInterface  $accessToken) : $this

Parameters

Returns

getAccessToken()

getAccessToken(string  $code) : string

Get the access token for the given code.

Parameters

Returns

scopes()

scopes(array  $scopes) : $this

Set the scopes of the requested access.

Parameters

Returns

setRequest()

setRequest(\Symfony\Component\HttpFoundation\Request  $request) : $this

Set the request instance.

Parameters

Returns

getRequest()

getRequest() : \Symfony\Component\HttpFoundation\Request

Get the request instance.

Returns

stateless()

stateless() : $this

Indicates that the provider should operate as stateless.

Returns

with()

with(array  $parameters) : $this

Set the custom parameters of the request.

Parameters

Returns

getName()

getName() : string

Returns

getAuthUrl()

getAuthUrl(string  $state) : string

Get the authentication URL for the provider.

Parameters

Returns

getTokenUrl()

getTokenUrl() : string

Get the token URL for the provider.

Returns

getUserByToken()

getUserByToken(\Overtrue\Socialite\AccessTokenInterface  $token) : array

Get the raw user for the given access token.

Parameters

Returns

mapUserToObject()

mapUserToObject(array  $user) : \Overtrue\Socialite\User

Map the raw user array to a Socialite User instance.

Parameters

Returns

buildAuthUrlFromBase()

buildAuthUrlFromBase(string  $url, string  $state) : string

Get the authentication URL for the provider.

Parameters

Returns

getCodeFields()

getCodeFields(string|null  $state = null) : array

Get the GET parameters for the code request.

Parameters

Returns

formatScopes()

formatScopes(array  $scopes, string  $scopeSeparator) : string

Format the given scopes.

Parameters

Returns

hasInvalidState()

hasInvalidState() : boolean

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

Returns

getTokenFields()

getTokenFields(string  $code) : array

Get the POST fields for the token request.

Parameters

Returns

parseAccessToken()

parseAccessToken(\Psr\Http\Message\StreamInterface|array  $body) : \Overtrue\Socialite\AccessTokenInterface

Get the access token from the token response body.

Parameters

Returns

getCode()

getCode() : string

Get the code from the request.

Returns

getHttpClient()

getHttpClient() : \GuzzleHttp\Client

Get a fresh instance of the Guzzle HTTP client.

Returns

usesState()

usesState() : boolean

Determine if the provider is operating with state.

Returns

isStateless()

isStateless() : boolean

Determine if the provider is operating as stateless.

Returns

arrayItem()

arrayItem(array  $array, string  $key, mixed  $default = null) : mixed

Return array item by key.

Parameters

Returns

makeState()

makeState() : string|boolean

Put state to session storage and return it.

Returns