session-cache-limiter.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 927c3d9ef797f572473754d0ed8488d34986f0ca Maintainer: hirokawa Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="function.session-cache-limiter" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>session_cache_limiter</refname>
  <refpurpose>現在のキャッシュリミッタを取得または設定する</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>session_cache_limiter</methodname>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>value</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>session_cache_limiter</function> は、
   現在のキャッシュリミッタの名前を返します。
  </para>
  <para>
   キャッシュリミッタは、クライアントに送信されるキャッシュ制御用の
   HTTPヘッダを制御します。これらのヘッダは、ページの内容をクライアントやプロキシがキャッシュ
   する規則を定義します。例えば、キャッシュリミッタを
   <literal>nocache</literal>に設定した場合、クライアント/プロキシのキャッ
   シュは無効になります。しかし、<literal>public</literal>の場合は、
   キャッシュを許可します。<literal>private</literal>と設定すること
   も可能で、この場合、プロキシがキャッシュすることは許可しませんが
   クライアントがキャッシュすることは許可されます。
  </para>
  <para>
   <literal>private</literal>モードにおいて、Expireヘッダがクライア
   ントに送信されます。これは、<productname>Mozilla</productname>
   のようないくつかのブラウザを混乱させます。これを避けるには、
   <literal>private_no_expire</literal>モードを使用してください。
   このモードでは、<literal>Expire</literal>ヘッダはクライアントに送信されません。
  </para>
  <para>
   キャッシュリミッタを <literal>''</literal> にすると、
   キャッシュヘッダの自動送信を完全に無効化します。
  </para>
  <para>
   キャッシュリミッタは、リクエスト開始時に
   <literal>session.cache_limiter</literal>に保存されたデフォルト値
   にリセットされます。つまり、各リクエスト毎に(アウトプットバッファ
   が無効な場合は、<function>session_start</function>がコールされる
   前に) <function>session_cache_limiter</function>をコールする必要
   があります。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>value</parameter></term>
     <listitem>
      <para>
       <parameter>value</parameter>
       が指定され、&null; でない場合、
       現在のキャッシュリミッタは新しい値に変更されます。
      </para>
      <table>
       <title>取り得る値</title>
       <tgroup cols="2">
        <thead>
         <row>
          <entry>値</entry>
          <entry>送信されるヘッダ</entry>
         </row>
        </thead>
        <tbody>
         <row>
          <entry><literal>public</literal></entry>
          <entry>
           <programlisting role="header">
<![CDATA[
Expires: (未来のいつか、session.cache_expires による)
Cache-Control: public, max-age=(未来のいつか、session.cache_expire による)
Last-Modified: (セッションが最後に保存されたときのタイムスタンプ)
]]>
           </programlisting>
          </entry>
         </row>
         <row>
          <entry><literal>private_no_expire</literal></entry>
          <entry>
           <programlisting role="header">
<![CDATA[
Cache-Control: private, max-age=(session.cache_expire ぶんだけ未来)
Last-Modified: (セッションが最後に保存されたときのタイムスタンプ)
]]>
           </programlisting>
          </entry>
         </row>
         <row>
          <entry><literal>private</literal></entry>
          <entry>
           <programlisting role="header">
<![CDATA[
Expires: Thu, 19 Nov 1981 08:52:00 GMT
Cache-Control: private, max-age=(session.cache_expire ぶんだけ未来)
Last-Modified: (セッションが最後に保存されたときのタイムスタンプ)
]]>
           </programlisting>
          </entry>
         </row>
         <row>
          <entry><literal>nocache</literal></entry>
          <entry>
           <programlisting role="header">
<![CDATA[
Expires: Thu, 19 Nov 1981 08:52:00 GMT
Cache-Control: no-store, no-cache, must-revalidate
Pragma: no-cache
]]>
           </programlisting>
          </entry>
         </row>
        </tbody>
       </tgroup>
      </table>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   現在のキャッシュリミッタの名前を返します。
   値の変更に失敗した場合は、&false; を返します。
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>value</parameter> は、nullable になりました。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>session_cache_limiter</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php

/* キャッシュリミッタを'private'に設定する */

session_cache_limiter('private');
$cache_limiter = session_cache_limiter();

echo "The cache limiter is now set to $cache_limiter<br />";
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><link linkend="ini.session.cache-limiter">session.cache_limiter</link></member>
   </simplelist>
  </para>
 </refsect1>

</refentry>
<!-- 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
-->