\Zend_Oauth_Config
- Copyright: Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
- License: http://framework.zend.com/license/new-bsd New BSD License
Synopsis
class Zend_Oauth_Config
implements
Zend_Oauth_Config_ConfigInterface
{
- // members
- protected string $_signatureMethod = 'HMAC-SHA1';
- protected string $_requestScheme = Zend_Oauth::REQUEST_SCHEME_HEADER;
- protected string $_requestMethod = Zend_Oauth::POST;
- protected string $_version = '1.0';
- protected $_callbackUrl = NULL;
- protected $_siteUrl = NULL;
- protected $_requestTokenUrl = NULL;
- protected $_accessTokenUrl = NULL;
- protected $_authorizeUrl = NULL;
- protected $_consumerKey = NULL;
- protected $_consumerSecret = NULL;
- protected Zend_Crypt_Rsa_Key_Private $_rsaPrivateKey = NULL;
- protected Zend_Crypt_Rsa_Key_Public $_rsaPublicKey = NULL;
- protected Zend_Oauth_Token $_token = NULL;
- protected $_realm = NULL;
- // methods
- public void __construct()
- public Zend_Oauth_Config setOptions()
- public Zend_Oauth_Config setConsumerKey()
- public string getConsumerKey()
- public Zend_Oauth_Config setConsumerSecret()
- public string getConsumerSecret()
- public Zend_Oauth_Config setSignatureMethod()
- public string getSignatureMethod()
- public Zend_Oauth_Config setRequestScheme()
- public string getRequestScheme()
- public Zend_Oauth_Config setVersion()
- public string getVersion()
- public Zend_Oauth_Config setCallbackUrl()
- public string getCallbackUrl()
- public Zend_Oauth_Config setSiteUrl()
- public string getSiteUrl()
- public Zend_Oauth_Config setRequestTokenUrl()
- public string getRequestTokenUrl()
- public Zend_Oauth_Config setAccessTokenUrl()
- public string getAccessTokenUrl()
- public Zend_Oauth_Config setUserAuthorizationUrl()
- public Zend_Oauth_Config setAuthorizeUrl()
- public string getUserAuthorizationUrl()
- public string getAuthorizeUrl()
- public Zend_Oauth_Config setRequestMethod()
- public string getRequestMethod()
- public Zend_Oauth_Config setRsaPublicKey()
- public Zend_Crypt_Rsa_Key_Public getRsaPublicKey()
- public Zend_Oauth_Config setRsaPrivateKey()
- public Zend_Crypt_Rsa_Key_Private getRsaPrivateKey()
- public Zend_Oauth_Config setToken()
- public Zend_Oauth_Token getToken()
- public Zend_Oauth_Config setRealm()
- public string getRealm()
Hierarchy
Implements
Members
protected
- $_accessTokenUrl
—
string
The URL to which requests for an Access Token should be directed. - $_callbackUrl
—
string
This optional value is used to define where the user is redirected to after authorizing a Request Token from an OAuth Providers website. - $_consumerKey
—
string
An OAuth application's Consumer Key. - $_consumerSecret
—
string
Every Consumer Key has a Consumer Secret unless you're in RSA-land. - $_realm
—
string
Define the OAuth realm - $_requestMethod
—
string
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. - $_requestScheme
—
string
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. - $_requestTokenUrl
—
string
The URL to which requests for a Request Token should be directed. - $_rsaPrivateKey
—
Zend_Crypt_Rsa_Key_Private
If relevant, a PEM encoded RSA private key encapsulated as a Zend_Crypt_Rsa Key - $_rsaPublicKey
—
Zend_Crypt_Rsa_Key_Public
If relevant, a PEM encoded RSA public key encapsulated as a Zend_Crypt_Rsa Key - $_signatureMethod
—
string
Signature method used when signing all parameters for an HTTP request - $_siteUrl
—
string
The URL root to append default OAuth endpoint paths. - $_token
—
Zend_Oauth_Token
Generally this will nearly always be an Access Token represented as a Zend_Oauth_Token_Access object. - $_version
—
string
OAuth Version; This defaults to 1.0 - Must not be changed!
Methods
public
- __construct() — Constructor; create a new object with an optional array|Zend_Config instance containing initialising options.
- getAccessTokenUrl() — Get access token URL
- getAuthorizeUrl() — Get authorization URL
- getCallbackUrl() — Get callback URL
- getConsumerKey() — Get consumer key
- getConsumerSecret() — Get consumer secret
- getRealm() — Get OAuth realm
- getRequestMethod() — Get request method
- getRequestScheme() — Get request scheme
- getRequestTokenUrl() — Get request token URL
- getRsaPrivateKey() — Get RSA private key
- getRsaPublicKey() — Get RSA public key
- getSignatureMethod() — Get signature method
- getSiteUrl() — Get site URL
- getToken() — Get OAuth token
- getUserAuthorizationUrl() — Get user authorization URL
- getVersion() — Get version
- setAccessTokenUrl() — Set access token URL
- setAuthorizeUrl() — Set authorization URL
- setCallbackUrl() — Set callback URL
- setConsumerKey() — Set consumer key
- setConsumerSecret() — Set consumer secret
- setOptions() — Parse option array or Zend_Config instance and setup options using their relevant mutators.
- setRealm() — Set OAuth realm
- setRequestMethod() — Set request method
- setRequestScheme() — Set request scheme
- setRequestTokenUrl() — Set request token URL
- setRsaPrivateKey() — Set RSA private key
- setRsaPublicKey() — Set RSA public key
- setSignatureMethod() — Set signature method
- setSiteUrl() — Set site URL
- setToken() — Set OAuth token
- setUserAuthorizationUrl() — Set user authorization URL
- setVersion() — Set version