API Documentation

Zend/Oauth/Signature/SignatureAbstract.php

Show: inherited
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 license@zend.com so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Oauth  
Version
$Id: SignatureAbstract.php 24594 2012-01-05 21:27:01Z matthew $  

\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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectedstring  $_consumerSecret= 'null'

Consumer secret

Default valuenullDetails
Type
string
Propertyprotectedstring  $_hashAlgorithm= 'null'

Hash algorithm to use when generating signature

Default valuenullDetails
Type
string
Propertyprotectedstring  $_key= 'null'

Key to use when signing

Default valuenullDetails
Type
string
Propertyprotectedstring  $_tokenSecret= ''''

Token secret

Default value''Details
Type
string

Methods

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

Constructor

Parameters
Name Type Description
$consumerSecret string
$tokenSecret null|string
$hashAlgo null|string
methodprotected_assembleKey( ) : string

Assemble key from consumer and token secrets

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

Get base signature string

Parameters
Name Type Description
$params array
$method null|string
$url null|string
Returns
Type Description
string
methodprotected_toByteValueOrderedQueryString( array $params ) : string

Transform an array to a byte value ordered query string

Parameters
Name Type Description
$params array
Returns
Type Description
string
methodpublicnormaliseBaseSignatureUrl( string $url ) : string

Normalize the base signature URL

Parameters
Name Type Description
$url string
Returns
Type Description
string
methodpublicsign( array $params, null|string $method = null, null|string $url = null ) : string
abstract

Sign a request

Parameters
Name Type Description
$params array
$method null|string
$url null|string
Returns
Type Description
string
Documentation was generated by DocBlox 0.15.1.