OAuthTable of Contents
The OAuth classIntroductionThe OAuth extension provides a simple interface to interact with data providers using the OAuth HTTP specification to protect private resources. Class synopsisOAuth
class 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
The OAuthProvider classIntroductionManages an OAuth provider class. See also an external in-depth tutorial titled » Writing an OAuth Provider Service, which takes a hands-on approach to providing this service. There are also » OAuth provider examples within the OAuth extensions sources. Class synopsisOAuthProvider
class OAuthProvider
{
/* Methods */
final public bool addRequiredParameter
( string
$req_params
)
public void callconsumerHandler
( void
)
public void callTimestampNonceHandler
( void
)
public void calltokenHandler
( void
)
public void checkOAuthRequest
([ string
$uri
[, string $method
]] )
public __construct
([ array
$params_array
] )
public void consumerHandler
( callable
$callback_function
)
final public static string generateToken
( int
$size
[, bool $strong = false
] )
public void is2LeggedEndpoint
( mixed
$params_array
)
public void isRequestTokenEndpoint
( bool
$will_issue_request_token
)
final public bool removeRequiredParameter
( string
$req_params
)
final public static string reportProblem
( string
$oauthexception
[, bool $send_headers = true
] )
final public bool setParam
( string
$param_key
[, mixed $param_val
] )
final public bool setRequestTokenPath
( string
$path
)
public void timestampNonceHandler
( callable
$callback_function
)
public void tokenHandler
( callable
}$callback_function
)OAuthException classIntroductionThis exception is thrown when exceptional errors occur while using the OAuth extension and contains useful debugging information. Class synopsisOAuthException
class OAuthException
extends
Exception
{
/* Properties */
public
$lastResponse
;
public
$debugInfo
;
/* Inherited properties */
protected
string
$message
;
protected
int
$code
;
protected
string
$file
;
protected
int
$line
;
/* Inherited methods */
final public string Exception::getMessage
( void
)
final public Exception Exception::getPrevious
( void
)
final public mixed Exception::getCode
( void
)
final public string Exception::getFile
( void
)
final public int Exception::getLine
( void
)
final public array Exception::getTrace
( void
)
final public string Exception::getTraceAsString
( void
)
public string Exception::__toString
( void
)
final private void Exception::__clone
( void
)
}Properties
|