• Главная
• yii
• authclient
• OAuth2

PHP Класс yii\authclient\OAuth2

In oder to acquire access token perform following sequence: php use yii\authclient\OAuth2; assuming class MyAuthClient extends OAuth2 $oauthClient = new MyAuthClient(); $url = $oauthClient->buildAuthUrl(); // Build authorization URL Yii::$app->getResponse()->redirect($url); // Redirect to authorization URL. After user returns at our site: $code = $_GET['code']; $accessToken = $oauthClient->fetchAccessToken($code); // Get access token Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство	Тип	Описание
$clientId		OAuth client ID.
$clientSecret		OAuth client secret.
$tokenUrl		token request URL endpoint.
$validateAuthState		whether to use and validate auth 'state' parameter in authentication flow. If enabled - the opaque value will be generated and applied to auth URL to maintain state between the request and callback. The authorization server includes this value, when redirecting the user-agent back to the client. The option is used for preventing cross-site request forgery.
$version		protocol version.

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

Метод	Описание
applyAccessTokenToRequest ( $request, $accessToken )
authenticateClient ( array $params = [] ) : OAuthToken	Authenticate OAuth client directly at the provider without third party (user) involved, using 'client_credentials' grant type.
authenticateUser ( string $username, string $password, array $params = [] ) : OAuthToken	Authenticates user directly by 'username/password' pair, using 'password' grant type.
buildAuthUrl ( array $params = [] ) : string	Composes user authorization URL.
fetchAccessToken ( string $authCode, array $params = [] ) : OAuthToken	Fetches access token from authorization code.
refreshAccessToken ( OAuthToken $token ) : OAuthToken	Gets new auth token to replace expired one.

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

Метод	Описание
createToken ( array $tokenConfig = [] ) : OAuthToken	Creates token from its configuration.
defaultReturnUrl ( ) : string	Composes default [[returnUrl]] value.
generateAuthState ( ) : string	Generates the auth state value.

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

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