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.

string
$_accessTokenUrl= 'null'
The URL to which requests for an Access Token should be directed.
When absent, assumed siteUrl+'/access_token'
null
Details
string
$_authorizeUrl= 'null'
The URL to which users should be redirected to authorize a Request Token.
When absent, assumed siteUrl+'/authorize'
null
Details
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.
null
Details
string
$_consumerKey= 'null'
An OAuth application's Consumer Key.
null
Details
string
$_consumerSecret= 'null'
Every Consumer Key has a Consumer Secret unless you're in RSA-land.
null
Details
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.
Zend_Oauth::POST
Details
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.
Zend_Oauth::REQUEST_SCHEME_HEADER
Details
string
$_requestTokenUrl= 'null'
The URL to which requests for a Request Token should be directed.
When absent, assumed siteUrl+'/request_token'
null
Details
\Zend_Crypt_Rsa_Key_Private
$_rsaPrivateKey= 'null'
If relevant, a PEM encoded RSA private key encapsulated as a Zend_Crypt_Rsa Key

\Zend_Crypt_Rsa_Key_Public
$_rsaPublicKey= 'null'
If relevant, a PEM encoded RSA public key encapsulated as a Zend_Crypt_Rsa Key

string
$_signatureMethod= ''HMAC-SHA1''
Signature method used when signing all parameters for an HTTP request
'HMAC-SHA1'
Details
string
$_siteUrl= 'null'
The URL root to append default OAuth endpoint paths.
null
Details
\Zend_Oauth_Token
$_token= 'null'
Generally this will nearly always be an Access Token represented as a Zend_Oauth_Token_Access object.

__construct(
array|\Zend_Config $options
=
null
)
:
void
Constructor; create a new object with an optional array|Zend_Config instance containing initialising options.
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.
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.
Type | Description |
---|---|
string |

getConsumerSecret(
)
:
string
Get consumer secret
Returns RSA private key if set; otherwise, returns any previously set consumer secret.
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.
Type | Description |
---|---|
string |

getRsaPrivateKey(
)
:
\Zend_Crypt_Rsa_Key_Private
Get RSA private key
Type | Description |
---|---|
\Zend_Crypt_Rsa_Key_Private |

getRsaPublicKey(
)
:
\Zend_Crypt_Rsa_Key_Public
Get RSA public key
Type | Description |
---|---|
\Zend_Crypt_Rsa_Key_Public |

setAccessTokenUrl(
string $url
)
:
\Zend_Oauth_Config
Set access token URL
Name | Type | Description |
---|---|---|
$url | string |
Type | Description |
---|---|
\Zend_Oauth_Config |
Exception | Description |
---|---|
\Zend_Oauth_Exception | for invalid URLs |

setAuthorizeUrl(
string $url
)
:
\Zend_Oauth_Config
Set authorization URL
Name | Type | Description |
---|---|---|
$url | string |
Type | Description |
---|---|
\Zend_Oauth_Config |
Exception | Description |
---|---|
\Zend_Oauth_Exception | for invalid URLs |

setCallbackUrl(
string $url
)
:
\Zend_Oauth_Config
Set callback URL
Name | Type | Description |
---|---|---|
$url | string |
Type | Description |
---|---|
\Zend_Oauth_Config |
Exception | Description |
---|---|
\Zend_Oauth_Exception | for invalid URLs |

setOptions(
array|\Zend_Config $options
)
:
\Zend_Oauth_Config
Parse option array or Zend_Config instance and setup options using their relevant mutators.
Name | Type | Description |
---|---|---|
$options | array|\Zend_Config |
Type | Description |
---|---|
\Zend_Oauth_Config |

setRequestMethod(
string $method
)
:
\Zend_Oauth_Config
Set request method
Name | Type | Description |
---|---|---|
$method | string |
Type | Description |
---|---|
\Zend_Oauth_Config |
Exception | Description |
---|---|
\Zend_Oauth_Exception | for invalid request methods |

setRequestScheme(
string $scheme
)
:
\Zend_Oauth_Config
Set request scheme
Name | Type | Description |
---|---|---|
$scheme | string |
Type | Description |
---|---|
\Zend_Oauth_Config |
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
Name | Type | Description |
---|---|---|
$url | string |
Type | Description |
---|---|
\Zend_Oauth_Config |
Exception | Description |
---|---|
\Zend_Oauth_Exception | for invalid URLs |

setRsaPrivateKey(
\Zend_Crypt_Rsa_Key_Private $key
)
:
\Zend_Oauth_Config
Set RSA private key
Name | Type | Description |
---|---|---|
$key | \Zend_Crypt_Rsa_Key_Private |
Type | Description |
---|---|
\Zend_Oauth_Config |

setRsaPublicKey(
\Zend_Crypt_Rsa_Key_Public $key
)
:
\Zend_Oauth_Config
Set RSA public key
Name | Type | Description |
---|---|---|
$key | \Zend_Crypt_Rsa_Key_Public |
Type | Description |
---|---|
\Zend_Oauth_Config |

setSignatureMethod(
string $method
)
:
\Zend_Oauth_Config
Set signature method
Name | Type | Description |
---|---|---|
$method | string |
Type | Description |
---|---|
\Zend_Oauth_Config |
Exception | Description |
---|---|
\Zend_Oauth_Exception | if unsupported signature method specified |

setSiteUrl(
string $url
)
:
\Zend_Oauth_Config
Set site URL
Name | Type | Description |
---|---|---|
$url | string |
Type | Description |
---|---|
\Zend_Oauth_Config |
Exception | Description |
---|---|
\Zend_Oauth_Exception | for invalid URLs |

setToken(
\Zend_Oauth_Token $token
)
:
\Zend_Oauth_Config
Set OAuth token
Name | Type | Description |
---|---|---|
$token | \Zend_Oauth_Token |
Type | Description |
---|---|
\Zend_Oauth_Config |

setUserAuthorizationUrl(
string $url
)
:
\Zend_Oauth_Config
Set user authorization URL
Name | Type | Description |
---|---|---|
$url | string |
Type | Description |
---|---|
\Zend_Oauth_Config |
Exception | Description |
---|---|
\Zend_Oauth_Exception | for invalid URLs |