Abstract Class yii\authclient\OAuth1

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

See also https://oauth.net/1/ https://tools.ietf.org/html/rfc5849.

Public Properties

Public Methods

Protected Methods

Property Details

$accessTokenMethod public property

Access token HTTP method.

public string $accessTokenMethod = 'GET'

$accessTokenUrl public property

OAuth access token URL.

public string $accessTokenUrl = null

$authorizationHeaderMethods public property (available since version 2.1.1)

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.

public array|null $authorizationHeaderMethods = ['POST']

$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