| category |
Zend |
| package |
Zend_Oauth |
| copyright |
Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com) |
| license |
New BSD License |
Methods
Constructor; create a new object with an optional array|Zend_Config
instance containing initialising options.
__construct(array|\Zend_Config $options = null) : void
Parameters
$options
array\Zend_Config
Get access token URL
getAccessTokenUrl() : string
If no access token URL has been set, but a site URL has, returns the
site URL with the string "/access_token" appended.
| inherited_from |
\Zend_Oauth_Config_ConfigInterface::getAccessTokenUrl() |
Returns
string
Get authorization URL
getAuthorizeUrl() : string
If no authorization URL has been set, but a site URL has, returns the
site URL with the string "/authorize" appended.
Returns
string
Get callback URL
getCallbackUrl() : string
| inherited_from |
\Zend_Oauth_Config_ConfigInterface::getCallbackUrl() |
Returns
string
Get consumer key
getConsumerKey() : string
| inherited_from |
\Zend_Oauth_Config_ConfigInterface::getConsumerKey() |
Returns
string
Get consumer secret
getConsumerSecret() : string
Returns RSA private key if set; otherwise, returns any previously set
consumer secret.
| inherited_from |
\Zend_Oauth_Config_ConfigInterface::getConsumerSecret() |
Returns
string
Get OAuth realm
getRealm() : string
| inherited_from |
\Zend_Oauth_Config_ConfigInterface::getRealm() |
Returns
string
Get request method
getRequestMethod() : string
| inherited_from |
\Zend_Oauth_Config_ConfigInterface::getRequestMethod() |
Returns
string
Get request scheme
getRequestScheme() : string
| inherited_from |
\Zend_Oauth_Config_ConfigInterface::getRequestScheme() |
Returns
string
Get request token URL
getRequestTokenUrl() : string
If no request token URL has been set, but a site URL has, returns the
site URL with the string "/request_token" appended.
| inherited_from |
\Zend_Oauth_Config_ConfigInterface::getRequestTokenUrl() |
Returns
string
Get RSA private key
getRsaPrivateKey() : \Zend_Crypt_Rsa_Key_Private
Returns
\Zend_Crypt_Rsa_Key_Private
Get RSA public key
getRsaPublicKey() : \Zend_Crypt_Rsa_Key_Public
Returns
\Zend_Crypt_Rsa_Key_Public
Get signature method
getSignatureMethod() : string
| inherited_from |
\Zend_Oauth_Config_ConfigInterface::getSignatureMethod() |
Returns
string
Get site URL
getSiteUrl() : string
Get OAuth token
getToken() : \Zend_Oauth_Token
| inherited_from |
\Zend_Oauth_Config_ConfigInterface::getToken() |
Returns
\Zend_Oauth_Token
Get user authorization URL
getUserAuthorizationUrl() : string
| inherited_from |
\Zend_Oauth_Config_ConfigInterface::getUserAuthorizationUrl() |
Returns
string
Get version
getVersion() : string
| inherited_from |
\Zend_Oauth_Config_ConfigInterface::getVersion() |
Returns
string
Set access token URL
setAccessTokenUrl(string $url) : \Zend_Oauth_Config
| inherited_from |
\Zend_Oauth_Config_ConfigInterface::setAccessTokenUrl() |
Parameters
$url
string
Exceptions
\Zend_Oauth_Exception |
for invalid URLs |
Returns
\Zend_Oauth_Config
Set authorization URL
setAuthorizeUrl(string $url) : \Zend_Oauth_Config
Parameters
$url
string
Exceptions
\Zend_Oauth_Exception |
for invalid URLs |
Returns
\Zend_Oauth_Config
Set callback URL
setCallbackUrl(string $url) : \Zend_Oauth_Config
| inherited_from |
\Zend_Oauth_Config_ConfigInterface::setCallbackUrl() |
Parameters
$url
string
Exceptions
\Zend_Oauth_Exception |
for invalid URLs |
Returns
\Zend_Oauth_Config
Set consumer key
setConsumerKey(string $key) : \Zend_Oauth_Config
| inherited_from |
\Zend_Oauth_Config_ConfigInterface::setConsumerKey() |
Parameters
$key
string
Returns
\Zend_Oauth_Config
Set consumer secret
setConsumerSecret(string $secret) : \Zend_Oauth_Config
| inherited_from |
\Zend_Oauth_Config_ConfigInterface::setConsumerSecret() |
Parameters
$secret
string
Returns
\Zend_Oauth_Config
Parse option array or Zend_Config instance and setup options using their
relevant mutators.
setOptions(array|\Zend_Config $options) : \Zend_Oauth_Config
| inherited_from |
\Zend_Oauth_Config_ConfigInterface::setOptions() |
Parameters
$options
array\Zend_Config
Returns
\Zend_Oauth_Config
Set OAuth realm
setRealm(string $realm) : \Zend_Oauth_Config
| inherited_from |
\Zend_Oauth_Config_ConfigInterface::setRealm() |
Parameters
$realm
string
Returns
\Zend_Oauth_Config
Set request method
setRequestMethod(string $method) : \Zend_Oauth_Config
| inherited_from |
\Zend_Oauth_Config_ConfigInterface::setRequestMethod() |
Parameters
$method
string
Exceptions
\Zend_Oauth_Exception |
for invalid request methods |
Returns
\Zend_Oauth_Config
Set request scheme
setRequestScheme(string $scheme) : \Zend_Oauth_Config
| inherited_from |
\Zend_Oauth_Config_ConfigInterface::setRequestScheme() |
Parameters
$scheme
string
Exceptions
\Zend_Oauth_Exception |
if invalid scheme specified, or if POSTBODY set when request method of GET is specified |
Returns
\Zend_Oauth_Config
Set request token URL
setRequestTokenUrl(string $url) : \Zend_Oauth_Config
| inherited_from |
\Zend_Oauth_Config_ConfigInterface::setRequestTokenUrl() |
Parameters
$url
string
Exceptions
\Zend_Oauth_Exception |
for invalid URLs |
Returns
\Zend_Oauth_Config
Set RSA private key
setRsaPrivateKey(\Zend_Crypt_Rsa_Key_Private $key) : \Zend_Oauth_Config
Parameters
$key
\Zend_Crypt_Rsa_Key_Private
Returns
\Zend_Oauth_Config
Set RSA public key
setRsaPublicKey(\Zend_Crypt_Rsa_Key_Public $key) : \Zend_Oauth_Config
Parameters
$key
\Zend_Crypt_Rsa_Key_Public
Returns
\Zend_Oauth_Config
Set signature method
setSignatureMethod(string $method) : \Zend_Oauth_Config
| inherited_from |
\Zend_Oauth_Config_ConfigInterface::setSignatureMethod() |
Parameters
$method
string
Exceptions
\Zend_Oauth_Exception |
if unsupported signature method specified |
Returns
\Zend_Oauth_Config
Set site URL
setSiteUrl(string $url) : \Zend_Oauth_Config
Parameters
$url
string
Exceptions
\Zend_Oauth_Exception |
for invalid URLs |
Returns
\Zend_Oauth_Config
Set OAuth token
setToken(\Zend_Oauth_Token $token) : \Zend_Oauth_Config
| inherited_from |
\Zend_Oauth_Config_ConfigInterface::setToken() |
Parameters
$token
\Zend_Oauth_Token
Returns
\Zend_Oauth_Config
Set user authorization URL
setUserAuthorizationUrl(string $url) : \Zend_Oauth_Config
| inherited_from |
\Zend_Oauth_Config_ConfigInterface::setUserAuthorizationUrl() |
Parameters
$url
string
Exceptions
\Zend_Oauth_Exception |
for invalid URLs |
Returns
\Zend_Oauth_Config
Set version
setVersion(string $version) : \Zend_Oauth_Config
| inherited_from |
\Zend_Oauth_Config_ConfigInterface::setVersion() |
Parameters
$version
string
Returns
\Zend_Oauth_Config
Properties
The URL to which requests for an Access Token should be directed.
$_accessTokenUrl : string
When absent, assumed siteUrl+'/access_token'
The URL to which users should be redirected to authorize a Request Token.
$_authorizeUrl : string
When absent, assumed siteUrl+'/authorize'
This optional value is used to define where the user is redirected to
after authorizing a Request Token from an OAuth Providers website.
$_callbackUrl : string
It's optional since a Provider may ask for this to be defined in advance
when registering a new application for a Consumer Key.
An OAuth application's Consumer Key.
$_consumerKey : string
Every Consumer Key has a Consumer Secret unless you're in RSA-land.
$_consumerSecret : string
Define the OAuth realm
$_realm : 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.
$_requestMethod : string
Default
\Zend_Oauth::POST
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.
$_requestScheme : string
Default
\Zend_Oauth::REQUEST_SCHEME_HEADER
The URL to which requests for a Request Token should be directed.
$_requestTokenUrl : string
When absent, assumed siteUrl+'/request_token'
If relevant, a PEM encoded RSA private key encapsulated as a
Zend_Crypt_Rsa Key
$_rsaPrivateKey : \Zend_Crypt_Rsa_Key_Private
If relevant, a PEM encoded RSA public key encapsulated as a
Zend_Crypt_Rsa Key
$_rsaPublicKey : \Zend_Crypt_Rsa_Key_Public
Signature method used when signing all parameters for an HTTP request
$_signatureMethod : string
The URL root to append default OAuth endpoint paths.
$_siteUrl : string
Generally this will nearly always be an Access Token represented as a
Zend_Oauth_Token_Access object.
$_token : \Zend_Oauth_Token
OAuth Version; This defaults to 1.0 - Must not be changed!
$_version : string