session-cache-expire.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 151e61773c016edcae8fd4989ad9a86ffd03c283 Maintainer: hirokawa Status: ready -->
<!-- CREDITS: shimooka,mumumu -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id='function.session-cache-expire'>
 <refnamediv>
  <refname>session_cache_expire</refname>
  <refpurpose>現在のキャッシュの有効期限を取得/設定する</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>int</type><type>false</type></type><methodname>session_cache_expire</methodname>
   <methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>value</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>session_cache_expire</function> は現在の
   <literal>session.cache_expire</literal> の設定を返します。
  </para>
  <para>
   リクエストがあった時点で、キャッシュの有効期限は
   <link linkend="ini.session.cache-expire">session.cache_expire</link>
   で設定されたデフォルト値にリセットされます。
   そのため、すべてのリクエストにおいて
   (そして<function>session_start</function> をコールする前に)
   <function>session_cache_expire</function> をコールする必要があります。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>value</parameter></term>
     <listitem>
      <para>
       <parameter>value</parameter> が指定され、&null; でない場合、
       現在のキャッシュの有効期限は、
       <parameter>value</parameter> で置換されます。
      </para>
      <para>
       <note>
        <simpara>
         <literal>session.cache_limiter</literal>が
         <literal>nocache</literal><emphasis>以外の</emphasis>値にセットされている場合にのみ
         <parameter>value</parameter>が有効となります。
        </simpara>
       </note>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <literal>session.cache_expire</literal> の現在の設定を返します。
   戻り値は分単位で、デフォルトは 180 です。
   値の変更に失敗した場合は、&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_expire</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php

/* set the cache limiter to 'private' */

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

/* set the cache expire to 30 minutes */
session_cache_expire(30);
$cache_expire = session_cache_expire();

/* start the session */

session_start();

echo "The cache limiter is now set to $cache_limiter<br />";
echo "The cached session pages expire after $cache_expire minutes";
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><link linkend="ini.session.cache-expire">session.cache_expire</link></member>
    <member><link linkend="ini.session.cache-limiter">session.cache_limiter</link></member>
    <member><function>session_cache_limiter</function></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
-->