Zend_Oauth_Config Class Reference

Inheritance diagram for Zend_Oauth_Config:

Public Member Functions
	__construct ($options=null)
	setOptions (array $options)
	setConsumerKey ($key)
	getConsumerKey ()
	setConsumerSecret ($secret)
	getConsumerSecret ()
	setSignatureMethod ($method)
	getSignatureMethod ()
	setRequestScheme ($scheme)
	getRequestScheme ()
	setVersion ($version)
	getVersion ()
	setCallbackUrl ($url)
	getCallbackUrl ()
	setSiteUrl ($url)
	getSiteUrl ()
	setRequestTokenUrl ($url)
	getRequestTokenUrl ()
	setAccessTokenUrl ($url)
	getAccessTokenUrl ()
	setUserAuthorizationUrl ($url)
	setAuthorizeUrl ($url)
	getUserAuthorizationUrl ()
	getAuthorizeUrl ()
	setRequestMethod ($method)
	getRequestMethod ()
	setRsaPublicKey (Zend_Crypt_Rsa_Key_Public $key)
	getRsaPublicKey ()
	setRsaPrivateKey (Zend_Crypt_Rsa_Key_Private $key)
	getRsaPrivateKey ()
	setToken (Zend_Oauth_Token $token)
	getToken ()
	setRealm ($realm)
	getRealm ()

Protected Attributes
	$_signatureMethod = 'HMAC-SHA1'
	$_requestScheme = Zend_Oauth::REQUEST_SCHEME_HEADER
	$_requestMethod = Zend_Oauth::POST
	$_version = '1.0'
	$_callbackUrl = null
	$_siteUrl = null
	$_requestTokenUrl = null
	$_accessTokenUrl = null
	$_authorizeUrl = null
	$_consumerKey = null
	$_consumerSecret = null
	$_rsaPrivateKey = null
	$_rsaPublicKey = null
	$_token = null
	$_realm = null

Detailed Description

Definition at line 37 of file Config.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$options = null

)

Constructor; create a new object with an optional array|Zend_Config instance containing initialising options.

Parameters

array | Zend_Config

$options

Returns

void

Definition at line 164 of file Config.php.

    {
        if ($options !== null) {
            if ($options instanceof Zend_Config) {
                $options = $options->toArray();
            }
            $this->setOptions($options);
        }
    }

Member Function Documentation

getAccessTokenUrl()

getAccessTokenUrl

(

)

Get access token URL

If no access token URL has been set, but a site URL has, returns the site URL with the string "/access_token" appended.

Returns

string

Implements Zend_Oauth_Config_ConfigInterface.

Definition at line 504 of file Config.php.

    {
        if (!$this->_accessTokenUrl && $this->_siteUrl) {
            return $this->_siteUrl . '/access_token';
        }
        return $this->_accessTokenUrl;
    }

getAuthorizeUrl()

getAuthorizeUrl

(

)

Get authorization URL

If no authorization URL has been set, but a site URL has, returns the site URL with the string "/authorize" appended.

Returns

string

Definition at line 561 of file Config.php.

    {
        if (!$this->_authorizeUrl && $this->_siteUrl) {
            return $this->_siteUrl . '/authorize';
        }
        return $this->_authorizeUrl;
    }

getCallbackUrl()

getCallbackUrl

(

)

Get callback URL

Returns

string

Implements Zend_Oauth_Config_ConfigInterface.

Definition at line 408 of file Config.php.

    {
        return $this->_callbackUrl;
    }

getConsumerKey()

getConsumerKey

(

)

Get consumer key

Returns

string

Implements Zend_Oauth_Config_ConfigInterface.

Definition at line 253 of file Config.php.

    {
        return $this->_consumerKey;
    }

getConsumerSecret()

getConsumerSecret

(

)

Get consumer secret

Returns RSA private key if set; otherwise, returns any previously set consumer secret.

Returns

string

Implements Zend_Oauth_Config_ConfigInterface.

Definition at line 278 of file Config.php.

    {
        if ($this->_rsaPrivateKey !== null) {
            return $this->_rsaPrivateKey;
        }
        return $this->_consumerSecret;
    }

getRealm()

getRealm

(

)

Get OAuth realm

Returns

string

Implements Zend_Oauth_Config_ConfigInterface.

Definition at line 687 of file Config.php.

    {
        return $this->_realm;
    }

getRequestMethod()

getRequestMethod

(

)

Get request method

Returns

string

Implements Zend_Oauth_Config_ConfigInterface.

Definition at line 599 of file Config.php.

    {
        return $this->_requestMethod;
    }

getRequestScheme()

getRequestScheme

(

)

Get request scheme

Returns

string

Implements Zend_Oauth_Config_ConfigInterface.

