OAuth::setAuthType
(PECL OAuth >= 0.99.1)
OAuth::setAuthType — 認証方式を設定する
説明
public OAuth::setAuthType
( int
$auth_type
) : boolOAuth パラメータをどこで渡すかを設定します。
パラメータ
-
auth_type -
auth_typeは、次のフラグ (OAuth 1.0 section 5.2 において優先度の高い順) のいずれかです。-
OAUTH_AUTH_TYPE_AUTHORIZATION - OAuth パラメータを HTTP Authorization ヘッダで渡します。
-
OAUTH_AUTH_TYPE_FORM - OAuth パラメータを HTTP POST リクエストの本文に追加します。
-
OAUTH_AUTH_TYPE_URI - OAuth パラメータをリクエスト URI に追加します。
-
OAUTH_AUTH_TYPE_NONE - 何もなし。
-
返り値
パラメータを正しく設定した場合に TRUE を返します。
それ以外の場合 (無効な auth_type を渡した場合など)
は FALSE を返します。
変更履歴
| バージョン | 説明 |
|---|---|
| 1.0.0 |
以前は、失敗したときに FALSE ではなく NULL を返していました。
|