Zend_Oauth_Http Class Reference

Inheritance diagram for Zend_Oauth_Http:

Public Member Functions
	__construct (Zend_Oauth_Consumer $consumer, array $parameters=null, Zend_Oauth_Http_Utility $utility=null)
	setMethod ($method)
	getMethod ()
	setParameters (array $customServiceParameters)
	getParameters ()
	getConsumer ()
	startRequestCycle (array $params)
	getRequestSchemeQueryStringClient (array $params, $url)

Protected Member Functions
	_assessRequestAttempt (Zend_Http_Response $response=null)
	_toAuthorizationHeader (array $params, $realm=null)

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

Detailed Description

Definition at line 34 of file Http.php.

Constructor & Destructor Documentation

__construct()

__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

Definition at line 82 of file Http.php.

      {
        $this->_consumer = $consumer;
        $this->_preferredRequestScheme = $this->_consumer->getRequestScheme();
        if ($parameters !== null) {
            $this->setParameters($parameters);
        }
        if ($utility !== null) {
            $this->_httpUtility = $utility;
        } else {
            $this->_httpUtility = new Zend_Oauth_Http_Utility;
        }
    }

Member Function Documentation

_assessRequestAttempt()

_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

Definition at line 223 of file Http.php.

    {
        switch ($this->_preferredRequestScheme) {
            case Zend_Oauth::REQUEST_SCHEME_HEADER:
                $this->_preferredRequestScheme = Zend_Oauth::REQUEST_SCHEME_POSTBODY;
                break;
            case Zend_Oauth::REQUEST_SCHEME_POSTBODY:
                $this->_preferredRequestScheme = Zend_Oauth::REQUEST_SCHEME_QUERYSTRING;
                break;
            default:
                #require_once 'Zend/Oauth/Exception.php';
                throw new Zend_Oauth_Exception(
                    'Could not retrieve a valid Token response from Token URL:'
                    . ($response !== null
                        ? PHP_EOL . $response->getBody()
                        : ' No body - check for headers')
                );
        }
    }

_toAuthorizationHeader()

_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

Definition at line 251 of file Http.php.

    {
        $headerValue = array();
        $headerValue[] = 'OAuth realm="' . $realm . '"';
        foreach ($params as $key => $value) {
            if (!preg_match("/^oauth_/", $key)) {
                continue;
            }
            $headerValue[] = Zend_Oauth_Http_Utility::urlEncode($key)
                           . '="'
                           . Zend_Oauth_Http_Utility::urlEncode($value)
                           . '"';
        }
        return implode(",", $headerValue);
    }

getConsumer()

getConsumer

(

)

Return the Consumer instance in use.

Returns

Zend_Oauth_Consumer

Definition at line 152 of file Http.php.

    {
        return $this->_consumer;
    }

getMethod()

getMethod

(

)

Preferred HTTP request method accessor.

Returns

string

Definition at line 120 of file Http.php.

    {
        return $this->_preferredRequestMethod;
    }

getParameters()

getParameters

(

)

Accessor for an array of custom parameters.

Returns

array

Definition at line 142 of file Http.php.

    {
        return $this->_parameters;
    }

getRequestSchemeQueryStringClient()

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

Definition at line 204 of file Http.php.

    {
        $client = Zend_Oauth::getHttpClient();
        $client->setUri($url);
        $client->getUri()->setQuery(
            $this->_httpUtility->toEncodedQueryString($params)
        );
        $client->setMethod($this->_preferredRequestMethod);
        return $client;
    }

setMethod()

setMethod

(

$method

)

Set a preferred HTTP request method.

Parameters

string

$method

Returns

Zend_Oauth_Http

Definition at line 105 of file Http.php.

    {
        if (!in_array($method, array(Zend_Oauth::POST, Zend_Oauth::GET))) {
            #require_once 'Zend/Oauth/Exception.php';
            throw new Zend_Oauth_Exception('invalid HTTP method: ' . $method);
        }
        $this->_preferredRequestMethod = $method;
        return $this;
    }

setParameters()

setParameters

(

array

$customServiceParameters

)

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

Parameters

array

$customServiceParameters

Returns

Zend_Oauth_Http

Definition at line 131 of file Http.php.

    {
        $this->_parameters = $customServiceParameters;
        return $this;
    }

startRequestCycle()

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

Definition at line 169 of file Http.php.

    {
        $response = null;
        $body     = null;
        $status   = null;
        try {
            $response = $this->_attemptRequest($params);
        } catch (Zend_Http_Client_Exception $e) {
            #require_once 'Zend/Oauth/Exception.php';
            throw new Zend_Oauth_Exception('Error in HTTP request', null, $e);
        }
        if ($response !== null) {
            $body   = $response->getBody();
            $status = $response->getStatus();
        }
        if ($response === null // Request failure/exception
            || $status == 500  // Internal Server Error
            || $status == 400  // Bad Request
            || $status == 401  // Unauthorized
            || empty($body)    // Missing token
        ) {
            $this->_assessRequestAttempt($response);
            $response = $this->startRequestCycle($params);
        }
        return $response;
    }

Field Documentation

$_consumer

$_consumer = null

protected

Definition at line 49 of file Http.php.

$_httpUtility

$_httpUtility = null

protected

Definition at line 72 of file Http.php.

$_parameters

$_parameters = array()

protected

Definition at line 42 of file Http.php.

$_preferredRequestMethod

$_preferredRequestMethod = Zend_Oauth::POST

protected

Definition at line 65 of file Http.php.

$_preferredRequestScheme

$_preferredRequestScheme = null

protected

Definition at line 58 of file Http.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/zendframework1/library/Zend/Oauth/Http.php