API Documentation
\

\Horde_Oauth_Consumer

OAuth consumer class

Summary

Methods
Properties
Constants
__construct()
__get()
getRequestToken()
getUserAuthorizationUrl()
getAccessToken()
No public properties found
No constants found
No protected methods found
$_config
N/A
No private methods found
No private properties found
N/A

Properties

$_config

$_config :

Type

Methods

__construct()

__construct(array  $config) : \Horde_Oauth_Consumer

Const'r for consumer.

Parameters

array $config

Configuration values:

   'key'               - Consumer key
   'secret'            - Consumer secret
   'requestTokenUrl'   - The request token URL
   'authorizeTokenUrl' - The authorize URL
   'accessTokenUrl'    = To obtain an access token
   'signatureMethod    - Horde_Oauth_SignatureMethod object

Returns

\Horde_Oauth_Consumer

__get()

__get(  $name)

Parameters

$name

getRequestToken()

getRequestToken(array  $params = array()) : \Horde_Oauth_Token

Obtain an unprivileged request token

Parameters

array $params

Parameter array

Returns

\Horde_Oauth_Token —

The oauth request token

getUserAuthorizationUrl()

getUserAuthorizationUrl(\Horde_Oauth_Token  $token) : string

Get the user authorization url used to request user authorization

Parameters

\Horde_Oauth_Token $token

the oauth request token

Returns

string —

The user authorization url string

getAccessToken()

getAccessToken(\Horde_Oauth_Token  $token, array  $params = array()) : \unknown_type

Obtain an access token from a request token

Parameters

\Horde_Oauth_Token $token

Open auth token containing the oauth_token returned from provider after authorization and the token secret returned with the original request token.
array $params

Any additional parameters for this request

Returns

\unknown_type