On this page
Class yii\authclient\clients\VKontakte
Inheritance | yii\authclient\clients\VKontakte » yii\authclient\OAuth2 » yii\authclient\BaseOAuth » yii\authclient\BaseClient » yii\base\Component » yii\base\Object |
---|---|
Implements | yii\authclient\ClientInterface, yii\base\Configurable |
Available since version | 2.0 |
Source Code | https://github.com/yiisoft/yii2-authclient/blob/master/clients/VKontakte.php |
VKontakte allows authentication via VKontakte OAuth.
In order to use VKontakte OAuth you must register your application at http://vk.com/editapp?act=create.
Example application configuration:
'components' => [
'authClientCollection' => [
'class' => 'yii\authclient\Collection',
'clients' => [
'vkontakte' => [
'class' => 'yii\authclient\clients\VKontakte',
'clientId' => 'vkontakte_client_id',
'clientSecret' => 'vkontakte_client_secret',
],
],
]
...
]
See also:
Public Properties
Public Methods
Protected Methods
Property Details
$apiBaseUrl public property
API base URL. This field will be used as yii\httpclient\Client::$baseUrl value of $httpClient. Note: changing this property will take no effect after $httpClient is instantiated.
public string $apiBaseUrl = 'https://api.vk.com/method'
$attributeNames public property (available since version 2.0.4)
List of attribute names, which should be requested from API to initialize user attributes.
public array $attributeNames = ['uid', 'first_name', 'last_name', 'nickname', 'screen_name', 'sex', 'bdate', 'city', 'country', 'timezone', 'photo']
$authUrl public property
Authorize URL.
public string $authUrl = 'https://oauth.vk.com/authorize'
$tokenUrl public property
Token request URL endpoint.
public string $tokenUrl = 'https://oauth.vk.com/access_token'
Method Details
applyAccessTokenToRequest() public method
Applies access token to the HTTP request instance.
public void applyAccessTokenToRequest ( $request, $accessToken ) | ||
---|---|---|
$request | yii\httpclient\Request | HTTP request instance. |
$accessToken | yii\authclient\OAuthToken | Access token instance. |
defaultName() protected method
Generates service name.
protected string defaultName ( ) | ||
---|---|---|
return | string | Service name. |
defaultNormalizeUserAttributeMap() protected method
Returns the default $normalizeUserAttributeMap value.
Particular client may override this method in order to provide specific default map.
protected array defaultNormalizeUserAttributeMap ( ) | ||
---|---|---|
return | array | Normalize attribute map. |
defaultTitle() protected method
Generates service title.
protected string defaultTitle ( ) | ||
---|---|---|
return | string | Service title. |
initUserAttributes() protected method
Initializes authenticated user attributes.
protected array initUserAttributes ( ) | ||
---|---|---|
return | array | Auth user attributes. |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-authclient-clients-vkontakte.html