Oauth/Http.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Oauth
version: $Id: Http.php 20232 2010-01-12 17:56:33Z matthew $
Classes: Zend_Oauth_Http

Description

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Zend_Oauth_Http
jump to top

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Oauth
Properties: $_parameters; $_consumer; $_preferredRequestScheme; $_preferredRequestMethod; $_httpUtility
Methods: __construct; setMethod; getMethod; setParameters; getParameters; getConsumer; startRequestCycle; getRequestSchemeQueryStringClient; _assessRequestAttempt; _toAuthorizationHeader

Description

Properties

$_consumer
jump to class

string $_consumer = 'null'

Reference to the Zend_Oauth_Consumer instance in use.

Details

$_consumer: string
visibility: protected
default: null
final: false
static: false

$_httpUtility
jump to class

Zend_Oauth_Http_Utility $_httpUtility = 'null'

Instance of the general Zend_Oauth_Http_Utility class.

Details

$_httpUtility: Zend_Oauth_Http_Utility
visibility: protected
default: null
final: false
static: false

$_parameters
jump to class

array $_parameters = 'array'

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

Details

$_parameters: array
visibility: protected
default: array
final: false
static: false

$_preferredRequestMethod
jump to class

string $_preferredRequestMethod = 'Zend_Oauth'

Request Method for the HTTP Request.

Details

$_preferredRequestMethod: string
visibility: protected
default: Zend_Oauth
final: false
static: false

$_preferredRequestScheme
jump to class

string $_preferredRequestScheme = 'null'

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.

Details

$_preferredRequestScheme: string
visibility: protected
default: null
final: false
static: false

Methods

__construct
jump to class

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

Constructor

Arguments

$consumer: Zend_Oauth_Consumer
$parameters: nullarray
$utility: nullZend_Oauth_Http_Utility

Details

visibility: public
final: false
static: false

_assessRequestAttempt
jump to class

_assessRequestAttempt(
           $response
              =
              null
          )
        
        :
        void

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

Arguments

$response: Zend_Http_Response

Details

visibility: protected
final: false
static: false
throws: if unable to retrieve valid token response

_toAuthorizationHeader
jump to class

_toAuthorizationHeader(
          array $params, string $realm
              =
              null
          )
        
        :
        string

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

Arguments

$params: array
$realm: string

Output

string

Details

visibility: protected
final: false
static: false

getConsumer
jump to class

getConsumer(
          
          )
        
        :
        Zend_Oauth_Consumer

Return the Consumer instance in use.

Output

Zend_Oauth_Consumer

Details

visibility: public
final: false
static: false

getMethod
jump to class

getMethod(
          
          )
        
        :
        string

Preferred HTTP request method accessor.

Output

string

Details

visibility: public
final: false
static: false

getParameters
jump to class

getParameters(
          
          )
        
        :
        array

Accessor for an array of custom parameters.

Output

array

Details

visibility: public
final: false
static: false

getRequestSchemeQueryStringClient
jump to class

getRequestSchemeQueryStringClient(
          array $params, string $url
          )
        
        :
        Zend_Http_Client

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

Arguments

$params: array
$url: string

Output

Zend_Http_Client

Details

visibility: public
final: false
static: false

setMethod
jump to class

setMethod(
          string $method
          )
        
        :
        Zend_Oauth_Http

Set a preferred HTTP request method.

Arguments

$method: string

Output

Zend_Oauth_Http

Details

visibility: public
final: false
static: false

setParameters
jump to class

setParameters(
          array $customServiceParameters
          )
        
        :
        Zend_Oauth_Http

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

Arguments

$customServiceParameters: array

Output

Zend_Oauth_Http

Details

visibility: public
final: false
static: false

startRequestCycle
jump to class

startRequestCycle(
          array $params
          )
        
        :
        Zend_Http_Response

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.

Arguments

$params: array

Output

Zend_Http_Response

Details

visibility: public
final: false
static: false
throws: on HTTP request errors
todo: Remove cycling?; Replace with upfront do-or-die configuration

API Documentation

Oauth/Http.php

Description

Zend_Oauth_Httpjump to top

Description

Properties

$_consumerjump to class

Details

$_httpUtilityjump to class

Details

$_parametersjump to class

Details

$_preferredRequestMethodjump to class

Details

$_preferredRequestSchemejump to class

Details

Methods

__constructjump to class

Arguments

Details

_assessRequestAttemptjump to class

Arguments

Details

_toAuthorizationHeaderjump to class

Arguments

Output

Details

getConsumerjump to class

Output

Details

getMethodjump to class

Output

Details

getParametersjump to class

Output

Details

getRequestSchemeQueryStringClientjump to class

Arguments

Output

Details

setMethodjump to class

Arguments

Output

Details

setParametersjump to class

Arguments

Output

Details

startRequestCyclejump to class

Arguments

Output

Details

Zend_Oauth_Http
jump to top

$_consumer
jump to class

$_httpUtility
jump to class

$_parameters
jump to class

$_preferredRequestMethod
jump to class

$_preferredRequestScheme
jump to class

__construct
jump to class

_assessRequestAttempt
jump to class

_toAuthorizationHeader
jump to class

getConsumer
jump to class

getMethod
jump to class

getParameters
jump to class

getRequestSchemeQueryStringClient
jump to class

setMethod
jump to class

setParameters
jump to class

startRequestCycle
jump to class