The OAuthProvider class

(PECL OAuth >= 1.0.0)

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.

class OAuthProvider {

/* Methods */

final public function addRequiredParameter(string $req_params): bool

public function checkOAuthRequest(string $uri = ?, string $method = ?): void

public function __construct(array $params_array = ?)

public function consumerHandler(callable $callback_function): void

final public static function generateToken(int $size, bool $strong = false): string

public function is2LeggedEndpoint(mixed $params_array): void

public function isRequestTokenEndpoint(bool $will_issue_request_token): void

final public function removeRequiredParameter(string $req_params): bool

final public static function reportProblem(string $oauthexception, bool $send_headers = true): string

final public function setParam(string $param_key, mixed $param_val = ?): bool

final public function setRequestTokenPath(string $path): bool

public function timestampNonceHandler(callable $callback_function): void

public function tokenHandler(callable $callback_function): void

}

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