Class yii\authclient\OAuth1

All Classes | Properties | Methods | Constants

Inheritance	yii\authclient\OAuth1 » yii\authclient\BaseOAuth » yii\authclient\BaseClient » yii\base\Component
Implements	yii\authclient\ClientInterface
Subclasses	yii\authclient\clients\Twitter
Available since version	2.0

OAuth1 serves as a client for the OAuth 1/1.0a flow.

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

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$accessTokenMethod	string	Access token HTTP method.	yii\authclient\OAuth1
$accessTokenUrl	string	OAuth access token URL.	yii\authclient\OAuth1
$apiBaseUrl	string	API base URL.	yii\authclient\BaseOAuth
$authUrl	string	Authorize URL.	yii\authclient\BaseOAuth
$autoRefreshAccessToken	boolean	Whether to automatically perform 'refresh access token' request on expired access token.	yii\authclient\BaseOAuth
$consumerKey	string	OAuth consumer key.	yii\authclient\OAuth1
$consumerSecret	string	OAuth consumer secret.	yii\authclient\OAuth1
$requestTokenMethod	string	Request token HTTP method.	yii\authclient\OAuth1
$requestTokenUrl	string	OAuth request token URL.	yii\authclient\OAuth1
$scope	string	Auth request scope.	yii\authclient\BaseOAuth
$version	string	Protocol version.	yii\authclient\OAuth1

Public Methods

Hide inherited methods

Method	Description	Defined By
api()	Performs request to the OAuth API.	yii\authclient\BaseOAuth
buildAuthUrl()	Composes user authorization URL.	yii\authclient\OAuth1
fetchAccessToken()	Fetches OAuth access token.	yii\authclient\OAuth1
fetchRequestToken()	Fetches the OAuth request token.	yii\authclient\OAuth1
getAccessToken()		yii\authclient\BaseOAuth
getCurlOptions()		yii\authclient\BaseOAuth
getId()		yii\authclient\ClientInterface
getName()		yii\authclient\ClientInterface
getNormalizeUserAttributeMap()		yii\authclient\BaseClient
getReturnUrl()		yii\authclient\BaseOAuth
getSignatureMethod()		yii\authclient\BaseOAuth
getTitle()		yii\authclient\ClientInterface
getUserAttributes()		yii\authclient\ClientInterface
getViewOptions()		yii\authclient\ClientInterface
refreshAccessToken()	Gets new auth token to replace expired one.	yii\authclient\OAuth1
setAccessToken()		yii\authclient\BaseOAuth
setCurlOptions()		yii\authclient\BaseOAuth
setId()		yii\authclient\ClientInterface
setName()		yii\authclient\ClientInterface
setNormalizeUserAttributeMap()		yii\authclient\BaseClient
setReturnUrl()		yii\authclient\BaseOAuth
setSignatureMethod()		yii\authclient\BaseOAuth
setTitle()		yii\authclient\ClientInterface
setUserAttributes()		yii\authclient\BaseClient
setViewOptions()		yii\authclient\BaseClient

Protected Methods

Hide inherited methods

Method	Description	Defined By
apiInternal()	Performs request to the OAuth API.	yii\authclient\OAuth1
composeAuthorizationHeader()	Composes authorization header content.	yii\authclient\OAuth1
composeRequestCurlOptions()	Composes HTTP request CUrl options, which will be merged with the default ones.	yii\authclient\OAuth1
composeSignatureBaseString()	Creates signature base string, which will be signed by \yii\authclient\signatureMethod.	yii\authclient\OAuth1
composeSignatureKey()	Composes request signature key.	yii\authclient\OAuth1
composeUrl()	Composes URL from base URL and GET params.	yii\authclient\BaseOAuth
convertXmlToArray()	Converts XML document to array.	yii\authclient\BaseOAuth
createSignatureMethod()	Creates signature method instance from its configuration.	yii\authclient\BaseOAuth
createToken()	Creates token from its configuration.	yii\authclient\BaseOAuth
defaultCurlOptions()	Returns default cURL options.	yii\authclient\BaseOAuth
defaultName()	Generates service name.	yii\authclient\BaseClient
defaultNormalizeUserAttributeMap()	Returns the default \yii\authclient\normalizeUserAttributeMap value.	yii\authclient\BaseClient
defaultReturnUrl()	Composes default \yii\authclient\returnUrl value.	yii\authclient\OAuth1
defaultTitle()	Generates service title.	yii\authclient\BaseClient
defaultViewOptions()	Returns the default \yii\authclient\viewOptions value.	yii\authclient\BaseClient
determineContentTypeByHeaders()	Attempts to determine HTTP request content type by headers.	yii\authclient\BaseOAuth
determineContentTypeByRaw()	Attempts to determine the content type from raw content.	yii\authclient\BaseOAuth
generateCommonRequestParams()	Generate common request params like version, timestamp etc.	yii\authclient\OAuth1
generateNonce()	Generates nonce value.	yii\authclient\OAuth1
generateTimestamp()	Generates timestamp.	yii\authclient\OAuth1
getState()	Returns persistent state value.	yii\authclient\BaseOAuth
getStateKeyPrefix()	Returns session key prefix, which is used to store internal states.	yii\authclient\BaseOAuth
initUserAttributes()	Initializes authenticated user attributes.	yii\authclient\BaseClient
mergeCurlOptions()	Merge CUrl options.	yii\authclient\BaseOAuth
normalizeUserAttributes()	Normalize given user attributes according to \yii\authclient\normalizeUserAttributeMap.	yii\authclient\BaseClient
processResponse()	Processes raw response converting it to actual data.	yii\authclient\BaseOAuth
removeState()	Removes persistent state value.	yii\authclient\BaseOAuth
restoreAccessToken()	Restores access token.	yii\authclient\BaseOAuth
saveAccessToken()	Saves token as persistent state.	yii\authclient\BaseOAuth
sendRequest()	Sends HTTP request.	yii\authclient\BaseOAuth
sendSignedRequest()	Sends HTTP request, signed by \yii\authclient\signatureMethod.	yii\authclient\OAuth1
setState()	Sets persistent state.	yii\authclient\BaseOAuth
signRequest()	Sign request with \yii\authclient\signatureMethod.	yii\authclient\OAuth1

