Oauth/Config.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Oauth
version: $Id: Config.php 20232 2010-01-12 17:56:33Z matthew $
Classes: Zend_Oauth_Config

Description

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Zend_Oauth_Config
jump to top

Implements: Zend_Oauth_Config_ConfigInterface
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Oauth
Properties: $_signatureMethod; $_requestScheme; $_requestMethod; $_version; $_callbackUrl; $_siteUrl; $_requestTokenUrl; $_accessTokenUrl; $_authorizeUrl; $_consumerKey; $_consumerSecret; $_rsaPrivateKey; $_rsaPublicKey; $_token
Methods: __construct; setOptions; setConsumerKey; getConsumerKey; setConsumerSecret; getConsumerSecret; setSignatureMethod; getSignatureMethod; setRequestScheme; getRequestScheme; setVersion; getVersion; setCallbackUrl; getCallbackUrl; setSiteUrl; getSiteUrl; setRequestTokenUrl; getRequestTokenUrl; setAccessTokenUrl; getAccessTokenUrl; setUserAuthorizationUrl; setAuthorizeUrl; getUserAuthorizationUrl; getAuthorizeUrl; setRequestMethod; getRequestMethod; setRsaPublicKey; getRsaPublicKey; setRsaPrivateKey; getRsaPrivateKey; setToken; getToken

Description

Properties

$_accessTokenUrl
jump to class

string $_accessTokenUrl = 'null'

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

When absent, assumed siteUrl+'/access_token'

Details

$_accessTokenUrl: string
visibility: protected
default: null
final: false
static: false

$_authorizeUrl
jump to class

string $_authorizeUrl = 'null'

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

When absent, assumed siteUrl+'/authorize'

Details

$_authorizeUrl: string
visibility: protected
default: null
final: false
static: false

$_callbackUrl
jump to class

string $_callbackUrl = 'null'

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.

Details

$_callbackUrl: string
visibility: protected
default: null
final: false
static: false

$_consumerKey
jump to class

string $_consumerKey = 'null'

An OAuth application's Consumer Key.

Details

$_consumerKey: string
visibility: protected
default: null
final: false
static: false

$_consumerSecret
jump to class

string $_consumerSecret = 'null'

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

Details

$_consumerSecret: string
visibility: protected
default: null
final: false
static: false

$_requestMethod
jump to class

string $_requestMethod = 'Zend_Oauth'

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.

Details

$_requestMethod: string
visibility: protected
default: Zend_Oauth
final: false
static: false

$_requestScheme
jump to class

string $_requestScheme = 'Zend_Oauth'

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.

Details

$_requestScheme: string
visibility: protected
default: Zend_Oauth
final: false
static: false

$_requestTokenUrl
jump to class

string $_requestTokenUrl = 'null'

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

When absent, assumed siteUrl+'/request_token'

Details

$_requestTokenUrl: string
visibility: protected
default: null
final: false
static: false

$_rsaPrivateKey
jump to class

Zend_Crypt_Rsa_Key_Private $_rsaPrivateKey = 'null'

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

Details

$_rsaPrivateKey: Zend_Crypt_Rsa_Key_Private
visibility: protected
default: null
final: false
static: false

$_rsaPublicKey
jump to class

Zend_Crypt_Rsa_Key_Public $_rsaPublicKey = 'null'

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

Details

$_rsaPublicKey: Zend_Crypt_Rsa_Key_Public
visibility: protected
default: null
final: false
static: false

$_signatureMethod
jump to class

string $_signatureMethod = 'HMAC-SHA1'

Signature method used when signing all parameters for an HTTP request

Details

$_signatureMethod: string
visibility: protected
default: HMAC-SHA1
final: false
static: false

$_siteUrl
jump to class

string $_siteUrl = 'null'

The URL root to append default OAuth endpoint paths.

Details

$_siteUrl: string
visibility: protected
default: null
final: false
static: false

$_token
jump to class

Zend_Oauth_Token $_token = 'null'

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

Details

$_token: Zend_Oauth_Token
visibility: protected
default: null
final: false
static: false

$_version
jump to class

string $_version = '1.0'

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

Details

$_version: string
visibility: protected
default: 1.0
final: false
static: false

Methods

__construct
jump to class

__construct(
          array|Zend_Config $options
              =
              null
          )
        
        :
        void

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

Arguments

$options: arrayZend_Config

Details

visibility: public
final: false
static: false

getAccessTokenUrl
jump to class

getAccessTokenUrl(
          
          )
        
        :
        string

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.

Output

string

Details

visibility: public
final: false
static: false

getAuthorizeUrl
jump to class

getAuthorizeUrl(
          
          )
        
        :
        string

Get authorization URL

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

Output

string

Details

visibility: public
final: false
static: false

getCallbackUrl
jump to class

getCallbackUrl(
          
          )
        
        :
        string

Get callback URL

Output

string

Details