Definition at line 357 of file Config.php.

    {
        return $this->_requestScheme;
    }

getRequestTokenUrl()

getRequestTokenUrl

(

)

Get request token URL

If no request token URL has been set, but a site URL has, returns the site URL with the string "/request_token" appended.

Returns

string

Implements Zend_Oauth_Config_ConfigInterface.

Definition at line 469 of file Config.php.

    {
        if (!$this->_requestTokenUrl && $this->_siteUrl) {
            return $this->_siteUrl . '/request_token';
        }
        return $this->_requestTokenUrl;
    }

getRsaPrivateKey()

getRsaPrivateKey

(

)

Get RSA private key

Returns

Zend_Crypt_Rsa_Key_Private

Definition at line 643 of file Config.php.

    {
        return $this->_rsaPrivateKey;
    }

getRsaPublicKey()

getRsaPublicKey

(

)

Get RSA public key

Returns

Zend_Crypt_Rsa_Key_Public

Definition at line 621 of file Config.php.

    {
        return $this->_rsaPublicKey;
    }

getSignatureMethod()

getSignatureMethod

(

)

Get signature method

Returns

string

Implements Zend_Oauth_Config_ConfigInterface.

Definition at line 314 of file Config.php.

    {
        return $this->_signatureMethod;
    }

getSiteUrl()

getSiteUrl

(

)

Get site URL

Returns

string

Definition at line 437 of file Config.php.

    {
        return $this->_siteUrl;
    }

getToken()

getToken

(

)

Get OAuth token

Returns

Zend_Oauth_Token

Implements Zend_Oauth_Config_ConfigInterface.

Definition at line 665 of file Config.php.

    {
        return $this->_token;
    }

getUserAuthorizationUrl()

getUserAuthorizationUrl

(

)

Get user authorization URL

Returns

string

Implements Zend_Oauth_Config_ConfigInterface.

Definition at line 548 of file Config.php.

    {
        return $this->getAuthorizeUrl();
    }

getVersion()

getVersion

(

)

Get version

Returns

string

Implements Zend_Oauth_Config_ConfigInterface.

Definition at line 379 of file Config.php.

    {
        return $this->_version;
    }

setAccessTokenUrl()

setAccessTokenUrl

(

$url

)

Set access token URL

Parameters

string

$url

Returns

Zend_Oauth_Config

Exceptions

Zend_Oauth_Exception

for invalid URLs

Implements Zend_Oauth_Config_ConfigInterface.

Definition at line 484 of file Config.php.

    {
        if (!Zend_Uri::check($url)) {
            #require_once 'Zend/Oauth/Exception.php';
            throw new Zend_Oauth_Exception(
                '\'' . $url . '\' is not a valid URI'
            );
        }
        $this->_accessTokenUrl = rtrim($url, '/');
        return $this;
    }

setAuthorizeUrl()

setAuthorizeUrl

(

$url

)

Set authorization URL

Parameters

string

$url

Returns

Zend_Oauth_Config

Exceptions

Zend_Oauth_Exception

for invalid URLs

Definition at line 531 of file Config.php.

    {
        if (!Zend_Uri::check($url)) {
            #require_once 'Zend/Oauth/Exception.php';
            throw new Zend_Oauth_Exception(
                '\'' . $url . '\' is not a valid URI'
            );
        }
        $this->_authorizeUrl = rtrim($url, '/');
        return $this;
    }

setCallbackUrl()

setCallbackUrl

(

$url

)

Set callback URL

Parameters

string

$url

Returns

Zend_Oauth_Config

Exceptions

Zend_Oauth_Exception

for invalid URLs

Implements Zend_Oauth_Config_ConfigInterface.

Definition at line 391 of file Config.php.

    {
        if (!Zend_Uri::check($url) && $url !== 'oob') {
            #require_once 'Zend/Oauth/Exception.php';
            throw new Zend_Oauth_Exception(
                '\'' . $url . '\' is not a valid URI'
            );
        }
        $this->_callbackUrl = $url;
        return $this;
    }

setConsumerKey()

setConsumerKey

(

$key

)

Set consumer key

Parameters

string

$key

Returns

Zend_Oauth_Config

Implements Zend_Oauth_Config_ConfigInterface.

Definition at line 242 of file Config.php.

    {
        $this->_consumerKey = $key;
        return $this;
    }

setConsumerSecret()

setConsumerSecret

(

$secret

)

Set consumer secret

Parameters

string

$secret

Returns

Zend_Oauth_Config

Implements Zend_Oauth_Config_ConfigInterface.

Definition at line 264 of file Config.php.

    {
        $this->_consumerSecret = $secret;
        return $this;
    }

setOptions()

setOptions

(

array

$options

)

Parse option array or Zend_Config instance and setup options using their relevant mutators.

