Zend_Oauth_Http_AccessToken Class Reference

Inheritance diagram for Zend_Oauth_Http_AccessToken:

Public Member Functions
	execute ()
	assembleParams ()
	getRequestSchemeHeaderClient (array $params)
	getRequestSchemePostBodyClient (array $params)
	getRequestSchemeQueryStringClient (array $params, $url)
Public Member Functions inherited from Zend_Oauth_Http
	__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
	_attemptRequest (array $params)
	_cleanParamsOfIllegalCustomParameters (array $params)
Protected Member Functions inherited from Zend_Oauth_Http
	_assessRequestAttempt (Zend_Http_Response $response=null)
	_toAuthorizationHeader (array $params, $realm=null)

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

Detailed Description

Definition at line 34 of file AccessToken.php.

Member Function Documentation

_attemptRequest()

_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

Definition at line 152 of file AccessToken.php.

    {
        switch ($this->_preferredRequestScheme) {
            case Zend_Oauth::REQUEST_SCHEME_HEADER:
                $httpClient = $this->getRequestSchemeHeaderClient($params);
                break;
            case Zend_Oauth::REQUEST_SCHEME_POSTBODY:
                $httpClient = $this->getRequestSchemePostBodyClient($params);
                break;
            case Zend_Oauth::REQUEST_SCHEME_QUERYSTRING:
                $httpClient = $this->getRequestSchemeQueryStringClient($params,
                    $this->_consumer->getAccessTokenUrl());
                break;
        }
        return $httpClient->request();
    }

_cleanParamsOfIllegalCustomParameters()

_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

Definition at line 180 of file AccessToken.php.

    {
        foreach ($params as $key=>$value) {
            if (!preg_match("/^oauth_/", $key)) {
                unset($params[$key]);
            }
        }
        return $params;
    }

assembleParams()

assembleParams

(

)

Assemble all parameters for an OAuth Access Token request.

Returns

array

Definition at line 61 of file AccessToken.php.

    {
        $params = array(
            'oauth_consumer_key'     => $this->_consumer->getConsumerKey(),
            'oauth_nonce'            => $this->_httpUtility->generateNonce(),
            'oauth_signature_method' => $this->_consumer->getSignatureMethod(),
            'oauth_timestamp'        => $this->_httpUtility->generateTimestamp(),
            'oauth_token'            => $this->_consumer->getLastRequestToken()->getToken(),
            'oauth_version'          => $this->_consumer->getVersion(),
        );

        if (!empty($this->_parameters)) {
            $params = array_merge($params, $this->_parameters);
        }

        $params['oauth_signature'] = $this->_httpUtility->sign(
            $params,
            $this->_consumer->getSignatureMethod(),
            $this->_consumer->getConsumerSecret(),
            $this->_consumer->getLastRequestToken()->getTokenSecret(),
            $this->_preferredRequestMethod,
            $this->_consumer->getAccessTokenUrl()
        );

        return $params;
    }

execute()

execute

(

)

Initiate a HTTP request to retrieve an Access Token.

Returns

Zend_Oauth_Token_Access

Definition at line 48 of file AccessToken.php.

    {
        $params   = $this->assembleParams();
        $response = $this->startRequestCycle($params);
        $return   = new Zend_Oauth_Token_Access($response);
        return $return;
    }

getRequestSchemeHeaderClient()

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

Definition at line 95 of file AccessToken.php.

    {
        $params      = $this->_cleanParamsOfIllegalCustomParameters($params);
        $headerValue = $this->_toAuthorizationHeader($params);
        $client      = Zend_Oauth::getHttpClient();

        $client->setUri($this->_consumer->getAccessTokenUrl());
        $client->setHeaders('Authorization', $headerValue);
        $client->setMethod($this->_preferredRequestMethod);

        return $client;
    }

getRequestSchemePostBodyClient()

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

Definition at line 115 of file AccessToken.php.

    {
        $params = $this->_cleanParamsOfIllegalCustomParameters($params);
        $client = Zend_Oauth::getHttpClient();
        $client->setUri($this->_consumer->getAccessTokenUrl());
        $client->setMethod($this->_preferredRequestMethod);
        $client->setRawData(
            $this->_httpUtility->toEncodedQueryString($params)
        );
        $client->setHeaders(
            Zend_Http_Client::CONTENT_TYPE,
            Zend_Http_Client::ENC_URLENCODED
        );
        return $client;
    }

getRequestSchemeQueryStringClient()

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

Definition at line 139 of file AccessToken.php.

    {
        $params = $this->_cleanParamsOfIllegalCustomParameters($params);
        return parent::getRequestSchemeQueryStringClient($params, $url);
    }

Field Documentation

$_httpClient

$_httpClient = null

protected

Definition at line 41 of file AccessToken.php.

---

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

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