visibility: public
final: false
static: false

getConsumerKey
jump to class

getConsumerKey(
          
          )
        
        :
        string

Get consumer key

Output

string

Details

visibility: public
final: false
static: false

getConsumerSecret
jump to class

getConsumerSecret(
          
          )
        
        :
        string

Get consumer secret

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

Output

string

Details

visibility: public
final: false
static: false

getRequestMethod
jump to class

getRequestMethod(
          
          )
        
        :
        string

Get request method

Output

string

Details

visibility: public
final: false
static: false

getRequestScheme
jump to class

getRequestScheme(
          
          )
        
        :
        string

Get request scheme

Output

string

Details

visibility: public
final: false
static: false

getRequestTokenUrl
jump to class

getRequestTokenUrl(
          
          )
        
        :
        string

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.

Output

string

Details

visibility: public
final: false
static: false

getRsaPrivateKey
jump to class

getRsaPrivateKey(
          
          )
        
        :
        Zend_Crypt_Rsa_Key_Private

Get RSA private key

Output

Zend_Crypt_Rsa_Key_Private

Details

visibility: public
final: false
static: false

getRsaPublicKey
jump to class

getRsaPublicKey(
          
          )
        
        :
        Zend_Crypt_Rsa_Key_Public

Get RSA public key

Output

Zend_Crypt_Rsa_Key_Public

Details

visibility: public
final: false
static: false

getSignatureMethod
jump to class

getSignatureMethod(
          
          )
        
        :
        string

Get signature method

Output

string

Details

visibility: public
final: false
static: false

getSiteUrl
jump to class

getSiteUrl(
          
          )
        
        :
        string

Get site URL

Output

string

Details

visibility: public
final: false
static: false

getToken
jump to class

getToken(
          
          )
        
        :
        Zend_Oauth_Token

Get OAuth token

Output

Zend_Oauth_Token

Details

visibility: public
final: false
static: false

getUserAuthorizationUrl
jump to class

getUserAuthorizationUrl(
          
          )
        
        :
        string

Get user authorization URL

Output

string

Details

visibility: public
final: false
static: false

getVersion
jump to class

getVersion(
          
          )
        
        :
        string

Get version

Output

string

Details

visibility: public
final: false
static: false

setAccessTokenUrl
jump to class

setAccessTokenUrl(
          string $url
          )
        
        :
        Zend_Oauth_Config

Set access token URL

Arguments

$url: string

Output

Zend_Oauth_Config

Details

visibility: public
final: false
static: false
throws: for invalid URLs

setAuthorizeUrl
jump to class

setAuthorizeUrl(
          string $url
          )
        
        :
        Zend_Oauth_Config

Set authorization URL

Arguments

$url: string

Output

Zend_Oauth_Config

Details

visibility: public
final: false
static: false
throws: for invalid URLs

setCallbackUrl
jump to class

setCallbackUrl(
          string $url
          )
        
        :
        Zend_Oauth_Config

Set callback URL

Arguments

$url: string

Output

Zend_Oauth_Config

Details

visibility: public
final: false
static: false
throws: for invalid URLs

setConsumerKey
jump to class

setConsumerKey(
          string $key
          )
        
        :
        Zend_Oauth_Config

Set consumer key

Arguments

$key: string

Output

Zend_Oauth_Config

Details

visibility: public
final: false
static: false

setConsumerSecret
jump to class

setConsumerSecret(
          string $secret
          )
        
        :
        Zend_Oauth_Config

Set consumer secret

Arguments

$secret: string

Output

Zend_Oauth_Config

Details

visibility: public
final: false
static: false

setOptions
jump to class

setOptions(
          array|Zend_Config $options
          )
        
        :
        Zend_Oauth_Config

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

Arguments

$options: arrayZend_Config

Output

Zend_Oauth_Config

Details

visibility: public
final: false
static: false

setRequestMethod
jump to class

setRequestMethod(
          string $method
          )
        
        :
        Zend_Oauth_Config

Set request method

Arguments

$method: string

Output

Zend_Oauth_Config

Details

visibility: public
final: false
static: false
throws: for invalid request methods

setRequestScheme
jump to class

setRequestScheme(
          string $scheme
          )
        
        :
        Zend_Oauth_Config

Set request scheme

Arguments

$scheme: string

Output

Zend_Oauth_Config

Details

visibility: public
final: false
static: false
throws: if invalid scheme specified, or if POSTBODY set when request method of GET is specified

setRequestTokenUrl
jump to class

setRequestTokenUrl(
          string $url
          )
        
        :
        Zend_Oauth_Config

Set request token URL

Arguments

$url: string

Output

Zend_Oauth_Config

Details

visibility: public
final: false
static: false
throws: for invalid URLs

setRsaPrivateKey
jump to class

setRsaPrivateKey(
          Zend_Crypt_Rsa_Key_Private $key
          )
        
        :
        Zend_Oauth_Config

