PHP Класс yii\authclient\OAuth1

In order to acquire access token perform following sequence: ~~~ use yii\authclient\OAuth1; $oauthClient = new OAuth1(); $requestToken = $oauthClient->fetchRequestToken(); // Get request token $url = $oauthClient->buildAuthUrl($requestToken); // Get authorization URL return Yii::$app->getResponse()->redirect($url); // Redirect to authorization URL After user returns at our site: $accessToken = $oauthClient->fetchAccessToken($requestToken); // Upgrade to access token ~~~
См. также: http://oauth.net/
С версии: 2.0
Автор: Paul Klimov ([email protected])
Наследование: extends BaseOAuth
Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$accessTokenMethod access token HTTP method.
$accessTokenUrl OAuth access token URL.
$authorizationHeaderMethods list of the request methods, which require adding 'Authorization' header. By default only POST requests will have 'Authorization' header. You may set this option to null in order to make all requests to use 'Authorization' header.
$consumerKey OAuth consumer key.
$consumerSecret OAuth consumer secret.
$requestTokenMethod request token HTTP method.
$requestTokenUrl OAuth request token URL.
$version protocol version.

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

Метод Описание
applyAccessTokenToRequest ( $request, $accessToken )
beforeRequestSend ( RequestEvent $event ) Handles [[Request::EVENT_BEFORE_SEND]] event.
buildAuthUrl ( OAuthToken $requestToken = null, array $params = [] ) : string Composes user authorization URL.
createApiRequest ( )
createRequest ( )
fetchAccessToken ( string $oauthToken = null, OAuthToken $requestToken = null, string $oauthVerifier = null, array $params = [] ) : OAuthToken Fetches OAuth access token.
fetchRequestToken ( array $params = [] ) : OAuthToken Fetches the OAuth request token.
refreshAccessToken ( OAuthToken $token ) : OAuthToken Gets new auth token to replace expired one.
signRequest ( Request $request, OAuthToken | null $token = null ) Sign given request with [[signatureMethod]].

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

Метод Описание
composeAuthorizationHeader ( array $params, string $realm = '' ) : array Composes authorization header.
composeSignatureBaseString ( string $method, string $url, array $params ) : string Creates signature base string, which will be signed by [[signatureMethod]].
composeSignatureKey ( OAuthToken | null $token = null ) : string Composes request signature key.
defaultReturnUrl ( ) : string Composes default [[returnUrl]] value.
generateCommonRequestParams ( ) : array Generate common request params like version, timestamp etc.
generateNonce ( ) : string Generates nonce value.
generateTimestamp ( ) : integer Generates timestamp.

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

applyAccessTokenToRequest() публичный Метод

public applyAccessTokenToRequest ( $request, $accessToken )

beforeRequestSend() публичный Метод

Ensures every request has been signed up before sending.
С версии: 2.1
public beforeRequestSend ( RequestEvent $event )
$event yii\httpclient\RequestEvent event instance.

buildAuthUrl() публичный Метод

Composes user authorization URL.
public buildAuthUrl ( OAuthToken $requestToken = null, array $params = [] ) : string
$requestToken OAuthToken OAuth request token.
$params array additional request params.
Результат string authorize URL

composeAuthorizationHeader() защищенный Метод

Composes authorization header.
protected composeAuthorizationHeader ( array $params, string $realm = '' ) : array
$params array request params.
$realm string authorization realm.
Результат array authorization header in format: [name => content].

composeSignatureBaseString() защищенный Метод

Creates signature base string, which will be signed by [[signatureMethod]].
protected composeSignatureBaseString ( string $method, string $url, array $params ) : string
$method string request method.
$url string request URL.
$params array request params.
Результат string base signature string.

composeSignatureKey() защищенный Метод

Composes request signature key.
protected composeSignatureKey ( OAuthToken | null $token = null ) : string
$token OAuthToken | null OAuth token to be used for signature key.
Результат string signature key.

createApiRequest() публичный Метод

public createApiRequest ( )

createRequest() публичный Метод

public createRequest ( )

defaultReturnUrl() защищенный Метод

Composes default [[returnUrl]] value.
protected defaultReturnUrl ( ) : string
Результат string return URL.

fetchAccessToken() публичный Метод

Fetches OAuth access token.
public fetchAccessToken ( string $oauthToken = null, OAuthToken $requestToken = null, string $oauthVerifier = null, array $params = [] ) : OAuthToken
$oauthToken string OAuth token returned with redirection back to client.
$requestToken OAuthToken OAuth request token.
$oauthVerifier string OAuth verifier.
$params array additional request params.
Результат OAuthToken OAuth access token.

fetchRequestToken() публичный Метод

Fetches the OAuth request token.
public fetchRequestToken ( array $params = [] ) : OAuthToken
$params array additional request params.
Результат OAuthToken request token.

generateCommonRequestParams() защищенный Метод

Generate common request params like version, timestamp etc.
protected generateCommonRequestParams ( ) : array
Результат array common request params.

generateNonce() защищенный Метод

Generates nonce value.
protected generateNonce ( ) : string
Результат string nonce value.

generateTimestamp() защищенный Метод

Generates timestamp.
protected generateTimestamp ( ) : integer
Результат integer timestamp.

refreshAccessToken() публичный Метод

Gets new auth token to replace expired one.
public refreshAccessToken ( OAuthToken $token ) : OAuthToken
$token OAuthToken expired auth token.
Результат OAuthToken new auth token.

signRequest() публичный Метод

Sign given request with [[signatureMethod]].
С версии: 2.1 this method is public.
public signRequest ( Request $request, OAuthToken | null $token = null )
$request yii\httpclient\Request request instance.
$token OAuthToken | null OAuth token to be used for signature, if not set [[accessToken]] will be used.

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

$accessTokenMethod публичное свойство

access token HTTP method.
public $accessTokenMethod

$accessTokenUrl публичное свойство

OAuth access token URL.
public $accessTokenUrl

$authorizationHeaderMethods публичное свойство

list of the request methods, which require adding 'Authorization' header. By default only POST requests will have 'Authorization' header. You may set this option to null in order to make all requests to use 'Authorization' header.
С версии: 2.1.1
public $authorizationHeaderMethods

$consumerKey публичное свойство

OAuth consumer key.
public $consumerKey

$consumerSecret публичное свойство

OAuth consumer secret.
public $consumerSecret

$requestTokenMethod публичное свойство

request token HTTP method.
public $requestTokenMethod

$requestTokenUrl публичное свойство

OAuth request token URL.
public $requestTokenUrl

$version публичное свойство

protocol version.
public $version