OAuth::getRequestToken
(PECL OAuth >= 0.99.1)
OAuth::getRequestToken — Fetch a request token
Description
public array OAuth::getRequestToken
( string
$request_token_url
[, string $callback_url
] )Fetch a request token, secret and any additional response parameters from the service provider.
Parameters
-
request_token_url -
URL to the request token API.
-
callback_url -
OAuth callback URL. If
callback_urlis passed and is an empty value, it is set to "oob" to address the OAuth 2009.1 advisory.
Return Values
Returns an array containing the parsed OAuth response on success or FALSE on failure.
Changelog
| Version | Description |
|---|---|
| 1.0.0 |
Previously returned NULL on failure, instead of FALSE.
|
| 0.99.9 |
The callback_url parameter was added
|
Examples
Example #1 OAuth::getRequestToken() example
<?php
try {
$oauth = new OAuth(OAUTH_CONSUMER_KEY,OAUTH_CONSUMER_SECRET);
$request_token_info = $oauth->getRequestToken("https://example.com/oauth/request_token");
if(!empty($request_token_info)) {
print_r($request_token_info);
} else {
print "Failed fetching request token, response was: " . $oauth->getLastResponse();
}
} catch(OAuthException $E) {
echo "Response: ". $E->lastResponse . "\n";
}
?>
The above example will output something similar to:
Array
(
[oauth_token] => some_token
[oauth_token_secret] => some_token_secret
)
See Also
- OAuth::getLastResponse() - Get the last response
- OAuth::getLastResponseInfo() - Get HTTP information about the last response
- Функция 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::generateSignature() - Generate a signature
- Функция OAuth::getAccessToken() - Fetch an access token
- Функция OAuth::getCAPath() - Gets CA information
- Функция OAuth::getLastResponse() - Get the last response
- Функция OAuth::getLastResponseHeaders() - Get headers for last response
- Функция OAuth::getLastResponseInfo() - Get HTTP information about the last response
- Функция OAuth::getRequestHeader() - Generate OAuth header string signature
- Функция 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::setSSLChecks() - Tweak specific SSL checks for requests.
- Функция OAuth::setTimestamp() - Set the timestamp
- Функция OAuth::setToken() - Sets the token and secret
- Функция OAuth::setVersion() - Set the OAuth version
Коментарии
Please note that if you don't supply callback_url, the oauth parameter oauth_callback will not be sent to the server and will result in an error from the server, as this parameter is REQUIRED in the OAuth spec.