OAuthProvider (class)
The OAuthProvider class
Introduction
(PECL OAuth >= 1.0.0)
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 synopsis
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 )}
Table of Contents
- 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
© 1997–2017 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://secure.php.net/manual/en/class.oauthprovider.php
