Docs For Class Zend_Oauth

Zend_Oauth_Config

Description

Implements interfaces:

Zend_Oauth_Config_ConfigInterface

copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: New BSD License

Located in /Oauth/Config.php (line 37)

Variable Summary

string $_accessTokenUrl

string $_authorizeUrl

string $_callbackUrl

string $_consumerKey

string $_consumerSecret

string $_requestMethod

string $_requestScheme

string $_requestTokenUrl

Zend_Crypt_Rsa_Key_Private $_rsaPrivateKey

Zend_Crypt_Rsa_Key_Public $_rsaPublicKey

string $_signatureMethod

string $_siteUrl

Zend_Oauth_Token $_token

string $_version

Method Summary

void __construct ([array|Zend_Config $options = null])

string getAccessTokenUrl ()

string getAuthorizeUrl ()

string getCallbackUrl ()

string getConsumerKey ()

string getConsumerSecret ()

string getRequestMethod ()

string getRequestScheme ()

string getRequestTokenUrl ()

Zend_Crypt_Rsa_Key_Private getRsaPrivateKey ()

Zend_Crypt_Rsa_Key_Public getRsaPublicKey ()

string getSignatureMethod ()

string getSiteUrl ()

Zend_Oauth_Token getToken ()

string getUserAuthorizationUrl ()

string getVersion ()

Zend_Oauth_Config setAccessTokenUrl (string $url)

Zend_Oauth_Config setAuthorizeUrl (string $url)

Zend_Oauth_Config setCallbackUrl (string $url)

Zend_Oauth_Config setConsumerKey (string $key)

Zend_Oauth_Config setConsumerSecret (string $secret)

Zend_Oauth_Config setOptions ( $options)

Zend_Oauth_Config setRequestMethod (string $method)

Zend_Oauth_Config setRequestScheme (string $scheme)

Zend_Oauth_Config setRequestTokenUrl (string $url)

Zend_Oauth_Config setRsaPrivateKey ( $key)

Zend_Oauth_Config setRsaPublicKey ( $key)

Zend_Oauth_Config setSignatureMethod (string $method)

Zend_Oauth_Config setSiteUrl (string $url)

Zend_Oauth_Config setToken (Zend_Oauth_Token $token)

Zend_Oauth_Config setUserAuthorizationUrl (string $url)

Zend_Oauth_Config setVersion (string $version)

Variables

string $_accessTokenUrl = null (line 102)

The URL to which requests for an Access Token should be directed.

When absent, assumed siteUrl+'/access_token'

access: protected

string $_authorizeUrl = null (line 110)

The URL to which users should be redirected to authorize a Request Token.

When absent, assumed siteUrl+'/authorize'

access: protected

string $_callbackUrl = null (line 79)

This optional value is used to define where the user is redirected to after authorizing a Request Token from an OAuth Providers website.

It's optional since a Provider may ask for this to be defined in advance when registering a new application for a Consumer Key.

access: protected

string $_consumerKey = null (line 117)

An OAuth application's Consumer Key.

access: protected

string $_consumerSecret = null (line 124)

Every Consumer Key has a Consumer Secret unless you're in RSA-land.

access: protected

string $_requestMethod = Zend_Oauth::POST (line 62)

Preferred request Method - one of GET or POST - which Zend_Oauth will enforce as standard throughout the library. Generally a default of POST works fine unless a Provider specifically requires otherwise.

access: protected

string $_requestScheme = Zend_Oauth::REQUEST_SCHEME_HEADER (line 53)

Three request schemes are defined by OAuth, of which passing all OAuth parameters by Header is preferred. The other two are POST Body and Query String.

access: protected

string $_requestTokenUrl = null (line 94)

The URL to which requests for a Request Token should be directed.

When absent, assumed siteUrl+'/request_token'

access: protected

Zend_Crypt_Rsa_Key_Private $_rsaPrivateKey = null (line 132)

If relevant, a PEM encoded RSA private key encapsulated as a Zend_Crypt_Rsa Key

access: protected

Zend_Crypt_Rsa_Key_Public $_rsaPublicKey = null (line 140)

If relevant, a PEM encoded RSA public key encapsulated as a Zend_Crypt_Rsa Key

access: protected

string $_signatureMethod = 'HMAC-SHA1' (line 44)

Signature method used when signing all parameters for an HTTP request

access: protected

string $_siteUrl = null (line 86)

The URL root to append default OAuth endpoint paths.

access: protected

Zend_Oauth_Token $_token = null (line 148)

Generally this will nearly always be an Access Token represented as a Zend_Oauth_Token_Access object.

access: protected

string $_version = '1.0' (line 69)

OAuth Version; This defaults to 1.0 - Must not be changed!

access: protected

Methods

Constructor __construct (line 157)

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

access: public

void __construct ([array|Zend_Config $options = null])

array|Zend_Config $options

getAccessTokenUrl (line 494)

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.

access: public

string getAccessTokenUrl ()

Implementation of:

Zend_Oauth_Config_ConfigInterface::getAccessTokenUrl()

getAuthorizeUrl (line 551)

Get authorization URL

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

access: public

string getAuthorizeUrl ()

getCallbackUrl (line 398)

Get callback URL

access: public

string getCallbackUrl ()

Implementation of:

Zend_Oauth_Config_ConfigInterface::getCallbackUrl()

getConsumerKey (line 243)

Get consumer key

access: public

string getConsumerKey ()

Implementation of:

Zend_Oauth_Config_ConfigInterface::getConsumerKey()

getConsumerSecret (line 268)

Get consumer secret

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

access: public

string getConsumerSecret ()

Implementation of:

Zend_Oauth_Config_ConfigInterface::getConsumerSecret()

getRequestMethod (line 588)

