reference/session/functions/session-module-name.xml
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,8 +9,8 @@
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
...
...
@@ -27,10 +27,10 @@
27
27
<term><parameter>module</parameter></term>
28
28
<listitem>
29
29
<para>
30
-
If <parameter>module</parameter> is specified, that module will be
30
+
If <parameter>module</parameter> is specified and not &null;, that module will be
31
31
used instead.
32
32
Passing <literal>"user"</literal> to this parameter is forbidden. Instead
33
-
<function>set_set_save_handler</function> has to be called to set a user
33
+
<function>session_set_save_handler</function> has to be called to set a user
34
34
defined session handler.
35
35
</para>
36
36
</listitem>
...
...
@@ -42,7 +42,7 @@
42
42
<refsect1 role="returnvalues">
43
43
&reftitle.returnvalues;
44
44
<para>
45
-
Returns the name of the current session module.
45
+
Returns the name of the current session module, &return.falseforfailure;.
46
46
</para>
47
47
</refsect1>
48
48

...
...
@@ -58,6 +58,12 @@
58
58
</thead>
59
59
<tbody>
60
60
<row>
61
+
<entry>8.0.0</entry>
62
+
<entry>
63
+
<parameter>module</parameter> is nullable now.
64
+
</entry>
65
+
</row>
66
+
<row>
61
67
<entry>7.2.0</entry>
62
68
<entry>
63
69
It is now explicitly forbidden to set the module name to
...
...
@@ -70,7 +76,6 @@
70
76
</refsect1>
71
77

72
78
</refentry>
73
-

74
79
<!-- Keep this comment at the end of the file
75
80
Local variables:
76
81
mode: sgml
77
82