OAuthSignatureMethod Class Reference

Inheritance diagram for OAuthSignatureMethod:

List of all members.

Public Member Functions
	getName ()
	buildSignature ($request, $consumer, $token)
	checkSignature ($request, $consumer, $token, $signature)

---

Detailed Description

A class for implementing a Signature Method See section 9 ("Signing Requests") in the spec

---

Member Function Documentation

OAuthSignatureMethod::buildSignature	(	$	request,
		$	consumer,
		$	token
	)		[abstract]

Build up the signature NOTE: The output of this function MUST NOT be urlencoded. the encoding is handled in OAuthRequest when the final request is serialized

Parameters:

OAuthRequest	$request
OAuthConsumer	$consumer
OAuthToken	$token

Returns:

string

Reimplemented in OAuthSignatureMethodRsaSha1, OAuthSignatureMethodPlainText, and OAuthSignatureMethodHmacSha1.

OAuthSignatureMethod::checkSignature	(	$	request,
		$	consumer,
		$	token,
		$	signature
	)

Verifies that a given signature is correct.

Parameters:

OAuthRequest	$request
OAuthConsumer	$consumer
OAuthToken	$token
string	$signature

Returns:

bool

Reimplemented in OAuthSignatureMethodRsaSha1.

OAuthSignatureMethod::getName

(

)

[abstract]

Needs to return the name of the Signature Method (ie HMAC-SHA1)

Returns:

string

Reimplemented in OAuthSignatureMethodHmacSha1, OAuthSignatureMethodRsaSha1, and OAuthSignatureMethodPlainText.

---

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

• core/OAuthSignatureMethod.class.php