Parameters

array | Zend_Config

$options

Returns

Zend_Oauth_Config

Implements Zend_Oauth_Config_ConfigInterface.

Definition at line 181 of file Config.php.

    {
        foreach ($options as $key => $value) {
            switch ($key) {
                case 'consumerKey':
                    $this->setConsumerKey($value);
                    break;
                case 'consumerSecret':
                    $this->setConsumerSecret($value);
                    break;
                case 'signatureMethod':
                    $this->setSignatureMethod($value);
                    break;
                case 'version':
                    $this->setVersion($value);
                    break;
                case 'callbackUrl':
                    $this->setCallbackUrl($value);
                    break;
                case 'siteUrl':
                    $this->setSiteUrl($value);
                    break;
                case 'requestTokenUrl':
                    $this->setRequestTokenUrl($value);
                    break;
                case 'accessTokenUrl':
                    $this->setAccessTokenUrl($value);
                    break;
                case 'userAuthorizationUrl':
                    $this->setUserAuthorizationUrl($value);
                    break;
                case 'authorizeUrl':
                    $this->setAuthorizeUrl($value);
                    break;
                case 'requestMethod':
                    $this->setRequestMethod($value);
                    break;
                case 'rsaPrivateKey':
                    $this->setRsaPrivateKey($value);
                    break;
                case 'rsaPublicKey':
                    $this->setRsaPublicKey($value);
                    break;
                case 'realm':
                    $this->setRealm($value);
                    break;
            }
        }
        if (isset($options['requestScheme'])) {
            $this->setRequestScheme($options['requestScheme']);
        }

        return $this;
    }

setRealm()

setRealm

(

$realm

)

Set OAuth realm

Parameters

string

$realm

Returns

Zend_Oauth_Config

Implements Zend_Oauth_Config_ConfigInterface.

Definition at line 676 of file Config.php.

    {
        $this->_realm = $realm;
        return $this;
    }

setRequestMethod()

setRequestMethod

(

$method

)

Set request method

Parameters

string

$method

Returns

Zend_Oauth_Config

Exceptions

Zend_Oauth_Exception

for invalid request methods

Implements Zend_Oauth_Config_ConfigInterface.

Definition at line 576 of file Config.php.

    {
        $method = strtoupper($method);
        if (!in_array($method, array(
                Zend_Oauth::GET,
                Zend_Oauth::POST,
                Zend_Oauth::PUT,
                Zend_Oauth::DELETE,
                Zend_Oauth::OPTIONS,
            ))
        ) {
            #require_once 'Zend/Oauth/Exception.php';
            throw new Zend_Oauth_Exception('Invalid method: ' . $method);
        }
        $this->_requestMethod = $method;
        return $this;
    }

setRequestScheme()

setRequestScheme

(

$scheme

)

Set request scheme

Parameters

string

$scheme

Returns

Zend_Oauth_Config

Exceptions

Zend_Oauth_Exception

if invalid scheme specified, or if POSTBODY set when request method of GET is specified

Implements Zend_Oauth_Config_ConfigInterface.

Definition at line 326 of file Config.php.

    {
        $scheme = strtolower($scheme);
        if (!in_array($scheme, array(
                Zend_Oauth::REQUEST_SCHEME_HEADER,
                Zend_Oauth::REQUEST_SCHEME_POSTBODY,
                Zend_Oauth::REQUEST_SCHEME_QUERYSTRING,
            ))
        ) {
            #require_once 'Zend/Oauth/Exception.php';
            throw new Zend_Oauth_Exception(
                '\'' . $scheme . '\' is an unsupported request scheme'
            );
        }
        if ($scheme == Zend_Oauth::REQUEST_SCHEME_POSTBODY
            && $this->getRequestMethod() == Zend_Oauth::GET
        ) {
            #require_once 'Zend/Oauth/Exception.php';
            throw new Zend_Oauth_Exception(
                'Cannot set POSTBODY request method if HTTP method set to GET'
            );
        }
        $this->_requestScheme = $scheme;
        return $this;
    }

setRequestTokenUrl()

setRequestTokenUrl

(

$url

)

Set request token URL

Parameters

string

$url

Returns

Zend_Oauth_Config

Exceptions

Zend_Oauth_Exception

for invalid URLs

Implements Zend_Oauth_Config_ConfigInterface.

Definition at line 449 of file Config.php.

    {
        if (!Zend_Uri::check($url)) {
            #require_once 'Zend/Oauth/Exception.php';
            throw new Zend_Oauth_Exception(
                '\'' . $url . '\' is not a valid URI'
            );
        }
        $this->_requestTokenUrl = rtrim($url, '/');
        return $this;
    }

setRsaPrivateKey()

setRsaPrivateKey

