1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/session.xml, last change in rev 1.38 -->
<refentry id='function.session-cache-expire'>
<refnamediv>
<refname>session_cache_expire</refname>
<refpurpose>Return current cache expire</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>session_cache_expire</methodname>
<methodparam choice="opt"><type>int</type><parameter>new_cache_expire</parameter></methodparam>
</methodsynopsis>
<para>
<function>session_cache_expire</function> returns the current setting of
<literal>session.cache_expire</literal>. The value returned should be read
in minutes, defaults to 180. If <parameter>new_cache_expire</parameter>
is given, the current cache expire is replaced with
<parameter>new_cache_expire</parameter>.
</para>
<para>
The cache expire is reset to the default value of 180 stored in
<literal>session.cache_limiter</literal> 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>
<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>
<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>
See also the configuration settings <link linkend="ini.session.cache-expire">
session.cache_expire</link>, <link linkend="ini.session.cache-limiter">
session.cache_limiter</link> and <function>session_cache_limiter</function>.
</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:"../../../../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
-->
|
