reference/session/functions/session-id.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-id">
3
+
<refentry xml:id="function.session-id" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>session_id</refname>
6
6
<refpurpose>Get and/or set the current session id</refpurpose>
...
...
@@ -8,8 +8,8 @@
8
8
<refsect1 role="description">
9
9
&reftitle.description;
10
10
<methodsynopsis>
11
-
<type>string</type><methodname>session_id</methodname>
12
-
<methodparam choice="opt"><type>string</type><parameter>id</parameter></methodparam>
11
+
<type class="union"><type>string</type><type>false</type></type><methodname>session_id</methodname>
12
+
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>id</parameter><initializer>&null;</initializer></methodparam>
13
13
</methodsynopsis>
14
14
<para>
15
15
<function>session_id</function> is used to get or set the session id for
...
...
@@ -31,7 +31,7 @@
31
31
<term><parameter>id</parameter></term>
32
32
<listitem>
33
33
<para>
34
-
If <parameter>id</parameter> is specified, it will replace the current
34
+
If <parameter>id</parameter> is specified and not &null;, it will replace the current
35
35
session id. <function>session_id</function> needs to be called before
36
36
<function>session_start</function> for that purpose. Depending on the
37
37
session handler, not all characters are allowed within the session id.
...
...
@@ -58,10 +58,33 @@
58
58
<function>session_id</function> returns the session id for the current
59
59
session or the empty string (<literal>""</literal>) if there is no current
60
60
session (no current session id exists).
61
+
On failure, &false; is returned.
61
62
</para>
62
63
</refsect1>
63
64

64
-
<refsect1 role="seealso">
65
+
<refsect1 role="changelog">
66
+
&reftitle.changelog;
67
+
<informaltable>
68
+
<tgroup cols="2">
69
+
<thead>
70
+
<row>
71
+
<entry>&Version;</entry>
72
+
<entry>&Description;</entry>
73
+
</row>
74
+
</thead>
75
+
<tbody>
76
+
<row>
77
+
<entry>8.0.0</entry>
78
+
<entry>
79
+
<parameter>id</parameter> is nullable now.
80
+
</entry>
81
+
</row>
82
+
</tbody>
83
+
</tgroup>
84
+
</informaltable>
85
+
</refsect1>
86
+

87
+
<refsect1 role="seealso">
65
88
&reftitle.seealso;
66
89
<para>
67
90
<simplelist>
...
...
@@ -75,8 +98,6 @@
75
98
</para>
76
99
</refsect1>
77
100
</refentry>
78
-

79
-

80
101
<!-- Keep this comment at the end of the file
81
102
Local variables:
82
103
mode: sgml
83
104