The OAuthProvider class

Introduction

Manages 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.

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 ]] )

__construct ([ array $params_array ] )

public void consumerHandler ( callback $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 ( callback $callback_function )

public void tokenHandler ( callback $callback_function )

}

OAuthProvider::addRequiredParameter — Add required parameters
OAuthProvider::callconsumerHandler — Calls the consumerNonceHandler callback
OAuthProvider::callTimestampNonceHandler — Calls the timestampNonceHandler callback
OAuthProvider::calltokenHandler — Calls the tokenNonceHandler callback
OAuthProvider::checkOAuthRequest — Check an oauth request
OAuthProvider::__construct — Constructs a new OAuthProvider object
OAuthProvider::consumerHandler — Set the consumerHandler handler callback
OAuthProvider::generateToken — Generate a random token
OAuthProvider::is2LeggedEndpoint — is2LeggedEndpoint
OAuthProvider::isRequestTokenEndpoint — Sets isRequestTokenEndpoint
OAuthProvider::removeRequiredParameter — Remove a required parameter
OAuthProvider::reportProblem — Report a problem
OAuthProvider::setParam — Set a parameter
OAuthProvider::setRequestTokenPath — Set request token path
OAuthProvider::timestampNonceHandler — Set the timestampNonceHandler handler callback
OAuthProvider::tokenHandler — Set the tokenHandler handler callback