PHP Class 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 ~~~

Méthodes publiques

Свойство	Type	Description
$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.

Méthodes publiques

Méthode	Description
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]].

Méthodes protégées

Méthode	Description
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.

Method Details

applyAccessTokenToRequest() public méthode

public applyAccessTokenToRequest ( $request, $accessToken )

beforeRequestSend() public méthode

Ensures every request has been signed up before sending.

Since: 2.1

public beforeRequestSend ( RequestEvent $event )
$event	yii\httpclient\RequestEvent	event instance.

buildAuthUrl() public méthode

Composes user authorization URL.

public buildAuthUrl ( OAuthToken $requestToken = null, array $params = [] ) : string
$requestToken	OAuthToken	OAuth request token.
$params	array	additional request params.
Résultat	string	authorize URL

composeAuthorizationHeader() protected méthode

Composes authorization header.

protected composeAuthorizationHeader ( array $params, string $realm = '' ) : array
$params	array	request params.
$realm	string	authorization realm.
Résultat	array	authorization header in format: [name => content].

composeSignatureBaseString() protected méthode

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.
Résultat	string	base signature string.

composeSignatureKey() protected méthode

Composes request signature key.

protected composeSignatureKey ( OAuthToken \| null $token = null ) : string
$token	OAuthToken \| null	OAuth token to be used for signature key.
Résultat	string	signature key.

createApiRequest() public méthode

public createApiRequest ( )

createRequest() public méthode

public createRequest ( )

defaultReturnUrl() protected méthode

Composes default [[returnUrl]] value.

protected defaultReturnUrl ( ) : string
Résultat	string	return URL.

fetchAccessToken() public méthode

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.
Résultat	OAuthToken	OAuth access token.

fetchRequestToken() public méthode

Fetches the OAuth request token.

public fetchRequestToken ( array $params = [] ) : OAuthToken
$params	array	additional request params.
Résultat	OAuthToken	request token.

generateCommonRequestParams() protected méthode

Generate common request params like version, timestamp etc.

protected generateCommonRequestParams ( ) : array
Résultat	array	common request params.

generateNonce() protected méthode

Generates nonce value.

protected generateNonce ( ) : string
Résultat	string	nonce value.

generateTimestamp() protected méthode

Generates timestamp.

protected generateTimestamp ( ) : integer
Résultat	integer	timestamp.

refreshAccessToken() public méthode

Gets new auth token to replace expired one.

public refreshAccessToken ( OAuthToken $token ) : OAuthToken
$token	OAuthToken	expired auth token.
Résultat	OAuthToken	new auth token.

signRequest() public méthode

Sign given request with [[signatureMethod]].

Since: 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.

Property Details

$accessTokenMethod public_oe property

access token HTTP method.

public $accessTokenMethod

$accessTokenUrl public_oe property

OAuth access token URL.

public $accessTokenUrl

$authorizationHeaderMethods public_oe property

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.

Since: 2.1.1

public $authorizationHeaderMethods

$consumerKey public_oe property

OAuth consumer key.

public $consumerKey

$consumerSecret public_oe property

OAuth consumer secret.

public $consumerSecret

$requestTokenMethod public_oe property

request token HTTP method.

public $requestTokenMethod

$requestTokenUrl public_oe property

OAuth request token URL.

public $requestTokenUrl

$version public_oe property

protocol version.

public $version