Class Zend_Oauth_Http_AccessToken

Description
Description | Vars (details) | Methods (details)
  • copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
  • license: New BSD License

Located in /Oauth/Http/AccessToken.php (line 34) 

Zend_Oauth_Http
   |
   --Zend_Oauth_Http_AccessToken
Variable Summary
Description | Vars (details) | Methods (details)
Zend_Http_Client $_httpClient
Method Summary
Description | Vars (details) | Methods (details)
array assembleParams ()
Zend_Oauth_Token_Access execute ()
Zend_Http_Client getRequestSchemeHeaderClient ( $params)
Zend_Http_Client getRequestSchemePostBodyClient ( $params)
Zend_Http_Client getRequestSchemeQueryStringClient ( $params, string $url)
Zend_Http_Response _attemptRequest ( $params)
array _cleanParamsOfIllegalCustomParameters ( $params)
Variables
Description | Vars (details) | Methods (details)
Zend_Http_Client $_httpClient = null (line 41)

Singleton instance if required of the HTTP client

  • access: protected

Inherited Variables

Inherited from Zend_Oauth_Http

Zend_Oauth_Http::$_consumer
 Zend_Oauth_Http::$_httpUtility
 Zend_Oauth_Http::$_parameters
 Zend_Oauth_Http::$_preferredRequestMethod
 Zend_Oauth_Http::$_preferredRequestScheme
Methods
Description | Vars (details) Methods (details)
assembleParams (line 61)

Assemble all parameters for an OAuth Access Token request.

  • access: public
array assembleParams ()
execute (line 48)

Initiate a HTTP request to retrieve an Access Token.

  • access: public
Zend_Oauth_Token_Access execute ()
getRequestSchemeHeaderClient (line 95)

Generate and return a HTTP Client configured for the Header Request Scheme specified by OAuth, for use in requesting an Access Token.

  • access: public
Zend_Http_Client getRequestSchemeHeaderClient ( $params)
  • array $params
getRequestSchemePostBodyClient (line 115)

Generate and return a HTTP Client configured for the POST Body Request Scheme specified by OAuth, for use in requesting an Access Token.

  • access: public
Zend_Http_Client getRequestSchemePostBodyClient ( $params)
  • array $params
getRequestSchemeQueryStringClient (line 139)

Generate and return a HTTP Client configured for the Query String Request Scheme specified by OAuth, for use in requesting an Access Token.

  • access: public
Zend_Http_Client getRequestSchemeQueryStringClient ( $params, string $url)
  • array $params
  • string $url
Redefinition of:
Zend_Oauth_Http::getRequestSchemeQueryStringClient()
Return an instance of Zend_Http_Client configured to use the Query String scheme for an OAuth driven HTTP request.
_attemptRequest (line 152)

Attempt a request based on the current configured OAuth Request Scheme and return the resulting HTTP Response.

  • access: protected
Zend_Http_Response _attemptRequest ( $params)
  • array $params
_cleanParamsOfIllegalCustomParameters (line 180)

Access Token requests specifically may not contain non-OAuth parameters.

So these should be striped out and excluded. Detection is easy since specified OAuth parameters start with "oauth_", Extension params start with "xouth_", and no other parameters should use these prefixes.

xouth params are not currently allowable.

  • access: protected
array _cleanParamsOfIllegalCustomParameters ( $params)
  • array $params

Inherited Methods

Inherited From Zend_Oauth_Http

Zend_Oauth_Http::__construct()
Zend_Oauth_Http::getConsumer()
Zend_Oauth_Http::getMethod()
Zend_Oauth_Http::getParameters()
Zend_Oauth_Http::getRequestSchemeQueryStringClient()
Zend_Oauth_Http::setMethod()
Zend_Oauth_Http::setParameters()
Zend_Oauth_Http::startRequestCycle()
Zend_Oauth_Http::_assessRequestAttempt()
Zend_Oauth_Http::_toAuthorizationHeader()

Documentation generated on Mon, 21 Jun 2010 15:05:58 -0400 by phpDocumentor 1.4.3