Spec-Zone.ru › Yii 2.0

Класс yii\authclient\clients\VKontakte

Все классы | Свойства | Методы
Наследование yii\authclient\clients\VKontakte » yii\authclient\OAuth2 » yii\authclient\BaseOAuth » yii\authclient\BaseClient » yii\base\Component » yii\base\Object
Реализует yii\authclient\ClientInterface, yii\base\Configurable
Доступно начиная с версии 2.0
Исходный код https://github.com/yiisoft/yii2-authclient/blob/master/clients/VKontakte.php

VKontakte позволяет аутентификацию через VKontakte OAuth.

Для использования VKontakte OAuth необходимо зарегистрировать ваше приложение на http://vk.com/editapp?act=create.

Пример конфигурации приложения:

'components' => [
    'authClientCollection' => [
        'class' => 'yii\authclient\Collection',
        'clients' => [
            'vkontakte' => [
                'class' => 'yii\authclient\clients\VKontakte',
                'clientId' => 'vkontakte_client_id',
                'clientSecret' => 'vkontakte_client_secret',
            ],
        ],
    ]
    ...
]

См. также:

  • http://vk.com/editapp?act=create
  • http://vk.com/developers.php?oid=-1&p=users.get

Публичные свойства

Свойство Тип Описание Определено в
$accessToken массив|yii\authclient\OAuthToken Токен доступа или его конфигурация. yii\authclient\BaseOAuth
$apiBaseUrl строка Базовый URL API. yii\authclient\clients\VKontakte
$attributeNames массив Список имен атрибутов, которые должны быть запрошены у API для инициализации атрибутов пользователя. yii\authclient\clients\VKontakte
$authUrl строка URL авторизации. yii\authclient\clients\VKontakte
$autoRefreshAccessToken булево Автоматически выполнять запрос "обновления токена доступа" при истечении срока действия токена доступа. yii\authclient\BaseOAuth
$behaviors yii\base\Behavior[] Список присоединённых к этому компоненту поведений. yii\base\Component
$clientId строка Идентификатор клиента OAuth. yii\authclient\OAuth2
$clientSecret строка Секрет клиента OAuth. yii\authclient\OAuth2
$httpClient yii\httpclient\Client Внутренний HTTP-клиент. yii\authclient\BaseClient
$id строка Идентификатор сервиса. yii\authclient\ClientInterface
$name строка Название сервиса. yii\authclient\ClientInterface
$normalizeUserAttributeMap массив Карта нормализации атрибутов пользователя. yii\authclient\BaseClient
$requestOptions массив Параметры HTTP-запроса. yii\authclient\BaseClient
$returnUrl строка URL возврата yii\authclient\BaseOAuth
$scope строка Область запроса авторизации. yii\authclient\BaseOAuth
$signatureMethod массив|yii\authclient\signature\BaseMethod Экземпляр метода подписи или его конфигурация в виде массива. yii\authclient\BaseOAuth
$stateStorage yii\authclient\StateStorageInterface Хранилище состояния. yii\authclient\BaseClient
$title строка Заголовок сервиса. yii\authclient\ClientInterface
$tokenUrl строка Конечная точка URL-адреса запроса токена. yii\authclient\clients\VKontakte
$userAttributes массив Список атрибутов пользователя. yii\authclient\BaseClient
$validateAuthState булево Использовать и проверять параметр auth 'state' в процессе аутентификации. yii\authclient\OAuth2
$version строка Версия протокола. yii\authclient\OAuth2
$viewOptions массив Параметры представления в формате: имяПараметра => значениеПараметра yii\authclient\BaseClient

Публичные методы

