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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 323384 $ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.session-cache-limiter">
<refnamediv>
<refname>session_cache_limiter</refname>
<refpurpose>Get and/or set the current cache limiter</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>session_cache_limiter</methodname>
<methodparam choice="opt"><type>string</type><parameter>cache_limiter</parameter></methodparam>
</methodsynopsis>
<para>
<function>session_cache_limiter</function> returns the name of the
current cache limiter.
</para>
<para>
The cache limiter defines which cache control HTTP headers are sent to
the client. These headers determine the rules by which the page content
may be cached by the client and intermediate proxies. Setting the cache
limiter to <literal>nocache</literal> disallows any client/proxy caching.
A value of <literal>public</literal> permits caching by proxies and the
client, whereas <literal>private</literal> disallows caching by proxies
and permits the client to cache the contents.
</para>
<para>
In <literal>private</literal> mode, the Expire header sent to the client
may cause confusion for some browsers, including <productname>Mozilla</productname>.
You can avoid this problem by using <literal>private_no_expire</literal> mode. The
<literal>Expire</literal> header is never sent to the client in this mode.
</para>
<para>
Setting the cache limiter to <literal>''</literal> will turn off automatic sending
of cache headers entirely.
</para>
<para>
The cache limiter is reset to the default value stored in
<link linkend="ini.session.cache-limiter">session.cache_limiter</link>
at request startup time. Thus, you need to call
<function>session_cache_limiter</function> for every
request (and before <function>session_start</function> is called).
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>cache_limiter</parameter></term>
<listitem>
<para>
If <parameter>cache_limiter</parameter> is specified, the name of the
current cache limiter is changed to the new value.
</para>
<table>
<title>Possible values</title>
<tgroup cols="2">
<thead>
<row>
<entry>Value</entry>
<entry>Headers sent</entry>
</row>
</thead>
<tbody>
<row>
<entry><literal>public</literal></entry>
<entry>
<programlisting role="header">
<![CDATA[
Expires: (sometime in the future, according session.cache_expire)
Cache-Control: public, max-age=(sometime in the future, according to session.cache_expire)
Last-Modified: (the timestamp of when the session was last saved)
]]>
</programlisting>
</entry>
</row>
<row>
<entry><literal>private_no_expire</literal></entry>
<entry>
<programlisting role="header">
<![CDATA[
Cache-Control: private, max-age=(session.cache_expire in the future), pre-check=(session.cache_expire in the future)
Last-Modified: (the timestamp of when the session was last saved)
]]>
</programlisting>
</entry>
</row>
<row>
<entry><literal>private</literal></entry>
<entry>
<programlisting role="header">
<![CDATA[
Expires: Thu, 19 Nov 1981 08:52:00 GMT
Cache-Control: private, max-age=(session.cache_expire in the future), pre-check=(session.cache_expire in the future)
Last-Modified: (the timestamp of when the session was last saved)
]]>
</programlisting>
</entry>
</row>
<row>
<entry><literal>nocache</literal></entry>
<entry>
<programlisting role="header">
<![CDATA[
Expires: Thu, 19 Nov 1981 08:52:00 GMT
Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0
Pragma: no-cache
]]>
</programlisting>
</entry>
</row>
</tbody>
</tgroup>
</table>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the name of the current cache limiter.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>4.2.0</entry>
<entry>
The <literal>private_no_expire</literal> cache limiter was added.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>session_cache_limiter</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
/* set the cache limiter to 'private' */
session_cache_limiter('private');
$cache_limiter = session_cache_limiter();
echo "The cache limiter is now set to $cache_limiter<br />";
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><link linkend="ini.session.cache-limiter">session.cache_limiter</link></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
-->
|
