The OAuth class
(PECL OAuth >= 0.99.1)
Introduction
The OAuth extension provides a simple interface to interact with data providers using the OAuth HTTP specification to protect private resources.
Class synopsis
class OAuth
{
/* Properties */
public
$debug;
public
$sslChecks;
public
$debugInfo;
/* Methods */
public __construct(
string
string
string
int
)
string
$consumer_key,string
$consumer_secret,string
$signature_method = OAUTH_SIG_METHOD_HMACSHA1,int
$auth_type = 0)
public fetch(
string
array
string
array
): mixed
string
$protected_resource_url,array
$extra_parameters = ?,string
$http_method = ?,array
$http_headers = ?): mixed
public generateSignature(string
$http_method, string $url, mixed $extra_parameters = ?): string|falsepublic getAccessToken(
string
string
string
string
): array
string
$access_token_url,string
$auth_session_handle = ?,string
$verifier_token = ?,string
$http_method = ?): array
public getRequestHeader(string
$http_method, string $url, mixed $extra_parameters = ?): string|falsepublic getRequestToken(string
}$request_token_url, string $callback_url = ?, string $http_method = ?): arrayProperties
- debug
- sslChecks
- debugInfo
Table of Contents
- OAuth::__construct — Create a new OAuth object
- OAuth::__destruct — The destructor
- OAuth::disableDebug — Turn off verbose debugging
- OAuth::disableRedirects — Turn off redirects
- OAuth::disableSSLChecks — Turn off SSL checks
- OAuth::enableDebug — Turn on verbose debugging
- OAuth::enableRedirects — Turn on redirects
- OAuth::enableSSLChecks — Turn on SSL checks
- OAuth::fetch — Fetch an OAuth protected resource
- OAuth::generateSignature — Generate a signature
- OAuth::getAccessToken — Fetch an access token
- OAuth::getCAPath — Gets CA information
- OAuth::getLastResponse — Get the last response
- OAuth::getLastResponseHeaders — Get headers for last response
- OAuth::getLastResponseInfo — Get HTTP information about the last response
- OAuth::getRequestHeader — Generate OAuth header string signature
- OAuth::getRequestToken — Fetch a request token
- OAuth::setAuthType — Set authorization type
- OAuth::setCAPath — Set CA path and info
- OAuth::setNonce — Set the nonce for subsequent requests
- OAuth::setRequestEngine — The setRequestEngine purpose
- OAuth::setRSACertificate — Set the RSA certificate
- OAuth::setSSLChecks — Tweak specific SSL checks for requests
- OAuth::setTimestamp — Set the timestamp
- OAuth::setToken — Sets the token and secret
- OAuth::setVersion — Set the OAuth version
Here you can write a comment
There are no comments available yet.
