PHP Class Horde_Oauth_Consumer, horde

Author: Chuck Hagenbuch ([email protected])
Show file Open project: horde/horde

Protected Properties

Property Type Description
$_config

Public Methods

Method Description
__construct ( array $config ) : Horde_Oauth_Consumer Const'r for consumer.
__get ( $name )
getAccessToken ( Horde_Oauth_Token $token, array $params = [] ) : unknown_type Obtain an access token from a request token
getRequestToken ( array $params = [] ) : Horde_Oauth_Token Obtain an unprivileged request token
getUserAuthorizationUrl ( Horde_Oauth_Token $token ) : string Get the user authorization url used to request user authorization

Method Details

__construct() public method

Const'r for consumer.
public __construct ( array $config ) : Horde_Oauth_Consumer
$config array 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
return Horde_Oauth_Consumer

__get() public method

public __get ( $name )

getAccessToken() public method

Obtain an access token from a request token
public getAccessToken ( Horde_Oauth_Token $token, array $params = [] ) : unknown_type
$token Horde_Oauth_Token Open auth token containing the oauth_token returned from provider after authorization and the token secret returned with the original request token.
$params array Any additional parameters for this request
return unknown_type

getRequestToken() public method

Obtain an unprivileged request token
public getRequestToken ( array $params = [] ) : Horde_Oauth_Token
$params array Parameter array
return Horde_Oauth_Token The oauth request token

getUserAuthorizationUrl() public method

Get the user authorization url used to request user authorization
public getUserAuthorizationUrl ( Horde_Oauth_Token $token ) : string
$token Horde_Oauth_Token the oauth request token
return string The user authorization url string

Property Details

$_config protected property

protected $_config