Zend_Oauth_Http Class Reference

Public Member Functions
	__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
	_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
	$_parameters = array()
	$_consumer = null
	$_preferredRequestScheme = null
	$_preferredRequestMethod = Zend_Oauth::POST
	$_httpUtility = null

Constructor & Destructor Documentation

__construct	(	Zend_Oauth_Consumer	$consumer,
		array	$parameters = null,
		Zend_Oauth_Http_Utility	$utility = null
	)

Constructor.

Parameters

Zend_Oauth_Consumer	$consumer
null | array	$parameters
null | Zend_Oauth_Http_Utility	$utility

Returns

void

Member Function Documentation

_assessRequestAttempt ( Zend_Http_Response  $response = null )

protected

Manages the switch from OAuth request scheme to another lower preference scheme during a request cycle.

Parameters

Zend_Http_Response

Returns

void

Exceptions

Zend_Oauth_Exception

if unable to retrieve valid token response

_toAuthorizationHeader ( array  $params,   $realm = null  )

protected

Generates a valid OAuth Authorization header based on the provided parameters and realm.

Parameters

array	$params
string	$realm

Returns

string

getConsumer

(

)

Return the Consumer instance in use.

Returns

Zend_Oauth_Consumer

getMethod

(

)

Preferred HTTP request method accessor.

Returns

string

getParameters

(

)

Accessor for an array of custom parameters.

Returns

array

getRequestSchemeQueryStringClient	(	array	$params,
			$url
	)

Return an instance of Zend_Http_Client configured to use the Query String scheme for an OAuth driven HTTP request.

Parameters

array	$params
string	$url

Returns

Zend_Http_Client

setMethod

(

$method

)

Set a preferred HTTP request method.

Parameters

string

$method

Returns

Zend_Oauth_Http

setParameters

(

array

$customServiceParameters

)

Mutator to set an array of custom parameters for the HTTP request.

Parameters

array

$customServiceParameters

Returns

Zend_Oauth_Http

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.

On success, return the Request object that results for processing.

Parameters

array

$params

Returns

Zend_Http_Response

Exceptions

Zend_Oauth_Exception

on HTTP request errors

Todo:

Remove cycling?; Replace with upfront do-or-die configuration

Member Data Documentation

$_consumer = null

protected

$_httpUtility = null

protected

$_parameters = array()

protected

$_preferredRequestMethod = Zend_Oauth::POST

protected

$_preferredRequestScheme = null

protected