(

Zend_Crypt_Rsa_Key_Private

$key

)

Set RSA private key

Parameters

Zend_Crypt_Rsa_Key_Private

$key

Returns

Zend_Oauth_Config

Definition at line 632 of file Config.php.

    {
        $this->_rsaPrivateKey = $key;
        return $this;
    }

setRsaPublicKey()

setRsaPublicKey

(

Zend_Crypt_Rsa_Key_Public

$key

)

Set RSA public key

Parameters

Zend_Crypt_Rsa_Key_Public

$key

Returns

Zend_Oauth_Config

Definition at line 610 of file Config.php.

    {
        $this->_rsaPublicKey = $key;
        return $this;
    }

setSignatureMethod()

setSignatureMethod

(

$method

)

Set signature method

Parameters

string

$method

Returns

Zend_Oauth_Config

Exceptions

Zend_Oauth_Exception

if unsupported signature method specified

Implements Zend_Oauth_Config_ConfigInterface.

Definition at line 293 of file Config.php.

    {
        $method = strtoupper($method);
        if (!in_array($method, array(
                'HMAC-SHA1', 'HMAC-SHA256', 'RSA-SHA1', 'PLAINTEXT'
            ))
        ) {
            #require_once 'Zend/Oauth/Exception.php';
            throw new Zend_Oauth_Exception('Unsupported signature method: '
                . $method
                . '. Supported are HMAC-SHA1, RSA-SHA1, PLAINTEXT and HMAC-SHA256');
        }
        $this->_signatureMethod = $method;;
        return $this;
    }

setSiteUrl()

setSiteUrl

(

$url

)

Set site URL

Parameters

string

$url

Returns

Zend_Oauth_Config

Exceptions

Zend_Oauth_Exception

for invalid URLs

Definition at line 420 of file Config.php.

    {
        if (!Zend_Uri::check($url)) {
            #require_once 'Zend/Oauth/Exception.php';
            throw new Zend_Oauth_Exception(
                '\'' . $url . '\' is not a valid URI'
            );
        }
        $this->_siteUrl = $url;
        return $this;
    }

setToken()

setToken

(

Zend_Oauth_Token

$token

)

Set OAuth token

Parameters

Zend_Oauth_Token

$token

Returns

Zend_Oauth_Config

Implements Zend_Oauth_Config_ConfigInterface.

Definition at line 654 of file Config.php.

    {
        $this->_token = $token;
        return $this;
    }

setUserAuthorizationUrl()

setUserAuthorizationUrl

(

$url

)

Set user authorization URL

Parameters

string

$url

Returns

Zend_Oauth_Config

Exceptions

Zend_Oauth_Exception

for invalid URLs

Implements Zend_Oauth_Config_ConfigInterface.

Definition at line 519 of file Config.php.

    {
        return $this->setAuthorizeUrl($url);
    }

setVersion()

setVersion

(

$version

)

Set version

Parameters

string

$version

Returns

Zend_Oauth_Config

Implements Zend_Oauth_Config_ConfigInterface.

Definition at line 368 of file Config.php.

    {
        $this->_version = $version;
        return $this;
    }

Field Documentation

$_accessTokenUrl

$_accessTokenUrl = null

protected

Definition at line 102 of file Config.php.

$_authorizeUrl

$_authorizeUrl = null

protected

Definition at line 110 of file Config.php.

$_callbackUrl

$_callbackUrl = null

protected

Definition at line 79 of file Config.php.

$_consumerKey

$_consumerKey = null

protected

Definition at line 117 of file Config.php.

$_consumerSecret

$_consumerSecret = null

protected

Definition at line 124 of file Config.php.

$_realm

$_realm = null

protected

Definition at line 155 of file Config.php.

$_requestMethod

$_requestMethod = Zend_Oauth::POST

protected

Definition at line 62 of file Config.php.

$_requestScheme

$_requestScheme = Zend_Oauth::REQUEST_SCHEME_HEADER

protected

Definition at line 53 of file Config.php.

$_requestTokenUrl

$_requestTokenUrl = null

protected

Definition at line 94 of file Config.php.

$_rsaPrivateKey

$_rsaPrivateKey = null

protected

Definition at line 132 of file Config.php.

$_rsaPublicKey

$_rsaPublicKey = null

protected

Definition at line 140 of file Config.php.

$_signatureMethod

$_signatureMethod = 'HMAC-SHA1'

protected

Definition at line 44 of file Config.php.

$_siteUrl

$_siteUrl = null

protected

Definition at line 86 of file Config.php.

$_token

$_token = null

protected

Definition at line 148 of file Config.php.

$_version

$_version = '1.0'

protected

Definition at line 69 of file Config.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/zendframework1/library/Zend/Oauth/Config.php