Docs For Class Zend_Oauth

Description

copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: New BSD License

Direct descendents

Class	Description
Zend_Oauth_Http_RequestToken
Zend_Oauth_Http_AccessToken
Zend_Oauth_Http_UserAuthorization

Variable Summary

string $_consumer

Zend_Oauth_Http_Utility $_httpUtility

array $_parameters

string $_preferredRequestMethod

string $_preferredRequestScheme

Method Summary

void __construct (Zend_Oauth_Consumer $consumer, [ $parameters = null], [Zend_Oauth_Http_Utility $utility = null])

Zend_Oauth_Consumer getConsumer ()

string getMethod ()

array getParameters ()

Zend_Http_Client getRequestSchemeQueryStringClient ( $params, string $url)

Zend_Oauth_Http setMethod (string $method)

Zend_Oauth_Http setParameters ( $customServiceParameters)

Zend_Http_Response startRequestCycle ( $params)

void _assessRequestAttempt ([ $response = null])

string _toAuthorizationHeader ( $params, [string $realm = null])

Variables

string $_consumer = null (line 49)

Reference to the Zend_Oauth_Consumer instance in use.

access: protected

Zend_Oauth_Http_Utility $_httpUtility = null (line 72)

Instance of the general Zend_Oauth_Http_Utility class.

access: protected

array $_parameters = array() (line 42)

Array of all custom service parameters to be sent in the HTTP request in addition to the usual OAuth parameters.

access: protected

string $_preferredRequestMethod = Zend_Oauth::POST (line 65)

Request Method for the HTTP Request.

access: protected

string $_preferredRequestScheme = null (line 58)

OAuth specifies three request methods, this holds the current preferred one which by default uses the Authorization Header approach for passing OAuth parameters, and a POST body for non-OAuth custom parameters.

access: protected

Methods

Constructor __construct (line 82)

Constructor

access: public

void __construct (Zend_Oauth_Consumer $consumer, [ $parameters = null], [Zend_Oauth_Http_Utility $utility = null])

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

getConsumer (line 152)

Return the Consumer instance in use.

access: public

Zend_Oauth_Consumer getConsumer ()

getMethod (line 120)

Preferred HTTP request method accessor.

access: public

string getMethod ()

getParameters (line 142)

Accessor for an array of custom parameters.

access: public

array getParameters ()

getRequestSchemeQueryStringClient (line 204)

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

access: public

Zend_Http_Client getRequestSchemeQueryStringClient ( $params, string $url)

array $params
string $url

Redefined in descendants as:

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

setMethod (line 105)

Set a preferred HTTP request method.

access: public

Zend_Oauth_Http setMethod (string $method)

string $method

setParameters (line 131)

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

access: public

Zend_Oauth_Http setParameters ( $customServiceParameters)

array $customServiceParameters

startRequestCycle (line 169)

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.

todo: Remove cycling?; Replace with upfront do-or-die configuration
throws: Zend_Oauth_Exception on HTTP request errors
access: public

Zend_Http_Response startRequestCycle ( $params)

array $params

_assessRequestAttempt (line 223)

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

throws: Zend_Oauth_Exception if unable to retrieve valid token response
access: protected

void _assessRequestAttempt ([ $response = null])

Zend_Http_Response $response

_toAuthorizationHeader (line 251)

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

access: protected

string _toAuthorizationHeader ( $params, [string $realm = null])

array $params
string $realm