Get request method

access: public

string getRequestMethod ()

Implementation of:

Zend_Oauth_Config_ConfigInterface::getRequestMethod()

getRequestScheme (line 347)

Get request scheme

access: public

string getRequestScheme ()

Implementation of:

Zend_Oauth_Config_ConfigInterface::getRequestScheme()

getRequestTokenUrl (line 459)

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.

access: public

string getRequestTokenUrl ()

Implementation of:

Zend_Oauth_Config_ConfigInterface::getRequestTokenUrl()

getRsaPrivateKey (line 632)

Get RSA private key

access: public

Zend_Crypt_Rsa_Key_Private getRsaPrivateKey ()

getRsaPublicKey (line 610)

Get RSA public key

access: public

Zend_Crypt_Rsa_Key_Public getRsaPublicKey ()

getSignatureMethod (line 304)

Get signature method

access: public

string getSignatureMethod ()

Implementation of:

Zend_Oauth_Config_ConfigInterface::getSignatureMethod()

getSiteUrl (line 427)

Get site URL

access: public

string getSiteUrl ()

getToken (line 654)

Get OAuth token

access: public

Zend_Oauth_Token getToken ()

Implementation of:

Zend_Oauth_Config_ConfigInterface::getToken()

getUserAuthorizationUrl (line 538)

Get user authorization URL

access: public

string getUserAuthorizationUrl ()

Implementation of:

Zend_Oauth_Config_ConfigInterface::getUserAuthorizationUrl()

getVersion (line 369)

Get version

access: public

string getVersion ()

Implementation of:

Zend_Oauth_Config_ConfigInterface::getVersion()

setAccessTokenUrl (line 474)

Set access token URL

throws: Zend_Oauth_Exception for invalid URLs
access: public

Zend_Oauth_Config setAccessTokenUrl (string $url)

string $url

Implementation of:

Zend_Oauth_Config_ConfigInterface::setAccessTokenUrl()

setAuthorizeUrl (line 521)

Set authorization URL

throws: Zend_Oauth_Exception for invalid URLs
access: public

Zend_Oauth_Config setAuthorizeUrl (string $url)

string $url

setCallbackUrl (line 381)

Set callback URL

throws: Zend_Oauth_Exception for invalid URLs
access: public

Zend_Oauth_Config setCallbackUrl (string $url)

string $url

Implementation of:

Zend_Oauth_Config_ConfigInterface::setCallbackUrl()

setConsumerKey (line 232)

Set consumer key

access: public

Zend_Oauth_Config setConsumerKey (string $key)

string $key

Implementation of:

Zend_Oauth_Config_ConfigInterface::setConsumerKey()

setConsumerSecret (line 254)

Set consumer secret

access: public

Zend_Oauth_Config setConsumerSecret (string $secret)

string $secret

Implementation of:

Zend_Oauth_Config_ConfigInterface::setConsumerSecret()

setOptions (line 174)

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

access: public

Zend_Oauth_Config setOptions ( $options)

array|Zend_Config $options

Implementation of:

Zend_Oauth_Config_ConfigInterface::setOptions()

setRequestMethod (line 566)

Set request method

throws: Zend_Oauth_Exception for invalid request methods
access: public

Zend_Oauth_Config setRequestMethod (string $method)

string $method

Implementation of:

Zend_Oauth_Config_ConfigInterface::setRequestMethod()

setRequestScheme (line 316)

Set request scheme

throws: Zend_Oauth_Exception if invalid scheme specified, or if POSTBODY set when request method of GET is specified
access: public

Zend_Oauth_Config setRequestScheme (string $scheme)

string $scheme

Implementation of:

Zend_Oauth_Config_ConfigInterface::setRequestScheme()

setRequestTokenUrl (line 439)

Set request token URL

throws: Zend_Oauth_Exception for invalid URLs
access: public

Zend_Oauth_Config setRequestTokenUrl (string $url)

string $url

Implementation of:

Zend_Oauth_Config_ConfigInterface::setRequestTokenUrl()

setRsaPrivateKey (line 621)

Set RSA private key

access: public

Zend_Oauth_Config setRsaPrivateKey ( $key)

Zend_Crypt_Rsa_Key_Private $key

setRsaPublicKey (line 599)

Set RSA public key

access: public

Zend_Oauth_Config setRsaPublicKey ( $key)

Zend_Crypt_Rsa_Key_Public $key

setSignatureMethod (line 283)

Set signature method

throws: Zend_Oauth_Exception if unsupported signature method specified
access: public

Zend_Oauth_Config setSignatureMethod (string $method)

string $method

Implementation of:

Zend_Oauth_Config_ConfigInterface::setSignatureMethod()

setSiteUrl (line 410)

Set site URL

throws: Zend_Oauth_Exception for invalid URLs
access: public

Zend_Oauth_Config setSiteUrl (string $url)

string $url

setToken (line 643)

Set OAuth token

access: public

Zend_Oauth_Config setToken (Zend_Oauth_Token $token)

Zend_Oauth_Token $token

Implementation of:

Zend_Oauth_Config_ConfigInterface::setToken()

setUserAuthorizationUrl (line 509)

Set user authorization URL

throws: Zend_Oauth_Exception for invalid URLs
access: public

Zend_Oauth_Config setUserAuthorizationUrl (string $url)

string $url

Implementation of:

Zend_Oauth_Config_ConfigInterface::setUserAuthorizationUrl()

setVersion (line 358)

Set version

access: public

Zend_Oauth_Config setVersion (string $version)

string $version

Implementation of:

Zend_Oauth_Config_ConfigInterface::setVersion()

Documentation generated on Mon, 21 Jun 2010 15:13:22 -0400 by phpDocumentor 1.4.3