1
0
mirror of https://github.com/php/doc-ja.git synced 2026-03-25 23:52:16 +01:00
Files
archived-doc-ja/reference/http/request-options.xml
2012-03-12 21:14:58 +00:00

480 lines
14 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 5faa7a6747bca628b3bdcc9f93aec5603b65581f Maintainer: takagi Status: ready -->
<appendix xml:id="http.request.options" xmlns="http://docbook.org/ns/docbook">
<title>HttpRequest クラスおよびリクエスト関数で使用するオプション</title>
<titleabbrev>リクエストのオプション</titleabbrev>
<variablelist xml:id="http.request.options.timeouts">
<title>タイムアウトに関連するオプション</title>
<varlistentry xml:id="http.request.option.timeout">
<term>
timeout (<type>integer</type>)
</term>
<listitem>
<simpara>
リクエスト全体が完了するまでの秒数。
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="http.request.option.connecttimeout">
<term>
connecttimeout (<type>integer</type>)
</term>
<listitem>
<simpara>
名前解決を含む接続にかける秒数。
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="http.request.option.dns-cache-timeout">
<term>
dns_cache_timeout (<type>integer</type>)
</term>
<listitem>
<simpara>
dns キャッシュエントリのタイムアウト秒数。
</simpara>
</listitem>
</varlistentry>
</variablelist>
<variablelist xml:id="http.request.options.urls">
<title>url に関連するオプション</title>
<varlistentry xml:id="http.request.option.url">
<term>
url (<type>string</type>)
</term>
<listitem>
<simpara>
リクエスト url。
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="http.request.option.port">
<term>
port (<type>integer</type>)
</term>
<listitem>
<simpara>
url で指定したものとは別のポートを使用する場合のポート。
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="http.request.option.redirect">
<term>
redirect (<type>integer</type>)
</term>
<listitem>
<simpara>
リダイレクトをどれだけ追いかけるか。デフォルトは 0。
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="http.request.option.unrestrictedauth">
<term>
unrestrictedauth (<type>bool</type>)
</term>
<listitem>
<simpara>
別のホストにリダイレクトする際に認証情報を引き継ぐかどうか。
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
referer (<type>string</type>)
</term>
<listitem>
<simpara>
リファラとして送信する url。
</simpara>
</listitem>
</varlistentry>
</variablelist>
<variablelist xml:id="http.request.options.cookies">
<title>クッキーに関連するオプション</title>
<varlistentry>
<term>
encodecookies (<type>bool</type>)
</term>
<listitem>
<simpara>
独自のクッキーを送信する前に <function>urlencode</function>
するかどうか。
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
cookies (<type>array</type>)
</term>
<listitem>
<simpara>
クッキーの内容を表す <literal>array("cookie" => "value")</literal>
形式の連想配列。
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
cookiestore (<type>string</type>)
</term>
<listitem>
<simpara>
クッキーを保存するファイルへのパス。
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
cookiesession (<type>bool</type>)
</term>
<listitem>
<simpara>
&true; の場合は、cookiestore からセッションクッキーを読み込まない。
</simpara>
</listitem>
</varlistentry>
</variablelist>
<variablelist xml:id="http.request.options.headers">
<title>ヘッダに関連するオプション</title>
<varlistentry>
<term>
useragent (<type>string</type>)
</term>
<listitem>
<simpara>
ユーザーエージェントとして送信する内容。デフォルトは
<literal>PECL::HTTP/x.y.z (PHP/x.y.z)</literal>
送信したくない場合は、明示的に空文字列を設定します。
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
lastmodified (<type>int</type>)
</term>
<listitem>
<simpara>
If-(Un)Modified-Since ヘッダ用のタイムスタンプ。
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
etag (<type>string</type>)
</term>
<listitem>
<simpara>
If-(None-)Match ヘッダ用のクォートした etag。
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
headers (<type>array</type>)
</term>
<listitem>
<simpara>
独自のヘッダを指定する、
<literal>array("header" => "value")</literal>
形式の連想配列。
</simpara>
</listitem>
</varlistentry>
</variablelist>
<variablelist xml:id="http.request.options.auth">
<title>認証に関連するオプション</title>
<varlistentry>
<term>
httpauth (<type>string</type>)
</term>
<listitem>
<simpara>
"user:pass" 形式の http 認証情報。
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
httpauthtype (<type>int</type>)
</term>
<listitem>
<simpara>
<link linkend="http.constants.request.httpauth">HTTP 認証方式の定数</link>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
(<type>array</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
</variablelist>
<variablelist xml:id="http.request.options.proxy">
<title>プロキシに関連するオプション</title>
<varlistentry>
<term>
proxyhost (<type>string</type>)
</term>
<listitem>
<simpara>
"host[:port]" 形式のプロキシホスト。
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
proxyport (<type>int</type>)
</term>
<listitem>
<simpara>
proxyhost で指定したものとは別のポートを使用する場合のプロキシポート。
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
proxytype (<type>int</type>)
</term>
<listitem>
<simpara>
<link linkend="http.constants.request.proxy">HTTP プロキシ形式の定数</link>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
proxyauth (<type>string</type>)
</term>
<listitem>
<simpara>
"user:pass" 形式のプロキシ認証情報。
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
proxyauthtype (<type>int</type>)
</term>
<listitem>
<simpara>
<link linkend="http.constants.request.httpauth">HTTP 認証形式の定数</link>
</simpara>
</listitem>
</varlistentry>
</variablelist>
<variablelist xml:id="http.request.options.transfer">
<title>転送に関連するオプション</title>
<varlistentry>
<term>
compress (<type>bool</type>)
</term>
<listitem>
<simpara>
gzip/deflate エンコードされたレスポンスを受け入れるかどうか。
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
resume (<type>int</type>)
</term>
<listitem>
<simpara>
サーバーがサポートしている場合 (レスポンスコード 206)
に、指定したバイトオフセットからダウンロードを開始する。
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
range (<type>array</type>)
</term>
<listitem>
<simpara>
配列の配列で、それぞれ二つの <type>integer</type> を含み。
ダウンロードする範囲を指定する。
サーバーがサポートしており (レスポンスコード 206)、
resume オプションが空の場合にのみ有効。
</simpara>
</listitem>
</varlistentry>
</variablelist>
<variablelist xml:id="http.request.options.limits">
<title>制限に関連するオプション</title>
<varlistentry>
<term>
maxfilesize (<type>integer</type>)
</term>
<listitem>
<simpara>
ダウンロードできるファイルサイズの最大値。
リクエストされたエンティティのサイズが取得できない場合
(動的なページで分割して転送している場合など)
には無意味。
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
low_speed_limit (<type>int</type>)
</term>
<listitem>
<simpara>
リクエストが成功するために必要な最低限の転送速度。
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
low_speed_time (<type>int</type>)
</term>
<listitem>
<simpara>
リクエストが成功するために、
<literal>low_speed_limit</literal>
以上で転送しなければならない時間。
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
max_send_speed (<type>int</type>)
</term>
<listitem>
<simpara>
最大の送信速度。バイト毎秒。
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
max_recv_speed (<type>int</type>)
</term>
<listitem>
<simpara>
最大の受信速度。バイト毎秒。
</simpara>
</listitem>
</varlistentry>
</variablelist>
<variablelist xml:id="http.request.options.callback">
<title>コールバックオプション</title>
<varlistentry>
<term>onprogress (<type>callable</type>)</term>
<listitem><simpara>進捗状況のコールバック。</simpara></listitem>
</varlistentry>
</variablelist>
<variablelist xml:id="http.request.options.network">
<title>ネットワークオプション</title>
<varlistentry>
<term>interface (<type>string</type>)</term>
<listitem><simpara>送信用のネットワークインターフェイス (ifname、ip あるいは hostname)。</simpara></listitem>
</varlistentry>
<varlistentry>
<term>portrange (<type>array</type>)</term>
<listitem><simpara>二つの整数で指定する、送信用のポートの範囲。</simpara></listitem>
</varlistentry>
</variablelist>
<variablelist xml:id="http.request.options.ssl">
<title>SSL オプション</title>
<varlistentry>
<term>
ssl (<type>array</type>)
</term>
<listitem>
<note>
<simpara>SSL のオプションは、オプション名 "ssl" の配列として指定します。</simpara>
</note>
<variablelist>
<varlistentry>
<term>cert (<type>string</type>)</term>
<listitem><simpara>証明書へのパス。</simpara></listitem>
</varlistentry>
<varlistentry>
<term>certtype (<type>string</type>)</term>
<listitem><simpara>証明書の形式。</simpara></listitem>
</varlistentry>
<varlistentry>
<term>certpasswd (<type>string</type>)</term>
<listitem><simpara>証明書のパスワード。</simpara></listitem>
</varlistentry>
<varlistentry>
<term>key (<type>string</type>)</term>
<listitem><simpara>鍵へのパス。</simpara></listitem>
</varlistentry>
<varlistentry>
<term>keytype (<type>string</type>)</term>
<listitem><simpara>鍵の形式。</simpara></listitem>
</varlistentry>
<varlistentry>
<term>keypasswd (<type>string</type>)</term>
<listitem><simpara>鍵のパスワード。</simpara></listitem>
</varlistentry>
<varlistentry>
<term>engine (<type>string</type>)</term>
<listitem><simpara>使用する ssl エンジン。</simpara></listitem>
</varlistentry>
<varlistentry>
<term>version (<type>int</type>)</term>
<listitem><simpara>使用する ssl バージョン。</simpara></listitem>
</varlistentry>
<varlistentry>
<term>verifypeer (<type>bool</type>)</term>
<listitem><simpara>相手側を検証するかどうか。</simpara></listitem>
</varlistentry>
<varlistentry>
<term>verifyhost (<type>bool</type>)</term>
<listitem><simpara>ホストを検証するかどうか。</simpara></listitem>
</varlistentry>
<varlistentry>
<term>cipher_list (<type>string</type>)</term>
<listitem><simpara>利用できる暗号形式の一覧。</simpara></listitem>
</varlistentry>
<varlistentry>
<term>cainfo (<type>string</type>)</term>
<listitem><simpara></simpara></listitem>
</varlistentry>
<varlistentry>
<term>capath (<type>string</type>)</term>
<listitem><simpara></simpara></listitem>
</varlistentry>
<varlistentry>
<term>random_file (<type>string</type>)</term>
<listitem><simpara></simpara></listitem>
</varlistentry>
<varlistentry>
<term>egdsocket (<type>string</type>)</term>
<listitem><simpara></simpara></listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</appendix>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->