reference/session/functions/session-encode.xml
35b95a56ccc03b66af7117fc815ac7881e2e0ad3
...
...
@@ -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-encode">
3
+
<refentry xml:id="function.session-encode" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>session_encode</refname>
6
6
<refpurpose>Encodes the current session data as a session encoded string</refpurpose>
...
...
@@ -9,7 +9,7 @@
9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
-
<type>string</type><methodname>session_encode</methodname>
12
+
<type class="union"><type>string</type><type>false</type></type><methodname>session_encode</methodname>
13
13
<void/>
14
14
</methodsynopsis>
15
15
<para>
...
...
@@ -17,15 +17,20 @@
17
17
contents of the current session data stored in the $_SESSION superglobal.
18
18
</para>
19
19
<para>
20
-
Please note, the serialization method is not the same as <function>serialize</function>.
21
-
The serialization method is internal to PHP and can be set using <link linkend="ini.session.serialize-handler">session.serialize_handler</link>.
20
+
By default, the serialization method used is internal to PHP, and is not the same as <function>serialize</function>.
21
+
The serialization method can be set using <link linkend="ini.session.serialize-handler">session.serialize_handler</link>.
22
22
</para>
23
23
</refsect1>
24
24

25
+
<refsect1 role="parameters">
26
+
&reftitle.parameters;
27
+
&no.function.parameters;
28
+
</refsect1>
29
+

25
30
<refsect1 role="returnvalues">
26
31
&reftitle.returnvalues;
27
32
<para>
28
-
Returns the contents of the current session encoded.
33
+
Returns the contents of the current session encoded, &return.falseforfailure;.
29
34
</para>
30
35
</refsect1>
31
36

...
...
@@ -33,7 +38,7 @@
33
38
&reftitle.notes;
34
39
<warning>
35
40
<para>
36
-
Must call <function>session_start</function> before using <function>session_decode</function>.
41
+
Must call <function>session_start</function> before using <function>session_encode</function>.
37
42
</para>
38
43
</warning>
39
44
</refsect1>
...
...
@@ -49,7 +54,6 @@
49
54
</refsect1>
50
55

51
56
</refentry>
52
-

53
57
<!-- Keep this comment at the end of the file
54
58
Local variables:
55
59
mode: sgml
56
60