Oauth/Config.php

Show:

inherited

Classes
- \Zend_Oauth_Config

Table of Contents

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.

Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Oauth
Version: $Id$

\Zend_Oauth_Config
jump to top

Package: Zend_Oauth

Implements
Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

string $_accessTokenUrl = null

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

When absent, assumed siteUrl+'/access_token'

Default valuenullDetails

Type: string

string $_authorizeUrl = null

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

When absent, assumed siteUrl+'/authorize'

Default valuenullDetails

Type: string

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.

Default valuenullDetails

Type: string

string $_consumerKey = null

An OAuth application's Consumer Key.

Default valuenullDetails

Type: string

string $_consumerSecret = null

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

Default valuenullDetails

Type: string

string $_realm = null

Define the OAuth realm

Default valuenullDetails

Type: string

string $_requestMethod = \Zend_Oauth::POST

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.

Default value\Zend_Oauth::POSTDetails

Type: string

string $_requestScheme = \Zend_Oauth::REQUEST_SCHEME_HEADER

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.

Default value\Zend_Oauth::REQUEST_SCHEME_HEADERDetails

Type: string

string $_requestTokenUrl = null

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

When absent, assumed siteUrl+'/request_token'

Default valuenullDetails

Type: string

\Zend_Crypt_Rsa_Key_Private $_rsaPrivateKey = null

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

Default valuenullDetails

Type: \Zend_Crypt_Rsa_Key_Private

\Zend_Crypt_Rsa_Key_Public $_rsaPublicKey = null

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

Default valuenullDetails

Type: \Zend_Crypt_Rsa_Key_Public

string $_signatureMethod = 'HMAC-SHA1'

Signature method used when signing all parameters for an HTTP request

Default value'HMAC-SHA1'Details

Type: string

string $_siteUrl = null

The URL root to append default OAuth endpoint paths.

Default valuenullDetails

Type: string

\Zend_Oauth_Token $_token = null

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

Default valuenullDetails

Type: \Zend_Oauth_Token

string $_version = '1.0'

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

Default value'1.0'Details

Type: string

Methods

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

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

Parameters

Name	Type	Description
$options	array \| \Zend_Config

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.

Returns

Type	Description
string

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.

Returns

Type	Description
string

getCallbackUrl() : string

Get callback URL

Returns

Type	Description
string

getConsumerKey() : string

Get consumer key

Returns

Type	Description
string

getConsumerSecret() : string

Get consumer secret

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

Returns

Type	Description
string

getRealm() : string

Get OAuth realm

Returns

Type	Description
string

getRequestMethod() : string

Get request method

Returns

Type	Description
string

getRequestScheme() : string

Get request scheme

Returns

Type	Description
string

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.

Returns

Type	Description
string

getRsaPrivateKey() : \Zend_Crypt_Rsa_Key_Private

Get RSA private key

Returns

Type	Description
\Zend_Crypt_Rsa_Key_Private

getRsaPublicKey() : \Zend_Crypt_Rsa_Key_Public

Get RSA public key

Returns

Type	Description
\Zend_Crypt_Rsa_Key_Public

getSignatureMethod() : string

Get signature method

Returns

Type	Description
string

getSiteUrl() : string

Get site URL

Returns

Type	Description
string

getToken() : \Zend_Oauth_Token

Get OAuth token

Returns

Type	Description
\Zend_Oauth_Token

getUserAuthorizationUrl() : string

Get user authorization URL

Returns

Type	Description
string

getVersion() : string

Get version

Returns

Type	Description
string

setAccessTokenUrl(string $url) : \Zend_Oauth_Config

Set access token URL

Parameters

Name	Type	Description
$url	string

Returns

Type	Description
\Zend_Oauth_Config

Throws

Exception	Description
\Zend_Oauth_Exception	for invalid URLs

setAuthorizeUrl(string $url) : \Zend_Oauth_Config

Set authorization URL

Parameters

Name	Type	Description
$url	string

Returns

Type	Description
\Zend_Oauth_Config

