• Главная
• Overtrue
• Socialite
• Providers
• AbstractProvider

PHP Класс Overtrue\Socialite\Providers\AbstractProvider

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство	Тип	Описание
$clientId	string	The client ID.
$clientSecret	string	The client secret.
$config	Overtrue\Socialite\Config	The configuration.
$encodingType		The type of the encoding in the query.
$parameters	array	The custom parameters to be sent with the request.
$redirectUrl	string	The redirect URL.
$request	Symfony\Component\HttpFoundation\Request	The HTTP request instance.
$scopeSeparator	string	The separating character for the requested scopes.
$scopes	array	The scopes being requested.
$stateless	boolean	Indicates if the session state should be utilized.

Открытые методы

Метод	Описание
__construct ( Request $request, Config $config, string $clientId, string $clientSecret, string | null $redirectUrl = null )	Create a new provider instance.
getAccessToken ( string $code ) : AccessToken	Get the access token for the given code.
getRedirectUrl ( ) : string	Return the redirect url.
getRequest ( ) : Request	Get the request instance.
redirect ( string $redirectUrl = null ) : RedirectResponse	Redirect the user of the application to the provider's authentication screen.
scopes ( array $scopes )	Set the scopes of the requested access.
setRedirectUrl ( string $redirectUrl )	Set redirect url.
setRequest ( Request $request )	Set the request instance.
stateless ( )	Indicates that the provider should operate as stateless.
user ( Overtrue\Socialite\AccessTokenInterface $token = null )
with ( array $parameters )	Set the custom parameters of the request.
withRedirectUrl ( string $redirectUrl )	Set redirect url.

Защищенные методы

Метод	Описание
arrayItem ( array $array, string $key, mixed $default = null ) : mixed	Return array item by key.
buildAuthUrlFromBase ( string $url, string $state ) : string	Get the authentication URL for the provider.
formatScopes ( array $scopes, string $scopeSeparator ) : string	Format the given scopes.
getAuthUrl ( string $state ) : string	Get the authentication URL for the provider.
getCode ( ) : string	Get the code from the request.
getCodeFields ( string | null $state = null ) : array	Get the GET parameters for the code request.
getHttpClient ( ) : Client	Get a fresh instance of the Guzzle HTTP client.
getTokenFields ( string $code ) : array	Get the POST fields for the token request.
getTokenUrl ( ) : string	Get the token URL for the provider.
getUserByToken ( Overtrue\Socialite\AccessTokenInterface $token ) : array	Get the raw user for the given access token.
hasInvalidState ( ) : boolean	Determine if the current request / session has a mismatching "state".
isStateless ( ) : boolean	Determine if the provider is operating as stateless.
mapUserToObject ( array $user ) : Overtrue\Socialite\User	Map the raw user array to a Socialite User instance.
parseAccessToken ( Psr\Http\Message\StreamInterface | array $body ) : AccessToken	Get the access token from the token response body.
usesState ( ) : boolean	Determine if the provider is operating with state.

Описание методов

Описание свойств