HttpRequest クラスおよびリクエスト関数で使用するオプション

タイムアウトに関連するオプション
timeout (integer)
リクエスト全体が完了するまでの秒数。
connecttimeout (integer)
名前解決を含む接続にかける秒数。
dns_cache_timeout (integer)
dns キャッシュエントリのタイムアウト秒数。
url に関連するオプション
url (string)
リクエスト url。
port (integer)
url で指定したものとは別のポートを使用する場合のポート。
redirect (integer)
リダイレクトをどれだけ追いかけるか。デフォルトは 0。
unrestrictedauth (bool)
別のホストにリダイレクトする際に認証情報を引き継ぐかどうか。
referer (string)
リファラとして送信する url。
クッキーに関連するオプション
encodecookies (bool)
独自のクッキーを送信する前に urlencode() するかどうか。
cookies (array)
クッキーの内容を表す array("cookie" => "value") 形式の連想配列。
cookiestore (string)
クッキーを保存するファイルへのパス。
cookiesession (bool)
TRUE の場合は、cookiestore からセッションクッキーを読み込まない。
ヘッダに関連するオプション
useragent (string)
ユーザーエージェントとして送信する内容。デフォルトは PECL::HTTP/x.y.z (PHP/x.y.z)。 送信したくない場合は、明示的に空文字列を設定します。
lastmodified (int)
If-(Un)Modified-Since ヘッダ用のタイムスタンプ。
etag (string)
If-(None-)Match ヘッダ用のクォートした etag。
headers (array)
独自のヘッダを指定する、 array("header" => "value") 形式の連想配列。
認証に関連するオプション
httpauth (string)
"user:pass" 形式の http 認証情報。
httpauthtype (int)
HTTP 認証方式の定数
(array)
プロキシに関連するオプション
proxyhost (string)
"host[:port]" 形式のプロキシホスト。
proxyport (int)
proxyhost で指定したものとは別のポートを使用する場合のプロキシポート。
proxytype (int)
HTTP プロキシ形式の定数
proxyauth (string)
"user:pass" 形式のプロキシ認証情報。
proxyauthtype (int)
HTTP 認証形式の定数
転送に関連するオプション
compress (bool)
gzip/deflate エンコードされたレスポンスを受け入れるかどうか。
resume (int)
サーバーがサポートしている場合 (レスポンスコード 206) に、指定したバイトオフセットからダウンロードを開始する。
range (array)
配列の配列で、それぞれ二つの integer を含み。 ダウンロードする範囲を指定する。 サーバーがサポートしており (レスポンスコード 206)、 resume オプションが空の場合にのみ有効。
制限に関連するオプション
maxfilesize (integer)
ダウンロードできるファイルサイズの最大値。 リクエストされたエンティティのサイズが取得できない場合 (動的なページで分割して転送している場合など) には無意味。
low_speed_limit (int)
リクエストが成功するために必要な最低限の転送速度。
low_speed_time (int)
リクエストが成功するために、 low_speed_limit 以上で転送しなければならない時間。
max_send_speed (int)
最大の送信速度。バイト毎秒。
max_recv_speed (int)
最大の受信速度。バイト毎秒。
コールバックオプション
onprogress (callable)
進捗状況のコールバック。
ネットワークオプション
interface (string)
送信用のネットワークインターフェイス (ifname、ip あるいは hostname)。
portrange (array)
二つの整数で指定する、送信用のポートの範囲。
SSL オプション
ssl (array)

注意: SSL のオプションは、オプション名 "ssl" の配列として指定します。

cert (string)
証明書へのパス。
certtype (string)
証明書の形式。
certpasswd (string)
証明書のパスワード。
key (string)
鍵へのパス。
keytype (string)
鍵の形式。
keypasswd (string)
鍵のパスワード。
engine (string)
使用する ssl エンジン。
version (int)
使用する ssl バージョン。
verifypeer (bool)
相手側を検証するかどうか。
verifyhost (bool)
ホストを検証するかどうか。
cipher_list (string)
利用できる暗号形式の一覧。
cainfo (string)
capath (string)
random_file (string)
egdsocket (string)
add a note add a note

User Contributed Notes 2 notes

up
1
sandeepone at gmail dot com
2 years ago
If someone looking how to use in OOP's context:

$options = array(
                        'useragent'      => "Firefox (+http://www.firefox.org)", // who am i
                        'connecttimeout' => 120, // timeout on connect
                        'timeout'          => 120, // timeout on response
                        'redirect'          => 10, // stop after 10 redirects
                        'referer'           => "http://www.google.com"
                );

$request = new HttpRequest('http://example.com');
$request->setOptions($options);
$request->send();
up
1
dav7 dot net at php (reverse)
6 years ago
If anyone doesn't understand the purpose of these values and is scratching their head, they're all array indexes, and are used as the $option parameter to the various HTTP functions documented in this section. For example:

<?php
    $body
= http_get('http://example.com/private_area/', array(httpauth => 'username:password'));
    print
$body;
?>

This only had me "...huh?!" for a little while, but might have others confused for longer as the fact that these are what they are isn't clearly printed anywhere... to find out that these did what they say they do was a guessing game for me even.

-dav7
To Top