Spec-Zone.ru › Yii 2.0

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

Все классы | Свойства | Методы
Наследование yii\authclient\clients\LinkedIn » 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/LinkedIn.php

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

Для использования LinkedIn OAuth необходимо зарегистрировать ваше приложение на https://www.linkedin.com/secure/developer.

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

'components' => [
    'authClientCollection' => [
        'class' => 'yii\authclient\Collection',
        'clients' => [
            'linkedin' => [
                'class' => 'yii\authclient\clients\LinkedIn',
                'clientId' => 'linkedin_client_id',
                'clientSecret' => 'linkedin_client_secret',
            ],
        ],
    ]
    ...
]

См. также:

  • http://developer.linkedin.com/documents/authentication
  • https://www.linkedin.com/secure/developer
  • http://developer.linkedin.com/apis

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

Свойство Тип Описание Определено в
$accessToken массив|yii\authclient\OAuthToken Токен доступа или его конфигурация. yii\authclient\BaseOAuth
$apiBaseUrl строка Базовый URL API. yii\authclient\clients\LinkedIn
$attributeNames массив Список имен атрибутов, которые должны быть запрошены у API для инициализации атрибутов пользователя. yii\authclient\clients\LinkedIn
$authUrl строка URL авторизации. yii\authclient\clients\LinkedIn
$autoRefreshAccessToken логическое Выполнять ли автоматически запрос «обновления токена доступа» при истечении срока действия токена доступа. yii\authclient\BaseOAuth
$behaviors yii\base\Behavior[] Список поведенческих элементов, присоединенных к этому компоненту yii\base\Component
$clientId строка ID клиента 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 строка Конечная точка запроса получения токена. yii\authclient\clients\LinkedIn
$userAttributes массив Список атрибутов пользователя. yii\authclient\BaseClient
$validateAuthState логическое Использовать и проверять параметр '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\LinkedIn
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\authclient\clients\LinkedIn
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

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

Метод Описание Определено
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\LinkedIn
defaultNormalizeUserAttributeMap() Возвращает значение по умолчанию $normalizeUserAttributeMap. yii\authclient\clients\LinkedIn
defaultRequestOptions() Возвращает параметры HTTP-запроса по умолчанию. yii\authclient\BaseOAuth
defaultReturnUrl() Создает значение по умолчанию для $returnUrl. yii\authclient\OAuth2
defaultTitle() Генерирует заголовок службы. yii\authclient\clients\LinkedIn
defaultViewOptions() Возвращает значение по умолчанию $viewOptions. yii\authclient\BaseClient
generateAuthState() Генерирует значение auth state. yii\authclient\OAuth2
getState() Возвращает значение постоянного состояния. yii\authclient\BaseClient
getStateKeyPrefix() Возвращает префикс ключа сессии, используемый для хранения внутренних состояний. yii\authclient\BaseClient
initUserAttributes() Инициализирует атрибуты авторизованного пользователя. yii\authclient\clients\LinkedIn
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.linkedin.com/v1'

$attributeNames открытое свойство (доступно с версии 2.0.4)

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

public array $attributeNames = ['id', 'email-address', 'first-name', 'last-name', 'public-profile-url']

$authUrl открытое свойство

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

public string $authUrl = 'https://www.linkedin.com/uas/oauth2/authorization'

$tokenUrl открытое свойство

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

public string $tokenUrl = 'https://www.linkedin.com/uas/oauth2/accessToken'

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

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

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

init() public метод

Инициализирует объект.

Этот метод вызывается в конце конструктора после инициализации объекта заданной конфигурацией.

public void init ( )

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-linkedin.html

Spec-Zone.ru

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