OAuthSignatureMethod
in package
A class for implementing a Signature Method See section 9 ("Signing Requests") in the spec
Table of Contents
- build_signature() : string
- Build up the signature NOTE: The output of this function MUST NOT be urlencoded.
- check_signature() : bool
- Verifies that a given signature is correct
- get_name() : string
- Needs to return the name of the Signature Method (ie HMAC-SHA1)
Methods
build_signature()
Build up the signature NOTE: The output of this function MUST NOT be urlencoded.
public
abstract build_signature(OAuthRequest $request, OAuthConsumer $consumer, OAuthToken $token) : string
the encoding is handled in OAuthRequest when the final request is serialized
Parameters
- $request : OAuthRequest
- $consumer : OAuthConsumer
- $token : OAuthToken
Return values
string —check_signature()
Verifies that a given signature is correct
public
check_signature(OAuthRequest $request, OAuthConsumer $consumer, OAuthToken $token, string $signature) : bool
Parameters
- $request : OAuthRequest
- $consumer : OAuthConsumer
- $token : OAuthToken
- $signature : string
Return values
bool —get_name()
Needs to return the name of the Signature Method (ie HMAC-SHA1)
public
abstract get_name() : string