|
|
@@ -1,6 +1,6 @@
|
|
|
<?xml version="1.0" encoding="UTF-8"?>
|
|
|
<!-- Reviewed: no -->
|
|
|
-<!-- EN-Revision: 22743 -->
|
|
|
+<!-- EN-Revision: 22744 -->
|
|
|
<sect1 id="zend.http.cookies">
|
|
|
<title>Zend_Http_Cookie および Zend_Http_CookieJar</title>
|
|
|
|
|
|
@@ -39,7 +39,7 @@
|
|
|
<listitem>
|
|
|
<para>
|
|
|
コンストラクタで以下のような構文を使用します。
|
|
|
- <code>new <classname>Zend_Http_Cookie</classname>(string $name, string $value, string $domain, [int $expires, [string $path, [boolean $secure]]]);</code>
|
|
|
+ <command>new <classname>Zend_Http_Cookie</classname>(string $name, string $value, string $domain, [int $expires, [string $path, [boolean $secure]]]);</command>
|
|
|
</para>
|
|
|
<itemizedlist>
|
|
|
<listitem>
|
|
|
@@ -59,19 +59,19 @@
|
|
|
</listitem>
|
|
|
<listitem>
|
|
|
<para>
|
|
|
- <code>$expires</code>: クッキーの有効期限を表す UNIX タイムスタンプ (オプション。デフォルトは <constant>NULL</constant>)。
|
|
|
+ <code>$expires</code>: クッキーの有効期限を表す UNIX タイムスタンプ (任意。既定値は <constant>NULL</constant>)。
|
|
|
設定しなかった場合は、有効期限なしの 'セッションクッキー' として扱われます。
|
|
|
</para>
|
|
|
</listitem>
|
|
|
<listitem>
|
|
|
<para>
|
|
|
- <code>$path</code>: クッキーのパス。たとえば '/foo/bar/' (オプション。デフォルトは '/')
|
|
|
+ <code>$path</code>: クッキーのパス。たとえば '/foo/bar/' (任意。既定値は '/')
|
|
|
</para>
|
|
|
</listitem>
|
|
|
<listitem>
|
|
|
<para>
|
|
|
<code>$secure</code>: クッキーの送信をセキュア接続 (<acronym>HTTPS</acronym>)
|
|
|
- 時に限るかどうか (オプション。デフォルトは <constant>FALSE</constant>)
|
|
|
+ 時に限るかどうか (任意。既定値は <constant>FALSE</constant>)
|
|
|
</para>
|
|
|
</listitem>
|
|
|
</itemizedlist>
|
|
|
@@ -85,26 +85,29 @@
|
|
|
クッキーのドメインとパスを設定するための参照 <acronym>URI</acronym> を指定する必要があります。
|
|
|
</para>
|
|
|
<para>
|
|
|
- The <code>fromString</code> method accepts the following parameters:
|
|
|
+ <methodname>fromString()</methodname> メソッドでは下記のパラメータを受け付けます。
|
|
|
</para>
|
|
|
<itemizedlist>
|
|
|
<listitem>
|
|
|
<para>
|
|
|
- <varname>$cookieStr</varname>: a cookie string as represented in the
|
|
|
- 'Set-Cookie' <acronym>HTTP</acronym> response header or 'Cookie'
|
|
|
- <acronym>HTTP</acronym> request header (required)
|
|
|
+ <varname>$cookieStr</varname>:
|
|
|
+ 'Set-Cookie' <acronym>HTTP</acronym> レスポンス・ヘッダや、必須の
|
|
|
+ 'Cookie' <acronym>HTTP</acronym> リクエスト・ヘッダで表現されるようなクッキー文字列。
|
|
|
</para>
|
|
|
</listitem>
|
|
|
<listitem>
|
|
|
<para>
|
|
|
- <varname>$refUri</varname>: a reference <acronym>URI</acronym> according to which the cookie's domain and path
|
|
|
- will be set. (optional, defaults to parsing the value from the $cookieStr)
|
|
|
+ <varname>$refUri</varname>:
|
|
|
+ クッキーのドメインとパスがセットされる参照 <acronym>URI</acronym>。
|
|
|
+ (任意。既定値では $cookieStr から値をパースします)
|
|
|
</para>
|
|
|
</listitem>
|
|
|
<listitem>
|
|
|
<para>
|
|
|
- <varname>$encodeValue</varname>: If the value should be passed through urldecode. Also effects the cookie's
|
|
|
- behavior when being converted back to a cookie string. (optional, defaults to true)
|
|
|
+ <varname>$encodeValue</varname>:
|
|
|
+ 値が urldecode を介して渡されるべきかどうか。
|
|
|
+ クッキー文字列に変換される際に、クッキーのふるまいにも影響します。
|
|
|
+ (任意。既定値は true)
|
|
|
</para>
|
|
|
</listitem>
|
|
|
</itemizedlist>
|
|
|
@@ -176,27 +179,27 @@ echo $cookie;
|
|
|
<itemizedlist>
|
|
|
<listitem>
|
|
|
<para>
|
|
|
- <code>string getName()</code>: クッキーの名前を取得します。
|
|
|
+ <methodname>getName()</methodname>: クッキーの名前を取得します。
|
|
|
</para>
|
|
|
</listitem>
|
|
|
<listitem>
|
|
|
<para>
|
|
|
- <code>string getValue()</code>: デコードされたクッキーの値を取得します。
|
|
|
+ <methodname>getValue()</methodname>: デコードされたクッキーの値を取得します。
|
|
|
</para>
|
|
|
</listitem>
|
|
|
<listitem>
|
|
|
<para>
|
|
|
- <code>string getDomain()</code>: クッキーのドメインを取得します。
|
|
|
+ <methodname>getDomain()</methodname>: クッキーのドメインを取得します。
|
|
|
</para>
|
|
|
</listitem>
|
|
|
<listitem>
|
|
|
<para>
|
|
|
- <code>string getPath()</code>: クッキーのパスを取得します。デフォルトは '/' です。
|
|
|
+ <methodname>getPath()</methodname>: クッキーのパスを取得します。既定値は '/' です。
|
|
|
</para>
|
|
|
</listitem>
|
|
|
<listitem>
|
|
|
<para>
|
|
|
- <code>int getExpiryTime()</code>: クッキーの有効期限を UNIX タイムスタンプで取得します。
|
|
|
+ <methodname>getExpiryTime()</methodname>: クッキーの有効期限を UNIX タイムスタンプで取得します。
|
|
|
設定されていない場合は <constant>NULL</constant> を返します。
|
|
|
</para>
|
|
|
</listitem>
|
|
|
@@ -207,20 +210,20 @@ echo $cookie;
|
|
|
<itemizedlist>
|
|
|
<listitem>
|
|
|
<para>
|
|
|
- <code>boolean isSecure()</code>: クッキーの送信がセキュア接続に限定されているかどうかを調べます。
|
|
|
+ <methodname>isSecure()</methodname>: クッキーの送信がセキュア接続に限定されているかどうかを調べます。
|
|
|
要するに、もし <constant>TRUE</constant> ならそのクッキーは <acronym>HTTPS</acronym> でしか送信されないということです。
|
|
|
</para>
|
|
|
</listitem>
|
|
|
<listitem>
|
|
|
<para>
|
|
|
- <code>boolean isExpired(int $time = null)</code>: クッキーが有効期限切れになっているかどうかを調べます。
|
|
|
+ <methodname>isExpired(int $time = null)</methodname>: クッキーが有効期限切れになっているかどうかを調べます。
|
|
|
有効期限が設定されていない場合は、常に <constant>TRUE</constant> を返します。$time を指定すると、
|
|
|
その時刻の時点で有効期限切れになるのかどうかを調べます。
|
|
|
</para>
|
|
|
</listitem>
|
|
|
<listitem>
|
|
|
<para>
|
|
|
- <code>boolean isSessionCookie()</code>: クッキーが "セッションクッキー"、
|
|
|
+ <methodname>isSessionCookie()</methodname>: クッキーが "セッションクッキー"、
|
|
|
すなわち有効期限を持たないクッキー (セッション終了時に無効になるクッキー)
|
|
|
であるかどうかを調べます。
|
|
|
</para>
|
|
|
@@ -267,11 +270,11 @@ echo ($cookie->isSessionCookie() ? 'Yes' : 'No');
|
|
|
このメソッドを使用して、送ろうとしている <acronym>HTTP</acronym> リクエストに当てはまるクッキーであるかどうかを調べます。
|
|
|
その結果によって、クッキーをこのリクエストで送信するかどうかが決まります。
|
|
|
メソッドの構文やパラメータの内容は以下のとおりです。
|
|
|
- <code>boolean Zend_Http_Cookie->match(mixed $uri, [boolean $matchSessionCookies, [int $now]]);</code>
|
|
|
+ <command>Zend_Http_Cookie->match(mixed $uri, [boolean $matchSessionCookies, [int $now]]);</command>
|
|
|
<itemizedlist>
|
|
|
<listitem>
|
|
|
<para>
|
|
|
- <code>mixed $uri</code>: <classname>Zend_Uri_Http</classname> オブジェクトで、
|
|
|
+ <varname>$uri</varname>: <classname>Zend_Uri_Http</classname> オブジェクトで、
|
|
|
ドメインやパスのチェックに使用します。オプションとして、
|
|
|
正しい形式の <acronym>URL</acronym> を文字列で渡すこともできます。
|
|
|
指定した <acronym>URL</acronym> のスキーム (<acronym>HTTP</acronym> あるいは <acronym>HTTPS</acronym>)、
|
|
|
@@ -280,16 +283,16 @@ echo ($cookie->isSessionCookie() ? 'Yes' : 'No');
|
|
|
</listitem>
|
|
|
<listitem>
|
|
|
<para>
|
|
|
- <code>boolean $matchSessionCookies</code>:
|
|
|
+ <varname>$matchSessionCookies</varname>:
|
|
|
セッションクッキーをマッチの対象にするかどうか。
|
|
|
- デフォルトは <constant>TRUE</constant> です。<constant>FALSE</constant> に設定すると、
|
|
|
+ 既定値は <constant>TRUE</constant> です。<constant>FALSE</constant> に設定すると、
|
|
|
有効期限の設定されていないクッキーはマッチしません。
|
|
|
</para>
|
|
|
</listitem>
|
|
|
<listitem>
|
|
|
<para>
|
|
|
- <code>int $now</code>: クッキーの有効期限をチェックする基準となる時刻
|
|
|
- (UNIX タイムスタンプ形式)。指定しない場合のデフォルトは、現在時刻です。
|
|
|
+ <varname>$now</varname>: クッキーの有効期限をチェックする基準となる時刻
|
|
|
+ (UNIX タイムスタンプ形式)。指定しない場合の既定値は、現在時刻です。
|
|
|
</para>
|
|
|
</listitem>
|
|
|
</itemizedlist>
|
|
|
@@ -455,7 +458,7 @@ $cookie->match('http://www.example.com/', true, time() + (3 * 3600));
|
|
|
$uri は文字列か <classname>Zend_Uri_Http</classname> オブジェクトで、<acronym>URI</acronym> を表します。
|
|
|
$cookie_name はクッキー名を表す文字列です。
|
|
|
$ret_as は先ほど説明したように返り値の型を指定します。
|
|
|
- $ret_type はオプションで、デフォルトは COOKIE_OBJECT です。
|
|
|
+ $ret_type はオプションで、既定値は COOKIE_OBJECT です。
|
|
|
</para>
|
|
|
</listitem>
|
|
|
<listitem>
|
|
|
@@ -463,7 +466,7 @@ $cookie->match('http://www.example.com/', true, time() + (3 * 3600));
|
|
|
<classname>Zend_Http_CookieJar->getAllCookies($ret_as)</classname>:
|
|
|
ジャーからすべてのクッキーを取得します。
|
|
|
$ret_as は先ほど説明したように返り値の型を指定します。
|
|
|
- 指定しなかった場合の $ret_type のデフォルトは、COOKIE_OBJECT となります。
|
|
|
+ 指定しなかった場合の $ret_type の既定値は、COOKIE_OBJECT となります。
|
|
|
</para>
|
|
|
</listitem>
|
|
|
<listitem>
|
|
|
@@ -483,14 +486,14 @@ $cookie->match('http://www.example.com/', true, time() + (3 * 3600));
|
|
|
<code>$matchSessionCookies</code> は boolean 値で、
|
|
|
セッションクッキーを含めるかどうかを指定します。
|
|
|
セッションクッキーとは、有効期限が指定されていないクッキーのことです。
|
|
|
- デフォルトは <constant>TRUE</constant> です。
|
|
|
+ 既定値は <constant>TRUE</constant> です。
|
|
|
</para>
|
|
|
</listitem>
|
|
|
<listitem>
|
|
|
<para>
|
|
|
<code>$ret_as</code>
|
|
|
は、先ほど説明したように返り値の型を指定します。
|
|
|
- 指定しなかった場合のデフォルトは COOKIE_OBJECT です。
|
|
|
+ 指定しなかった場合の既定値は COOKIE_OBJECT です。
|
|
|
</para>
|
|
|
</listitem>
|
|
|
<listitem>
|
|
|
@@ -498,7 +501,7 @@ $cookie->match('http://www.example.com/', true, time() + (3 * 3600));
|
|
|
<code>$now</code> は整数値で表した UNIX タイムスタンプで、
|
|
|
これを "現在時刻" として扱います。
|
|
|
有効期限がこの時刻より前に設定されているクッキーはマッチしません。
|
|
|
- 指定しなかった場合のデフォルト値は、現在時刻です。
|
|
|
+ 指定しなかった場合の既定値は、現在時刻です。
|
|
|
</para>
|
|
|
</listitem>
|
|
|
</itemizedlist>
|
yoshida@zend.co.jp