Become Zend Certified

Prepare for the ZCE exam using our quizzes (web or iPad/iPhone). More info...

When you're ready get 7.5% off your exam voucher using voucher CJQNOV23 at the Zend Store

The OAuth class

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 $OAuth->debug ;

public $sslChecks ;

public $debugInfo ;

/* Methods */

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

public void OAuth::__destruct ( void )

public bool OAuth::disableDebug ( void )

public bool OAuth::disableRedirects ( void )

public bool OAuth::disableSSLChecks ( void )

public bool OAuth::enableDebug ( void )

public bool OAuth::enableRedirects ( void )

public bool OAuth::enableSSLChecks ( void )

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

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

public array OAuth::getCAPath ( void )

public string OAuth::getLastResponse ( void )

public array OAuth::getLastResponseInfo ( void )

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

public mixed OAuth::setAuthType ( int $auth_type )

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

public mixed OAuth::setNonce ( string $nonce )

public void OAuth::setRequestEngine ( int $reqengine )

public mixed OAuth::setRSACertificate ( string $cert )

public mixed OAuth::setTimestamp ( string $timestamp )

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

public bool OAuth::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::getAccessToken - Fetch an access token
OAuth::getCAPath - Gets CA information
OAuth::getLastResponse - Get the last response
OAuth::getLastResponseInfo - Get HTTP information about the last response
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::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

PHP Manual