Throws

Exception	Description
\Zend_Oauth_Exception	for invalid URLs

setCallbackUrl(string $url) : \Zend_Oauth_Config

Set callback URL

Parameters

Name	Type	Description
$url	string

Returns

Type	Description
\Zend_Oauth_Config

Throws

Exception	Description
\Zend_Oauth_Exception	for invalid URLs

setConsumerKey(string $key) : \Zend_Oauth_Config

Set consumer key

Parameters

Name	Type	Description
$key	string

Returns

Type	Description
\Zend_Oauth_Config

setConsumerSecret(string $secret) : \Zend_Oauth_Config

Set consumer secret

Parameters

Name	Type	Description
$secret	string

Returns

Type	Description
\Zend_Oauth_Config

setOptions(array | \Zend_Config $options) : \Zend_Oauth_Config

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

Parameters

Name	Type	Description
$options	array \| \Zend_Config

Returns

Type	Description
\Zend_Oauth_Config

setRealm(string $realm) : \Zend_Oauth_Config

Set OAuth realm

Parameters

Name	Type	Description
$realm	string

Returns

Type	Description
\Zend_Oauth_Config

setRequestMethod(string $method) : \Zend_Oauth_Config

Set request method

Parameters

Name	Type	Description
$method	string

Returns

Type	Description
\Zend_Oauth_Config

Throws

Exception	Description
\Zend_Oauth_Exception	for invalid request methods

setRequestScheme(string $scheme) : \Zend_Oauth_Config

Set request scheme

Parameters

Name	Type	Description
$scheme	string

Returns

Type	Description
\Zend_Oauth_Config

Throws

Exception	Description
\Zend_Oauth_Exception	if invalid scheme specified, or if POSTBODY set when request method of GET is specified

setRequestTokenUrl(string $url) : \Zend_Oauth_Config

Set request token URL

Parameters

Name	Type	Description
$url	string

Returns

Type	Description
\Zend_Oauth_Config

Throws

Exception	Description
\Zend_Oauth_Exception	for invalid URLs

setRsaPrivateKey(\Zend_Crypt_Rsa_Key_Private $key) : \Zend_Oauth_Config

Set RSA private key

Parameters

Name	Type	Description
$key	\Zend_Crypt_Rsa_Key_Private

Returns

Type	Description
\Zend_Oauth_Config

setRsaPublicKey(\Zend_Crypt_Rsa_Key_Public $key) : \Zend_Oauth_Config

Set RSA public key

Parameters

Name	Type	Description
$key	\Zend_Crypt_Rsa_Key_Public

Returns

Type	Description
\Zend_Oauth_Config

setSignatureMethod(string $method) : \Zend_Oauth_Config

Set signature method

Parameters

Name	Type	Description
$method	string

Returns

Type	Description
\Zend_Oauth_Config

Throws

Exception	Description
\Zend_Oauth_Exception	if unsupported signature method specified

setSiteUrl(string $url) : \Zend_Oauth_Config

Set site URL

Parameters

Name	Type	Description
$url	string

Returns

Type	Description
\Zend_Oauth_Config

Throws

Exception	Description
\Zend_Oauth_Exception	for invalid URLs

setToken(\Zend_Oauth_Token $token) : \Zend_Oauth_Config

Set OAuth token

Parameters

Name	Type	Description
$token	\Zend_Oauth_Token

Returns

Type	Description
\Zend_Oauth_Config

setUserAuthorizationUrl(string $url) : \Zend_Oauth_Config

Set user authorization URL

Parameters

Name	Type	Description
$url	string

Returns

Type	Description
\Zend_Oauth_Config

Throws

Exception	Description
\Zend_Oauth_Exception	for invalid URLs

setVersion(string $version) : \Zend_Oauth_Config

Set version

Parameters

Name	Type	Description
$version	string

Returns

Type	Description
\Zend_Oauth_Config

Oauth/Config.php

\Zend_Oauth_Configjump to top

Properties

Methods

\Zend_Oauth_Config
jump to top