Oauth/Signature/SignatureAbstract.php

Show: PublicProtectedPrivateinherited
Table of Contents
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 [email protected] so we can send you a copy immediately.
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Oauth  
Version
$Id$  

\Zend_Oauth_Signature_SignatureAbstract

Package: Zend_Oauth
Children
\Zend_Oauth_Signature_Hmac
\Zend_Oauth_Signature_Plaintext
\Zend_Oauth_Signature_Rsa
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotectedstring $_consumerSecret = null
Consumer secret
Default valuenullDetails
Type
string
>VPropertyprotectedstring $_hashAlgorithm = null
Hash algorithm to use when generating signature
Default valuenullDetails
Type
string
>VPropertyprotectedstring $_key = null
Key to use when signing
Default valuenullDetails
Type
string
>VPropertyprotectedstring $_tokenSecret = ''
Token secret
Default value''Details
Type
string

Methods

methodpublic__construct(string $consumerSecret, null | string $tokenSecret = null, null | string $hashAlgo = null) : void

Constructor

Parameters
NameTypeDescription
$consumerSecretstring
$tokenSecretnull | string
$hashAlgonull | string
methodprotected_assembleKey() : string

Assemble key from consumer and token secrets

Returns
TypeDescription
string
methodprotected_getBaseSignatureString(array $params, null | string $method = null, null | string $url = null) : string

Get base signature string

Parameters
NameTypeDescription
$paramsarray
$methodnull | string
$urlnull | string
Returns
TypeDescription
string
methodprotected_toByteValueOrderedQueryString(array $params) : string

Transform an array to a byte value ordered query string

Parameters
NameTypeDescription
$paramsarray
Returns
TypeDescription
string
methodpublicnormaliseBaseSignatureUrl(string $url) : string

Normalize the base signature URL

Parameters
NameTypeDescription
$urlstring
Returns
TypeDescription
string
methodpublicsign(array $params, null | string $method = null, null | string $url = null) : string
abstract

Sign a request

Parameters
NameTypeDescription
$paramsarray
$methodnull | string
$urlnull | string
Returns
TypeDescription
string
Documentation was generated by phpDocumentor 2.2.0 .