php-doc-en/reference/session/functions/session-cache-expire.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id='function.session-cache-expire'>
 <refnamediv>
  <refname>session_cache_expire</refname>
  <refpurpose>Return current cache expire</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>session_cache_expire</methodname>
   <methodparam choice="opt"><type>string</type><parameter>new_cache_expire</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>session_cache_expire</function> returns the current setting of
   <literal>session.cache_expire</literal>. 
  </para>
  <para>
   The cache expire is reset to the default value of 180 stored in
   <link linkend="ini.session.cache-expire">session.cache_expire</link>
   at request startup time. Thus,
   you need to call <function>session_cache_expire</function> for every
   request (and before <function>session_start</function> is called).
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>new_cache_expire</parameter></term>
     <listitem>
      <para>
       If <parameter>new_cache_expire</parameter> is given, the current cache
       expire is replaced with <parameter>new_cache_expire</parameter>.
      </para>
      <para>
       <note>
        <simpara>
         Setting <parameter>new_cache_expire</parameter> is of value only, if
         <literal>session.cache_limiter</literal> is set to a value
         <emphasis>different</emphasis> from <literal>nocache</literal>.
        </simpara>
       </note>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the current setting of <literal>session.cache_expire</literal>.
   The value returned should be read in minutes, defaults to 180. 
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>session_cache_expire</function> example</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
-->