mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-26 05:48:57 +00:00
151e61773c
Closes GH-236. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351750 c90b9560-bf6c-de11-be94-00142212c4b1
147 lines
3.9 KiB
XML
147 lines
3.9 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.session-cache-expire" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>session_cache_expire</refname>
|
|
<refpurpose>Get and/or set current cache expire</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> 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>value</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
If <parameter>value</parameter> is given and not &null;, the current cache
|
|
expire is replaced with <parameter>value</parameter>.
|
|
</para>
|
|
<para>
|
|
<note>
|
|
<simpara>
|
|
Setting <parameter>value</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.
|
|
On failure to change the value, &false; is returned.
|
|
</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> is nullable now.
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</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
|
|
-->
|