Zend_Oauth_Http_Utility Class Reference

Public Member Functions
	assembleParams ( $url, Zend_Oauth_Config_ConfigInterface $config, array $serviceProviderParams=null)
	toEncodedQueryString (array $params, $customParamsOnly=false)
	toAuthorizationHeader (array $params, $realm=null, $excludeCustomParams=true)
	sign (array $params, $signatureMethod, $consumerSecret, $tokenSecret=null, $method=null, $url=null)
	parseQueryString ($query)
	generateNonce ()
	generateTimestamp ()

Static Public Member Functions
static	urlEncode ($value)

Detailed Description

Definition at line 34 of file Utility.php.

Member Function Documentation

assembleParams()

assembleParams	(		$url,
		Zend_Oauth_Config_ConfigInterface	$config,
		array	$serviceProviderParams = null
	)

Assemble all parameters for a generic OAuth request - i.e. no special params other than the defaults expected for any OAuth query.

Parameters

string	$url
Zend_Oauth_Config_ConfigInterface	$config
null | array	$serviceProviderParams

Returns

array

Definition at line 45 of file Utility.php.

      {
        $params = array(
            'oauth_consumer_key'     => $config->getConsumerKey(),
            'oauth_nonce'            => $this->generateNonce(),
            'oauth_signature_method' => $config->getSignatureMethod(),
            'oauth_timestamp'        => $this->generateTimestamp(),
            'oauth_version'          => $config->getVersion(),
        );

        if ($config->getToken()->getToken() != null) {
            $params['oauth_token'] = $config->getToken()->getToken();
        }


        if ($serviceProviderParams !== null) {
            $params = array_merge($params, $serviceProviderParams);
        }

        $params['oauth_signature'] = $this->sign(
            $params,
            $config->getSignatureMethod(),
            $config->getConsumerSecret(),
            $config->getToken()->getTokenSecret(),
            $config->getRequestMethod(),
            $url
        );

        return $params;
    }

generateNonce()

generateNonce

(

)

Generate nonce

Returns

string

Definition at line 190 of file Utility.php.

    {
        return md5(uniqid(rand(), true));
    }

generateTimestamp()

generateTimestamp

(

)

Generate timestamp

Returns

int

Definition at line 200 of file Utility.php.

    {
        return time();
    }

parseQueryString()

parseQueryString

(

$query

)

Parse query string

Parameters

mixed

$query

Returns

array

Definition at line 168 of file Utility.php.

    {
        $params = array();
        if (empty($query)) {
            return array();
        }

        // Not remotely perfect but beats parse_str() which converts
        // periods and uses urldecode, not rawurldecode.
        $parts = explode('&', $query);
        foreach ($parts as $pair) {
            $kv = explode('=', $pair);
            $params[rawurldecode($kv[0])] = rawurldecode($kv[1]);
        }
        return $params;
    }

sign()

sign	(	array	$params,
			$signatureMethod,
			$consumerSecret,
			$tokenSecret = null,
			$method = null,
			$url = null
	)

Sign request

Parameters

array	$params
string	$signatureMethod
string	$consumerSecret
null | string	$tokenSecret
null | string	$method
null | string	$url

Returns

string

Definition at line 144 of file Utility.php.

      {
        $className = '';
        $hashAlgo  = null;
        $parts     = explode('-', $signatureMethod);
        if (count($parts) > 1) {
            $className = 'Zend_Oauth_Signature_' . ucfirst(strtolower($parts[0]));
            $hashAlgo  = $parts[1];
        } else {
            $className = 'Zend_Oauth_Signature_' . ucfirst(strtolower($signatureMethod));
        }

        #require_once str_replace('_', '/', $className) . '.php';
        $signatureObject = new $className($consumerSecret, $tokenSecret, $hashAlgo);
        return $signatureObject->sign($params, $method, $url);
    }

toAuthorizationHeader()

toAuthorizationHeader	(	array	$params,
			$realm = null,
			$excludeCustomParams = true
	)

Cast to authorization header

Parameters

array	$params
null | string	$realm
bool	$excludeCustomParams

Returns

void

Definition at line 114 of file Utility.php.

    {
        $headerValue = array(
            'OAuth realm="' . $realm . '"',
        );

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

toEncodedQueryString()

toEncodedQueryString	(	array	$params,
			$customParamsOnly = false
	)

Given both OAuth parameters and any custom parametere, generate an encoded query string. This method expects parameters to have been assembled and signed beforehand.

Parameters

array	$params
bool	$customParamsOnly	Ignores OAuth params e.g. for requests using OAuth Header

Returns

string

Definition at line 88 of file Utility.php.

    {
        if ($customParamsOnly) {
            foreach ($params as $key=>$value) {
                if (preg_match("/^oauth_/", $key)) {
                    unset($params[$key]);
                }
            }
        }
        $encodedParams = array();
        foreach ($params as $key => $value) {
            $encodedParams[] = self::urlEncode($key)
                             . '='
                             . self::urlEncode($value);
        }
        return implode('&', $encodedParams);
    }

urlEncode()

static urlEncode (   $value )

static

urlencode a value

Parameters

string

$value

Returns

string

Definition at line 211 of file Utility.php.

    {
        $encoded = rawurlencode($value);
        $encoded = str_replace('%7E', '~', $encoded);
        return $encoded;
    }

---

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

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