Introduction

The OAuth extension provides a simple interface to interact with data providers using the OAuth HTTP specification to protect private resources.

Class synopsis

OAuth {

/* Properties */

public $debug ;

public $sslChecks ;

public $debugInfo ;

/* Methods */

public __construct ( string $consumer_key , string $consumer_secret [, string $signature_method = OAUTH_SIG_METHOD_HMACSHA1 [, int $auth_type = 0 ]] )

public void __destruct ( void )

public bool disableDebug ( void )

public bool disableRedirects ( void )

public bool disableSSLChecks ( void )

public bool enableDebug ( void )

public bool enableRedirects ( void )

public bool enableSSLChecks ( void )

public mixed fetch ( string $protected_resource_url [, array $extra_parameters [, string $http_method [, array $http_headers ]]] )

public string generateSignature ( string $http_method , string $url [, mixed $extra_parameters ] )

public array getAccessToken ( string $access_token_url [, string $auth_session_handle [, string $verifier_token ]] )

public array getCAPath ( void )

public string getLastResponse ( void )

public string getLastResponseHeaders ( void )

public array getLastResponseInfo ( void )

public string getRequestHeader ( string $http_method , string $url [, mixed $extra_parameters ] )

public array getRequestToken ( string $request_token_url [, string $callback_url ] )

public mixed setAuthType ( int $auth_type )

public mixed setCAPath ([ string $ca_path [, string $ca_info ]] )

public mixed setNonce ( string $nonce )

public void setRequestEngine ( int $reqengine )

public mixed setRSACertificate ( string $cert )

public bool setSSLChecks ( int $sslcheck )

public mixed setTimestamp ( string $timestamp )

public bool setToken ( string $token , string $token_secret )

public bool setVersion ( string $version )

}

Properties

debug
sslChecks
debugInfo

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

The OAuth class

Introduction

Class synopsis

Properties

Table of Contents