Метод Описание Определено в
__call() Вызывает именованный метод, который не является методом класса. yii\base\Component
__clone() Этот метод вызывается после создания объекта путём клонирования существующего. yii\base\Component
__construct() Конструктор. yii\base\Object
__get() Возвращает значение свойства компонента. yii\base\Component
__isset() Проверяет, установлено ли свойство, т.е. определено и не равно null. yii\base\Component
__set() Устанавливает значение свойства компонента. yii\base\Component
__unset() Устанавливает свойство компонента в значение null. yii\base\Component
api() Выполняет запрос к API OAuth, возвращая данные ответа. yii\authclient\BaseOAuth
applyAccessTokenToRequest() Применяет токен доступа к экземпляру HTTP-запроса. yii\authclient\clients\VKontakte
attachBehavior() Прикрепляет поведение к данному компоненту. yii\base\Component
attachBehaviors() Прикрепляет список поведений к компоненту. yii\base\Component
authenticateClient() Авторизует OAuth-клиент напрямую у поставщика без участия третьей стороны (пользователя), используя тип запроса «client_credentials». yii\authclient\OAuth2
authenticateUser() Авторизует пользователя напрямую по паре «имя пользователя/пароль», используя тип запроса «password». yii\authclient\OAuth2
authenticateUserJwt() Авторизует пользователя напрямую с помощью JSON Web Token (JWT). yii\authclient\OAuth2
beforeApiRequestSend() Обрабатывает событие yii\httpclient\Request::EVENT_BEFORE_SEND. yii\authclient\BaseOAuth
behaviors() Возвращает список поведений, которые должен исполнять этот компонент. yii\base\Component
buildAuthUrl() Создаёт URL авторизации пользователя. yii\authclient\OAuth2
canGetProperty() Возвращает значение, указывающее, можно ли прочитать свойство. yii\base\Component
canSetProperty() Возвращает значение, указывающее, можно ли установить свойство. yii\base\Component
className() Возвращает полное квалифицированное имя этого класса. yii\base\Object
createApiRequest() Создаёт HTTP-запрос для вызова API. yii\authclient\BaseOAuth
createRequest() Создаёт экземпляр HTTP-запроса. yii\authclient\BaseClient
detachBehavior() Открепляет поведение от компонента. yii\base\Component
detachBehaviors() Открепляет все поведения от компонента. yii\base\Component
ensureBehaviors() Убеждается, что поведения, объявленные в behaviors(), прикреплены к этому компоненту. yii\base\Component
fetchAccessToken() Извлекает токен доступа по коду авторизации. yii\authclient\OAuth2
getAccessToken() yii\authclient\BaseOAuth
getBehavior() Возвращает объект именованного поведения. yii\base\Component
getBehaviors() Возвращает все прикреплённые к этому компоненту поведения. yii\base\Component
getHttpClient() Возвращает HTTP-клиент. yii\authclient\BaseClient
getId() yii\authclient\ClientInterface
getName() yii\authclient\ClientInterface
getNormalizeUserAttributeMap() yii\authclient\BaseClient
getRequestOptions() yii\authclient\BaseClient
getReturnUrl() yii\authclient\BaseOAuth
getSignatureMethod() yii\authclient\BaseOAuth
getStateStorage() yii\authclient\BaseClient
getTitle() yii\authclient\ClientInterface
getUserAttributes() yii\authclient\ClientInterface
getViewOptions() yii\authclient\ClientInterface
hasEventHandlers() Возвращает значение, указывающее, есть ли обработчик, прикреплённый к указанному событию. yii\base\Component
hasMethod() Возвращает значение, указывающее, определён ли метод. yii\base\Component
hasProperty() Возвращает значение, указывающее, определено ли свойство для этого компонента. yii\base\Component
init() Инициализирует объект. yii\base\Object
off() Открепляет существующий обработчик событий от этого компонента. yii\base\Component
on() Прикрепляет обработчик событий к событию. yii\base\Component
refreshAccessToken() Получает новый токен авторизации для замены истекшего. yii\authclient\OAuth2
setAccessToken() Устанавливает используемый токен доступа. yii\authclient\BaseOAuth
setHttpClient() Устанавливает используемый HTTP-клиент. yii\authclient\BaseOAuth
setId() yii\authclient\ClientInterface
setName() yii\authclient\ClientInterface
setNormalizeUserAttributeMap() yii\authclient\BaseClient
setRequestOptions() yii\authclient\BaseClient
setReturnUrl() yii\authclient\BaseOAuth
setSignatureMethod() Устанавливает метод подписи, который будет использоваться. yii\authclient\BaseOAuth
setStateStorage() yii\authclient\BaseClient
setTitle() yii\authclient\ClientInterface
setUserAttributes() yii\authclient\BaseClient
setViewOptions() yii\authclient\BaseClient
trigger() Вызывает событие. yii\base\Component

Protected Methods

