Oauth/Signature/SignatureAbstract.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Oauth
version: $Id: SignatureAbstract.php 20217 2010-01-12 16:01:57Z matthew $
Classes: Zend_Oauth_Signature_SignatureAbstract

Description

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.

Zend_Oauth_Signature_SignatureAbstract
jump to top

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Oauth
Properties: $_hashAlgorithm; $_key; $_consumerSecret; $_tokenSecret
Methods: __construct; sign; normaliseBaseSignatureUrl; _assembleKey; _getBaseSignatureString; _toByteValueOrderedQueryString

Description

Properties

$_consumerSecret
jump to class

string $_consumerSecret = 'null'

Consumer secret

Details

$_consumerSecret: string
visibility: protected
default: null
final: false
static: false

$_hashAlgorithm
jump to class

string $_hashAlgorithm = 'null'

Hash algorithm to use when generating signature

Details

$_hashAlgorithm: string
visibility: protected
default: null
final: false
static: false

$_key
jump to class

string $_key = 'null'

Key to use when signing

Details

$_key: string
visibility: protected
default: null
final: false
static: false

$_tokenSecret
jump to class

string $_tokenSecret = ''

Token secret

Details

$_tokenSecret: string
visibility: protected
default
final: false
static: false

Methods

__construct
jump to class

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

Constructor

Arguments

$consumerSecret: string
$tokenSecret: nullstring
$hashAlgo: nullstring

Details

visibility: public
final: false
static: false

_assembleKey
jump to class

_assembleKey(
          
          )
        
        :
        string

Assemble key from consumer and token secrets

Output

string

Details

visibility: protected
final: false
static: false

_getBaseSignatureString
jump to class

_getBaseSignatureString(
          array $params, null|string $method
              =
              null, null|string $url
              =
              null
          )
        
        :
        string

Get base signature string

Arguments

$params: array
$method: nullstring
$url: nullstring

Output

string

Details

visibility: protected
final: false
static: false

_toByteValueOrderedQueryString
jump to class

_toByteValueOrderedQueryString(
          array $params
          )
        
        :
        string

Transform an array to a byte value ordered query string

Arguments

$params: array

Output

string

Details

visibility: protected
final: false
static: false

normaliseBaseSignatureUrl
jump to class

normaliseBaseSignatureUrl(
          string $url
          )
        
        :
        string

Normalize the base signature URL

Arguments

$url: string

Output

string

Details

visibility: public
final: false
static: false

sign
jump to class

sign(
          array $params, null|string $method
              =
              null, null|string $url
              =
              null
          )
        
        :
        string

Sign a request

Arguments

$params: array
$method: nullstring
$url: nullstring

Output

string

Details

visibility: public
final: false
static: false

API Documentation

Oauth/Signature/SignatureAbstract.php

Description

Zend_Oauth_Signature_SignatureAbstractjump to top

Description

Properties

$_consumerSecretjump to class

Details

$_hashAlgorithmjump to class

Details

$_keyjump to class

Details

$_tokenSecretjump to class

Details

Methods

__constructjump to class

Arguments

Details

_assembleKeyjump to class

Output

Details

_getBaseSignatureStringjump to class

Arguments

Output

Details

_toByteValueOrderedQueryStringjump to class

Arguments

Output

Details

normaliseBaseSignatureUrljump to class

Arguments

Output

Details

signjump to class

Arguments

Output

Details

Zend_Oauth_Signature_SignatureAbstract
jump to top

$_consumerSecret
jump to class

$_hashAlgorithm
jump to class

$_key
jump to class

$_tokenSecret
jump to class

__construct
jump to class

_assembleKey
jump to class

_getBaseSignatureString
jump to class

_toByteValueOrderedQueryString
jump to class

normaliseBaseSignatureUrl
jump to class

sign
jump to class