Constants

Hide inherited constants

Constant	Value	Defined By
CONTENT_TYPE_AUTO	'auto'	yii\authclient\BaseOAuth
CONTENT_TYPE_JSON	'json'	yii\authclient\BaseOAuth
CONTENT_TYPE_URLENCODED	'urlencoded'	yii\authclient\BaseOAuth
CONTENT_TYPE_XML	'xml'	yii\authclient\BaseOAuth

Property Details

$accessTokenMethod public property

Access token HTTP method.

public string $accessTokenMethod = 'GET'

$accessTokenUrl public property

OAuth access token URL.

public string $accessTokenUrl = null

$consumerKey public property

OAuth consumer key.

public string $consumerKey = null

$consumerSecret public property

OAuth consumer secret.

public string $consumerSecret = null

$requestTokenMethod public property

Request token HTTP method.

public string $requestTokenMethod = 'GET'

$requestTokenUrl public property

OAuth request token URL.

public string $requestTokenUrl = null

$version public property

Protocol version.

public string $version = '1.0'

Method Details

apiInternal() protected method

Performs request to the OAuth API.

protected array apiInternal ( $accessToken, $url, $method, array $params, array $headers )
$accessToken	yii\authclient\OAuthToken	Actual access token.
$url	string	Absolute API URL.
$method	string	Request method.
$params	array	Request parameters.
$headers	array	Additional request headers.
return	array	API response.
throws	\yii\base\Exception	on failure.

buildAuthUrl() public method

Composes user authorization URL.

public string buildAuthUrl ( yii\authclient\OAuthToken $requestToken = null, array $params = [] )
$requestToken	yii\authclient\OAuthToken	OAuth request token.
$params	array	Additional request params.
return	string	Authorize URL
throws	\yii\base\Exception	on failure.

composeAuthorizationHeader() protected method

Composes authorization header content.

protected string composeAuthorizationHeader ( array $params, $realm = '' )
$params	array	Request params.
$realm	string	Authorization realm.
return	string	Authorization header content.

composeRequestCurlOptions() protected method

Composes HTTP request CUrl options, which will be merged with the default ones.

protected array composeRequestCurlOptions ( $method, $url, array $params )
$method	string	Request type.
$url	string	Request URL.
$params	array	Request params.
return	array	CUrl options.
throws	\yii\base\Exception	on failure.

composeSignatureBaseString() protected method

Creates signature base string, which will be signed by \yii\authclient\signatureMethod.

protected string composeSignatureBaseString ( $method, $url, array $params )
$method	string	Request method.
$url	string	Request URL.
$params	array	Request params.
return	string	Base signature string.

composeSignatureKey() protected method

Composes request signature key.

protected string composeSignatureKey ( )
return	string	Signature key.

defaultReturnUrl() protected method

Composes default \yii\authclient\returnUrl value.

protected string defaultReturnUrl ( )
return	string	Return URL.

fetchAccessToken() public method

Fetches OAuth access token.

public yii\authclient\OAuthToken fetchAccessToken ( yii\authclient\OAuthToken $requestToken = null, $oauthVerifier = null, array $params = [] )
$requestToken	yii\authclient\OAuthToken	OAuth request token.
$oauthVerifier	string	OAuth verifier.
$params	array	Additional request params.
return	yii\authclient\OAuthToken	OAuth access token.
throws	\yii\base\Exception	on failure.

fetchRequestToken() public method

Fetches the OAuth request token.

public yii\authclient\OAuthToken fetchRequestToken ( array $params = [] )
$params	array	Additional request params.
return	yii\authclient\OAuthToken	Request token.

generateCommonRequestParams() protected method

Generate common request params like version, timestamp etc.

protected array generateCommonRequestParams ( )
return	array	Common request params.

generateNonce() protected method

Generates nonce value.

protected string generateNonce ( )
return	string	Nonce value.

generateTimestamp() protected method

Generates timestamp.

protected integer generateTimestamp ( )
return	integer	Timestamp.

refreshAccessToken() public method

Gets new auth token to replace expired one.

public yii\authclient\OAuthToken refreshAccessToken ( yii\authclient\OAuthToken $token )
$token	yii\authclient\OAuthToken	Expired auth token.
return	yii\authclient\OAuthToken	New auth token.

sendSignedRequest() protected method

Sends HTTP request, signed by \yii\authclient\signatureMethod.

protected array sendSignedRequest ( $method, $url, array $params = [], array $headers = [] )
$method	string	Request type.
$url	string	Request URL.
$params	array	Request params.
$headers	array	Additional request headers.
return	array	Response.

signRequest() protected method

Sign request with \yii\authclient\signatureMethod.

protected array signRequest ( $method, $url, array $params )
$method	string	Request method.
$url	string	Request URL.
$params	array	Request params.
return	array	Signed request params.