« OAuth::getRequestToken
OAuth::setCAPath »

OAuth::setAuthType

(PECL OAuth >= 0.99.1)

OAuth::setAuthType — 認証方式を設定する

説明

public function OAuth::setAuthType(int $auth_type): bool

OAuth パラメータをどこで渡すかを設定します。

パラメータ

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 を返します。

変更履歴

バージョン 説明
PECL oauth 1.0.0 以前は、失敗したときに false ではなく null を返していました。
関連キーワード:
OAuth   auth   type   認証方式   setAuthType   リクエスト   getRequestToken   setCAPath   フラグ   section   優先度   Authorization   ヘッダ   本文   無効   履歴   oauth
関連する関数・ページ:
oauth.setcapath   oauth.setversion   oauth.getcapath   oauth.setnonce   oauth.destruct   oauth.getrequestheader