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
파일 보기 프로젝트 열기: yiisoft/yii2-authclient 1 사용 예제들

공개 프로퍼티들

프로퍼티 타입 설명
$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