session-cache-expire.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 151e61773c016edcae8fd4989ad9a86ffd03c283 Maintainer: lex Status: ready -->
<!-- Reviewed: no -->

<refentry xml:id="function.session-cache-expire" xmlns="http://docbook.org/ns/docbook">
 <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>
   Срок действия сбрасывается до значения по умолчанию (180), хранящегося в
   <link linkend="ini.session.cache-expire">session.cache_expire</link>
   во время запроса. Таким образом,
   нужно вызывать <function>session_cache_expire</function> для
   каждого запроса (и до вызова <function>session_start</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>
         Настройка <parameter>value</parameter> имеет значение только, если
         для <literal>session.cache_limiter</literal> установлено значение,
         <emphasis>отличное</emphasis> от <literal>nocache</literal>.
        </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> может принимать значение &null;.
      </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

/* установить ограничитель кеша на 'private' */

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

/* установить время жизни на 30 минут */
session_cache_expire(30);
$cache_expire = session_cache_expire();

/* старт сессии */

session_start();

echo "Ограничитель кеша теперь равен $cache_limiter<br />";
echo "Закешированные страницы сессии истекают через $cache_expire минут";
?>
]]>
    </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
-->