Zend_Oauth_Http_AccessToken Class Reference

Public Member Functions
	execute ()
	Initiate a HTTP request to retrieve an Access Token.
	assembleParams ()
	Assemble all parameters for an OAuth Access Token request.
	getRequestSchemeHeaderClient (array $params)
	Generate and return a HTTP Client configured for the Header Request Scheme specified by OAuth, for use in requesting an Access Token.
	getRequestSchemePostBodyClient (array $params)
	Generate and return a HTTP Client configured for the POST Body Request Scheme specified by OAuth, for use in requesting an Access Token.
	getRequestSchemeQueryStringClient (array $params, $url)
	Generate and return a HTTP Client configured for the Query String Request Scheme specified by OAuth, for use in requesting an Access Token.
Public Member Functions inherited from Zend_Oauth_Http
	__construct (Zend_Oauth_Consumer $consumer, array $parameters=null, Zend_Oauth_Http_Utility $utility=null)
	Constructor.
	setMethod ($method)
	Set a preferred HTTP request method.
	getMethod ()
	Preferred HTTP request method accessor.
	setParameters (array $customServiceParameters)
	Mutator to set an array of custom parameters for the HTTP request.
	getParameters ()
	Accessor for an array of custom parameters.
	getConsumer ()
	Return the Consumer instance in use.
	startRequestCycle (array $params)
	Commence a request cycle where the current HTTP method and OAuth request scheme set an upper preferred HTTP request style and where failures generate a new HTTP request style further down the OAuth preference list for OAuth Request Schemes.
	getRequestSchemeQueryStringClient (array $params, $url)
	Return an instance of Zend_Http_Client configured to use the Query String scheme for an OAuth driven HTTP request.

Protected Member Functions
	_attemptRequest (array $params)
	Attempt a request based on the current configured OAuth Request Scheme and return the resulting HTTP Response.
	_cleanParamsOfIllegalCustomParameters (array $params)
	Access Token requests specifically may not contain non-OAuth parameters.
Protected Member Functions inherited from Zend_Oauth_Http
	_assessRequestAttempt (Zend_Http_Response $response=null)
	Manages the switch from OAuth request scheme to another lower preference scheme during a request cycle.
	_toAuthorizationHeader (array $params, $realm=null)
	Generates a valid OAuth Authorization header based on the provided parameters and realm.

Protected Attributes
	$_httpClient = null
Protected Attributes inherited from Zend_Oauth_Http
	$_parameters = array()
	$_consumer = null
	$_preferredRequestScheme = null
	$_preferredRequestMethod = Zend_Oauth::POST
	$_httpUtility = null

Member Function Documentation

_attemptRequest ( array  $params )

protected

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

Parameters

array

$params

Returns

Zend_Http_Response

_cleanParamsOfIllegalCustomParameters ( array  $params )

protected

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.

Parameters

array

$params

Returns

array

assembleParams

(

)

Assemble all parameters for an OAuth Access Token request.

Returns

array

execute

(

)

Initiate a HTTP request to retrieve an Access Token.

Returns

Zend_Oauth_Token_Access

getRequestSchemeHeaderClient

(

array

$params

)

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

Parameters

array

$params

Returns

Zend_Http_Client

getRequestSchemePostBodyClient

(

array

$params

)

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

Parameters

array

$params

Returns

Zend_Http_Client

getRequestSchemeQueryStringClient	(	array	$params,
			$url
	)

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

Parameters

array	$params
string	$url

Returns

Zend_Http_Client

Member Data Documentation

$_httpClient = null

protected