HTTP_OAuth
[ class tree: HTTP_OAuth ] [ index: HTTP_OAuth ] [ all elements ]

Class: HTTP_OAuth_Signature_Common

Source Location: /HTTP_OAuth-0.3.1/HTTP/OAuth/Signature/Common.php

Class Overview

HTTP_OAuth
   |
   --HTTP_OAuth_Signature_Common

HTTP_OAuth_Signature_Common


Author(s):

Copyright:

  • 2009 Jeff Hodsdon <jeffhodsdon@gmail.com>

Methods


Child classes:

HTTP_OAuth_Signature_HMAC_SHA1
HTTP_OAuth_Signature_HMAC_SHA1
HTTP_OAuth_Signature_PLAINTEXT
HTTP_OAuth_Signature_PLAINTEXT

Inherited Variables

Inherited Methods

Class: HTTP_OAuth

HTTP_OAuth::attachLog()
Attaches an instance of PEAR Log
HTTP_OAuth::buildHttpQuery()
Build HTTP Query
HTTP_OAuth::debug()
Log debug message
HTTP_OAuth::detachLog()
Detaches an instance of PEAR Log
HTTP_OAuth::err()
Log error message
HTTP_OAuth::info()
Log info message
HTTP_OAuth::log()
Log a message
HTTP_OAuth::urldecode()
URL Decode
HTTP_OAuth::urlencode()
URL Encode

Class Details

[line 40]
HTTP_OAuth_Signature_Common

Common class for signature implemenations. Holds specification logic to create signature base strings and keys.



[ Top ]


Method Detail

build   [line 94]

string build( string $method, string $url, array $params, string $consumerSecret, [string $tokenSecret = ''])

Build
  • Return: Signature
  • Abstract:
  • Access: public

Overridden in child classes as:

HTTP_OAuth_Signature_HMAC_SHA1::build()
Build
HTTP_OAuth_Signature_PLAINTEXT::build()
Build

Parameters:

string   $method   —  HTTP method used
string   $url   —  URL of the request
array   $params   —  Parameters of the request
string   $consumerSecret   —  Consumer secret value
string   $tokenSecret   —  Token secret value (if exists)

[ Top ]

getBase   [line 52]

string getBase( mixed $method, mixed $url, array $params)

Get base
  • Return: Base signature string
  • Access: public

Parameters:

mixed   $method   —  HTTP method used in the request
mixed   $url   —  URL of the request
array   $params   —  Parameters in the request

[ Top ]

getKey   [line 75]

string getKey( string $consumerSecret, [string $tokenSecret = ''])

Get key
  • Return: Signature key
  • Access: public

Parameters:

string   $consumerSecret   —  Consumer secret value
string   $tokenSecret   —  Token secret value (if exists)

[ Top ]


Documentation generated on Mon, 11 Mar 2019 15:55:06 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.