reference/session/functions/session-module-name.xml
151e61773c016edcae8fd4989ad9a86ffd03c283
151e61773c016edcae8fd4989ad9a86ffd03c283
...
...
@@ -1,6 +1,6 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.session-module-name">
3
+
<refentry xml:id="function.session-module-name" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>session_module_name</refname>
6
6
<refpurpose>Get and/or set the current session module</refpurpose>
...
...
@@ -9,12 +9,13 @@
9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
-
<type>string</type><methodname>session_module_name</methodname>
13
-
<methodparam choice="opt"><type>string</type><parameter>module</parameter></methodparam>
12
+
<type class="union"><type>string</type><type>false</type></type><methodname>session_module_name</methodname>
13
+
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>module</parameter><initializer>&null;</initializer></methodparam>
14
14
</methodsynopsis>
15
15
<para>
16
16
<function>session_module_name</function> gets the name of the current
17
-
session module.
17
+
session module, which is also known as
18
+
<link linkend="ini.session.save-handler">session.save_handler</link>.
18
19
</para>
19
20
</refsect1>
20
21
...
...
@@ -26,8 +27,11 @@
26
27
<term><parameter>module</parameter></term>
27
28
<listitem>
28
29
<para>
29
-
If <parameter>module</parameter> is specified, that module will be
30
+
If <parameter>module</parameter> is specified and not &null;, that module will be
30
31
used instead.
32
+
Passing <literal>"user"</literal> to this parameter is forbidden. Instead
33
+
<function>session_set_save_handler</function> has to be called to set a user
34
+
defined session handler.
31
35
</para>
32
36
</listitem>
33
37
</varlistentry>
...
...
@@ -38,12 +42,40 @@
38
42
<refsect1 role="returnvalues">
39
43
&reftitle.returnvalues;
40
44
<para>
41
-
Returns the name of the current session module.
45
+
Returns the name of the current session module, &return.falseforfailure;.
42
46
</para>
43
47
</refsect1>
44
48
45
-
</refentry>
49
+
<refsect1 role="changelog">
50
+
&reftitle.changelog;
51
+
<informaltable>
52
+
<tgroup cols="2">
53
+
<thead>
54
+
<row>
55
+
<entry>&Version;</entry>
56
+
<entry>&Description;</entry>
57
+
</row>
58
+
</thead>
59
+
<tbody>
60
+
<row>
61
+
<entry>8.0.0</entry>
62
+
<entry>
63
+
<parameter>module</parameter> is nullable now.
64
+
</entry>
65
+
</row>
66
+
<row>
67
+
<entry>7.2.0</entry>
68
+
<entry>
69
+
It is now explicitly forbidden to set the module name to
70
+
<literal>"user"</literal>. Formerly, this has been silently ignored.
71
+
</entry>
72
+
</row>
73
+
</tbody>
74
+
</tgroup>
75
+
</informaltable>
76
+
</refsect1>
46
77
78
+
</refentry>
47
79
<!-- Keep this comment at the end of the file
48
80
Local variables:
49
81
mode: sgml
50
82