You are here

abstract class OAuthSignatureMethod in jQuery social stream 8

Same name and namespace in other branches
  1. 8.2 src/Twitter/OAuthSignatureMethod.php \Drupal\jquery_social_stream\Twitter\OAuthSignatureMethod

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

Hierarchy

Expanded class hierarchy of OAuthSignatureMethod

File

src/Twitter/OAuthSignatureMethod.php, line 9

Namespace

Drupal\jquery_social_stream\Twitter
View source
abstract class OAuthSignatureMethod {

  /**
   * Needs to return the name of the Signature Method (ie HMAC-SHA1)
   * @return string
   */
  public abstract function get_name();

  /**
   * 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
   * @param OAuthRequest $request
   * @param OAuthConsumer $consumer
   * @param OAuthToken $token
   * @return string
   */
  public abstract function build_signature($request, $consumer, $token);

  /**
   * Verifies that a given signature is correct
   * @param OAuthRequest $request
   * @param OAuthConsumer $consumer
   * @param OAuthToken $token
   * @param string $signature
   * @return bool
   */
  public function check_signature($request, $consumer, $token, $signature) {
    $built = $this
      ->build_signature($request, $consumer, $token);
    return $built == $signature;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
OAuthSignatureMethod::build_signature abstract public function 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 3
OAuthSignatureMethod::check_signature public function Verifies that a given signature is correct 1
OAuthSignatureMethod::get_name abstract public function Needs to return the name of the Signature Method (ie HMAC-SHA1) 3