You are here

abstract class OAuthSignatureMethod in Lingotek Translation 7.3

Same name and namespace in other branches
  1. 7.2 lib/oauth-php/library/signature_method/OAuthSignatureMethod.class.php \OAuthSignatureMethod

Interface for OAuth signature methods

@version $Id$ @author Marc Worrell <marcw@pobox.com> @date Sep 8, 2008 12:04:35 PM

The MIT License

Copyright (c) 2007-2008 Mediamatic Lab

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Hierarchy

Expanded class hierarchy of OAuthSignatureMethod

File

lib/oauth-php/library/signature_method/OAuthSignatureMethod.class.php, line 33

View source
abstract class OAuthSignatureMethod {

  /**
   * Return the name of this signature
   *
   * @return string
   */
  public abstract function name();

  /**
   * Return the signature for the given request
   *
   * @param OAuthRequest request
   * @param string base_string
   * @param string consumer_secret
   * @param string token_secret
   * @return string
   */
  public abstract function signature($request, $base_string, $consumer_secret, $token_secret);

  /**
   * Check if the request signature corresponds to the one calculated for the request.
   *
   * @param OAuthRequest request
   * @param string base_string	data to be signed, usually the base string, can be a request body
   * @param string consumer_secret
   * @param string token_secret
   * @param string signature		from the request, still urlencoded
   * @return string
   */
  public abstract function verify($request, $base_string, $consumer_secret, $token_secret, $signature);

}

Members

Namesort descending Modifiers Type Description Overrides
OAuthSignatureMethod::name abstract public function * Return the name of this signature * * 4
OAuthSignatureMethod::signature abstract public function * Return the signature for the given request * * 4
OAuthSignatureMethod::verify abstract public function * Check if the request signature corresponds to the one calculated for the request. * * 4