Method Description Defined By
applyClientCredentialsToRequest() Применяет учетные данные клиента (например, $clientId и $clientSecret) к экземпляру HTTP-запроса. yii\authclient\OAuth2
composeUrl() Создаёт URL из базового URL и параметров GET. yii\authclient\BaseOAuth
createHttpClient() Создаёт экземпляр HTTP-клиента из ссылки или конфигурации. yii\authclient\BaseOAuth
createSignatureMethod() Создаёт экземпляр метода подписи из его конфигурации. yii\authclient\BaseOAuth
createToken() Создаёт токен из его конфигурации. yii\authclient\OAuth2
defaultName() Генерирует имя сервиса. yii\authclient\clients\VKontakte
defaultNormalizeUserAttributeMap() Возвращает значение по умолчанию для $normalizeUserAttributeMap. yii\authclient\clients\VKontakte
defaultRequestOptions() Возвращает параметры HTTP-запроса по умолчанию. yii\authclient\BaseOAuth
defaultReturnUrl() Создаёт значение по умолчанию для $returnUrl. yii\authclient\OAuth2
defaultTitle() Генерирует заголовок сервиса. yii\authclient\clients\VKontakte
defaultViewOptions() Возвращает значение по умолчанию для $viewOptions. yii\authclient\BaseClient
generateAuthState() Генерирует значение состояния авторизации. yii\authclient\OAuth2
getState() Возвращает значение состояния. yii\authclient\BaseClient
getStateKeyPrefix() Возвращает префикс ключа сессии, который используется для хранения внутренних состояний. yii\authclient\BaseClient
initUserAttributes() Инициализирует атрибуты авторизованного пользователя. yii\authclient\clients\VKontakte
normalizeUserAttributes() Нормализует предоставленные атрибуты пользователя в соответствии с $normalizeUserAttributeMap. yii\authclient\BaseClient
removeState() Удаляет значение состояния. yii\authclient\BaseClient
restoreAccessToken() Восстанавливает токен доступа. yii\authclient\BaseOAuth
saveAccessToken() Сохраняет токен в качестве состояния. yii\authclient\BaseOAuth
sendRequest() Отправляет заданный HTTP-запрос и возвращает данные ответа. yii\authclient\BaseOAuth
setState() Устанавливает состояние. yii\authclient\BaseClient

Подробное описание свойств

$apiBaseUrl общедоступное свойство

Базовый URL API. Это поле будет использовано как значение yii\httpclient\Client::$baseUrl для $httpClient. Примечание: изменение этого свойства не будет иметь эффекта после инициализации $httpClient.

public string $apiBaseUrl = 'https://api.vk.com/method'

$attributeNames общедоступное свойство (доступно начиная с версии 2.0.4)

Список имён атрибутов, которые должны быть запрошены у API для инициализации атрибутов пользователя.

public array $attributeNames = ['uid', 'first_name', 'last_name', 'nickname', 'screen_name', 'sex', 'bdate', 'city', 'country', 'timezone', 'photo']

$authUrl общедоступное свойство

URL авторизации.

public string $authUrl = 'https://oauth.vk.com/authorize'

$tokenUrl общедоступное свойство

Конечная точка запроса токена.

public string $tokenUrl = 'https://oauth.vk.com/access_token'

Подробное описание методов

applyAccessTokenToRequest() public метод

Применяет токен доступа к экземпляру HTTP-запроса.

public void applyAccessTokenToRequest ( $request, $accessToken )
$request yii\httpclient\Request

Экземпляр HTTP-запроса.

$accessToken yii\authclient\OAuthToken

Экземпляр токена доступа.

defaultName() защищённый метод

Генерирует имя сервиса.

protected string defaultName ( )
return string

Имя сервиса.

defaultNormalizeUserAttributeMap() защищённый метод

Возвращает значение по умолчанию $normalizeUserAttributeMap.

Конкретный клиент может переопределить этот метод, чтобы предоставить специфический набор значений по умолчанию.

protected array defaultNormalizeUserAttributeMap ( )
return array

Карта атрибутов для нормализации.

defaultTitle() защищённый метод

Генерирует заголовок сервиса.

protected string defaultTitle ( )
return string

Заголовок сервиса.

initUserAttributes() защищённый метод

Инициализирует атрибуты аутентифицированного пользователя.

protected array initUserAttributes ( )
return array

Атрибуты пользователя для аутентификации.

© 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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API