Overview

Packages

  • Oauth

Classes

  • Horde_Oauth_Consumer
  • Horde_Oauth_Exception
  • Horde_Oauth_Request
  • Horde_Oauth_SignatureMethod
  • Horde_Oauth_SignatureMethod_HmacSha1
  • Horde_Oauth_SignatureMethod_Plaintext
  • Horde_Oauth_SignatureMethod_RsaSha1
  • Horde_Oauth_Token
  • Horde_Oauth_Utils
  • Overview
  • Package
  • Class
  • Tree

Class Horde_Oauth_Consumer

OAuth consumer class

Package: Oauth
Category: Horde
License: BSD
Author: Chuck Hagenbuch chuck@horde.org
Located at Horde/Oauth/Consumer.php
Methods summary
public Horde_Oauth_Consumer
# __construct( array $config )

Const'r for consumer.

Const'r for consumer.

Parameters

$config
Configuration values: <pre><span class="php-quote">'key'</span> - Consumer <span class="php-keyword2">key</span> <span class="php-quote">'secret'</span> - Consumer secret <span class="php-quote">'requestTokenUrl'</span> - The request token URL <span class="php-quote">'authorizeTokenUrl'</span> - The authorize URL <span class="php-quote">'accessTokenUrl'</span> = To obtain an access token <span class="php-quote">'signatureMethod - Horde_Oauth_SignatureMethod object</span></pre>

Returns

Horde_Oauth_Consumer
public
# __get( mixed $name )
public Horde_Oauth_Token
# getRequestToken( array $params = array() )

Obtain an unprivileged request token

Obtain an unprivileged request token

Parameters

$params
Parameter array

Returns

Horde_Oauth_Token
The oauth request token
public string
# getUserAuthorizationUrl( Horde_Oauth_Token $token )

Get the user authorization url used to request user authorization

Get the user authorization url used to request user authorization

Parameters

$token
the oauth request token

Returns

string
The user authorization url string
public unknown_type
# getAccessToken( Horde_Oauth_Token $token, array $params = array() )

Obtain an access token from a request token

Obtain an access token from a request token

Parameters

$token
<p>Open auth token containing the oauth_token returned from provider after authorization and the token secret returned with the original request token.</p>
$params
Any additional parameters for this request

Returns

unknown_type
API documentation generated by ApiGen