Set RSA private key

Arguments

$key: Zend_Crypt_Rsa_Key_Private

Output

Zend_Oauth_Config

Details

visibility: public
final: false
static: false

setRsaPublicKey
jump to class

setRsaPublicKey(
          Zend_Crypt_Rsa_Key_Public $key
          )
        
        :
        Zend_Oauth_Config

Set RSA public key

Arguments

$key: Zend_Crypt_Rsa_Key_Public

Output

Zend_Oauth_Config

Details

visibility: public
final: false
static: false

setSignatureMethod
jump to class

setSignatureMethod(
          string $method
          )
        
        :
        Zend_Oauth_Config

Set signature method

Arguments

$method: string

Output

Zend_Oauth_Config

Details

visibility: public
final: false
static: false
throws: if unsupported signature method specified

setSiteUrl
jump to class

setSiteUrl(
          string $url
          )
        
        :
        Zend_Oauth_Config

Set site URL

Arguments

$url: string

Output

Zend_Oauth_Config

Details

visibility: public
final: false
static: false
throws: for invalid URLs

setToken
jump to class

setToken(
          Zend_Oauth_Token $token
          )
        
        :
        Zend_Oauth_Config

Set OAuth token

Arguments

$token: Zend_Oauth_Token

Output

Zend_Oauth_Config

Details

visibility: public
final: false
static: false

setUserAuthorizationUrl
jump to class

setUserAuthorizationUrl(
          string $url
          )
        
        :
        Zend_Oauth_Config

Set user authorization URL

Arguments

$url: string

Output

Zend_Oauth_Config

Details

visibility: public
final: false
static: false
throws: for invalid URLs

setVersion
jump to class

setVersion(
          string $version
          )
        
        :
        Zend_Oauth_Config

Set version

Arguments

$version: string

Output

Zend_Oauth_Config

Details

visibility: public
final: false
static: false

API Documentation

Oauth/Config.php

Description

Zend_Oauth_Configjump to top

Description

Properties

$_accessTokenUrljump to class

Details

$_authorizeUrljump to class

Details

$_callbackUrljump to class

Details

$_consumerKeyjump to class

Details

$_consumerSecretjump to class

Details

$_requestMethodjump to class

Details

$_requestSchemejump to class

Details

$_requestTokenUrljump to class

Details

$_rsaPrivateKeyjump to class

Details

$_rsaPublicKeyjump to class

Details

$_signatureMethodjump to class

Details

$_siteUrljump to class

Details

$_tokenjump to class

Details

$_versionjump to class

Details

Methods

__constructjump to class

Arguments

Details

getAccessTokenUrljump to class

Output

Details

getAuthorizeUrljump to class

Output

Details

getCallbackUrljump to class

Output

Details

getConsumerKeyjump to class

Output

Details

getConsumerSecretjump to class

Output

Details

getRequestMethodjump to class

Output

Details

getRequestSchemejump to class

Output

Details

getRequestTokenUrljump to class

Output

Details

getRsaPrivateKeyjump to class

Output

Details

getRsaPublicKeyjump to class

Output

Details

getSignatureMethodjump to class

Output

Details

getSiteUrljump to class

Output

Details

getTokenjump to class

Output

Details

getUserAuthorizationUrljump to class

Output

Details

Zend_Oauth_Config
jump to top

$_accessTokenUrl
jump to class

$_authorizeUrl
jump to class

$_callbackUrl
jump to class

$_consumerKey
jump to class

$_consumerSecret
jump to class

$_requestMethod
jump to class

$_requestScheme
jump to class

$_requestTokenUrl
jump to class

$_rsaPrivateKey
jump to class

$_rsaPublicKey
jump to class

$_signatureMethod
jump to class

$_siteUrl
jump to class

$_token
jump to class

$_version
jump to class

__construct
jump to class

getAccessTokenUrl
jump to class

getAuthorizeUrl
jump to class

getCallbackUrl
jump to class

getConsumerKey
jump to class

getConsumerSecret
jump to class

getRequestMethod
jump to class

getRequestScheme
jump to class

getRequestTokenUrl
jump to class

getRsaPrivateKey
jump to class

getRsaPublicKey
jump to class

getSignatureMethod
jump to class

getSiteUrl
jump to class

getToken
jump to class

getUserAuthorizationUrl
jump to class

getVersion
jump to class

setAccessTokenUrl
jump to class

setAuthorizeUrl
jump to class

setCallbackUrl
jump to class

setConsumerKey
jump to class

setConsumerSecret
jump to class

setOptions
jump to class

setRequestMethod
jump to class

setRequestScheme
jump to class

setRequestTokenUrl
jump to class

setRsaPrivateKey
jump to class

setRsaPublicKey
jump to class

setSignatureMethod
jump to class

setSiteUrl
jump to class

setToken
jump to class

setUserAuthorizationUrl
jump to class

setVersion
jump to class