Zend_Oauth_Signature_SignatureAbstract Class Reference

Inheritance diagram for Zend_Oauth_Signature_SignatureAbstract:

Public Member Functions
	__construct ($consumerSecret, $tokenSecret=null, $hashAlgo=null)
	sign (array $params, $method=null, $url=null)
	normaliseBaseSignatureUrl ($url)

Protected Member Functions
	_assembleKey ()
	_getBaseSignatureString (array $params, $method=null, $url=null)
	_toByteValueOrderedQueryString (array $params)

Protected Attributes
	$_hashAlgorithm = null
	$_key = null
	$_consumerSecret = null
	$_tokenSecret = ''

Detailed Description

Definition at line 34 of file SignatureAbstract.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$consumerSecret,
			$tokenSecret = null,
			$hashAlgo = null
	)

Constructor

Parameters

string	$consumerSecret
null | string	$tokenSecret
null | string	$hashAlgo

Returns

void

Definition at line 68 of file SignatureAbstract.php.

    {
        $this->_consumerSecret = $consumerSecret;
        if (isset($tokenSecret)) {
            $this->_tokenSecret = $tokenSecret;
        }
        $this->_key = $this->_assembleKey();
        if (isset($hashAlgo)) {
            $this->_hashAlgorithm = $hashAlgo;
        }
    }

Member Function Documentation

_assembleKey()

_assembleKey ( )

protected

Assemble key from consumer and token secrets

Returns

string

Definition at line 115 of file SignatureAbstract.php.

    {
        $parts = array($this->_consumerSecret);
        if ($this->_tokenSecret !== null) {
            $parts[] = $this->_tokenSecret;
        }
        foreach ($parts as $key => $secret) {
            $parts[$key] = Zend_Oauth_Http_Utility::urlEncode($secret);
        }
        return implode('&', $parts);
    }

_getBaseSignatureString()

_getBaseSignatureString ( array  $params,   $method = null,   $url = null  )

protected

Get base signature string

Parameters

array	$params
null | string	$method
null | string	$url

Returns

string

Definition at line 135 of file SignatureAbstract.php.

    {
        $encodedParams = array();
        foreach ($params as $key => $value) {
            $encodedParams[Zend_Oauth_Http_Utility::urlEncode($key)] =
                Zend_Oauth_Http_Utility::urlEncode($value);
        }
        $baseStrings = array();
        if (isset($method)) {
            $baseStrings[] = strtoupper($method);
        }
        if (isset($url)) {
            // should normalise later
            $baseStrings[] = Zend_Oauth_Http_Utility::urlEncode(
                $this->normaliseBaseSignatureUrl($url)
            );
        }
        if (isset($encodedParams['oauth_signature'])) {
            unset($encodedParams['oauth_signature']);
        }
        $baseStrings[] = Zend_Oauth_Http_Utility::urlEncode(
            $this->_toByteValueOrderedQueryString($encodedParams)
        );
        return implode('&', $baseStrings);
    }

_toByteValueOrderedQueryString()

_toByteValueOrderedQueryString ( array  $params )

protected

Transform an array to a byte value ordered query string

Parameters

array

$params

Returns

string

Definition at line 167 of file SignatureAbstract.php.

    {
        $return = array();
        uksort($params, 'strnatcmp');
        foreach ($params as $key => $value) {
            if (is_array($value)) {
                natsort($value);
                foreach ($value as $keyduplicate) {
                    $return[] = $key . '=' . $keyduplicate;
                }
            } else {
                $return[] = $key . '=' . $value;
            }
        }
        return implode('&', $return);
    }

normaliseBaseSignatureUrl()

normaliseBaseSignatureUrl

(

$url

)

Normalize the base signature URL

Parameters

string

$url

Returns

string

Definition at line 96 of file SignatureAbstract.php.

    {
        $uri = Zend_Uri_Http::fromString($url);
        if ($uri->getScheme() == 'http' && $uri->getPort() == '80') {
            $uri->setPort('');
        } elseif ($uri->getScheme() == 'https' && $uri->getPort() == '443') {
            $uri->setPort('');
        }
        $uri->setQuery('');
        $uri->setFragment('');
        $uri->setHost(strtolower($uri->getHost()));
        return $uri->getUri(true);
    }

sign()

sign ( array  $params,   $method = null,   $url = null  )

abstract

Sign a request

Parameters

array	$params
null | string	$method
null | string	$url

Returns

string

Field Documentation

$_consumerSecret

$_consumerSecret = null

protected

Definition at line 52 of file SignatureAbstract.php.

$_hashAlgorithm

$_hashAlgorithm = null

protected

Definition at line 40 of file SignatureAbstract.php.

$_key

$_key = null

protected

Definition at line 46 of file SignatureAbstract.php.

$_tokenSecret

$_tokenSecret = ''

protected

Definition at line 58 of file SignatureAbstract.php.

---

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

• vendor/magento/zendframework1/library/Zend/Oauth/Signature/SignatureAbstract.php