OAuth::fetch
(PECL OAuth >= 0.99.1)
OAuth::fetch — OAuth で保護されたリソースを取得する
説明
public OAuth::fetch
( string $protected_resource_url
[, array $extra_parameters
[, string $http_method
[, array $http_headers
]]] ) : mixed
リソースを取得します。
パラメータ
protected_resource_url
OAuth で保護されたリソースへの URL。
extra_parameters
リソースへのリクエストとともに送信する追加パラメータ。
http_method
OAUTH_HTTP_METHOD_*
OAUTH 定数 のいずれか。 GET、POST、PUT、HEAD そして DELETE があります。HEAD (
OAUTH_HTTP_METHOD_HEAD
) は、 実際のリクエストの前に (OAuth 認証情報がAuthorization
ヘッダにあるかどうかなどの) 情報を取得するときに有用です。http_headers
HTTP クライアントヘッダ (User-Agent や Accept など)。
返り値
成功した場合に true
を、失敗した場合に false
を返します。
変更履歴
バージョン | 説明 |
---|---|
PECL oauth 1.0.0 | 以前は、失敗したときに false ではなく null を返していました。
|
PECL oauth 0.99.5 | http_method パラメータが追加されました。
|
PECL oauth 0.99.8 | http_headers パラメータが追加されました。
|
例
例1 OAuth::fetch() の例
<?phptry { $oauth = new OAuth("consumer_key","consumer_secret",OAUTH_SIG_METHOD_HMACSHA1,OAUTH_AUTH_TYPE_AUTHORIZATION); $oauth->setToken("access_token","access_token_secret"); $oauth->fetch("http://photos.example.net/photo?file=vacation.jpg%22); $response_info = $oauth->getLastResponseInfo(); header("Content-Type: {$response_info["content_type"]}"); echo $oauth->getLastResponse();} catch(OAuthException $E) { echo "Exception caught!\n"; echo "Response: ". $E->lastResponse . "\n";}?>
参考
- OAuth::getLastResponse() - 直近のレスポンスを取得する
- OAuth::getLastResponseInfo() - 直近のレスポンスの HTTP 情報を取得する
- OAuth::setToken() - トークンと secret を設定する