Php/docs/class.oauth

• PHP Manual
• OAuth
• OAuth クラス

(PECL OAuth >= 0.99.1)

はじめに

OAuth 拡張モジュールは、データプロバイダとやりとりするためのシンプルなインターフェイスを提供します。 OAuth HTTP 仕様を用いることで、プライベートなリソースを保護します。

クラス概要

OAuth {

/* プロパティ */

public $debug

public $sslChecks

public $debugInfo

/* メソッド */

public __construct ( string $consumer_key , string $consumer_secret [, string $signature_method = OAUTH_SIG_METHOD_HMACSHA1 [, int $auth_type = 0 ]] )

public __destruct ( ) : void

public disableDebug ( ) : bool

public disableRedirects ( ) : bool

public disableSSLChecks ( ) : bool

public enableDebug ( ) : bool

public enableRedirects ( ) : bool

public enableSSLChecks ( ) : bool

public fetch ( string $protected_resource_url [, array $extra_parameters [, string $http_method [, array $http_headers ]]] ) : mixed

public generateSignature ( string $http_method , string $url [, mixed $extra_parameters ] ) : string|false

public getAccessToken ( string $access_token_url [, string $verifier_token [, string $http_method ]] ) : array

public getCAPath ( ) : array

public getLastResponse ( ) : string

public getLastResponseHeaders ( ) : string|false

public getLastResponseInfo ( ) : array

public getRequestHeader ( string $http_method , string $url [, mixed $extra_parameters ] ) : string|false

public getRequestToken ( string $request_token_url [, string $callback_url [, string $http_method ]] ) : array

public setAuthType ( int $auth_type ) : bool

public setCAPath ([ string $ca_path [, string $ca_info ]] ) : mixed

public setNonce ( string $nonce ) : mixed

public setRequestEngine ( int $reqengine ) : void

public setRSACertificate ( string $cert ) : mixed

public setSSLChecks ( int $sslcheck ) : bool

public setTimestamp ( string $timestamp ) : mixed

public setToken ( string $token , string $token_secret ) : bool

public setVersion ( string $version ) : bool

}

プロパティ

debug

sslChecks

debugInfo

目次

• OAuth::__construct — 新しい OAuth オブジェクトを作成する
• OAuth::__destruct — デストラクタ
• OAuth::disableDebug — デバッグを無効にする
• OAuth::disableRedirects — リダイレクトを無効にする
• OAuth::disableSSLChecks — SSL チェックを無効にする
• OAuth::enableDebug — デバッグを有効にする
• OAuth::enableRedirects — リダイレクトを有効にする
• OAuth::enableSSLChecks — SSL チェックを有効にする
• OAuth::fetch — OAuth で保護されたリソースを取得する
• OAuth::generateSignature — シグネチャを生成する
• OAuth::getAccessToken — アクセストークンを取得する
• OAuth::getCAPath — CA 情報を取得する
• OAuth::getLastResponse — 直近のレスポンスを取得する
• OAuth::getLastResponseHeaders — 最後のレスポンスのヘッダを取得する
• OAuth::getLastResponseInfo — 直近のレスポンスの HTTP 情報を取得する
• OAuth::getRequestHeader — OAuth ヘッダ文字列シグネチャを生成する
• OAuth::getRequestToken — リクエストトークンを取得する
• OAuth::setAuthType — 認証方式を設定する
• OAuth::setCAPath — CA パスおよび情報を設定する
• OAuth::setNonce — 続くリクエスト用のノンスを設定する
• OAuth::setRequestEngine — setRequestEngine
• OAuth::setRSACertificate — RSA 証明書を設定する
• OAuth::setSSLChecks — リクエストに固有の SSL チェックを調整する
• OAuth::setTimestamp — タイムスタンプを設定する
• OAuth::setToken — トークンと secret を設定する
• OAuth::setVersion — OAuth のバージョンを設定する