reference/wddx/functions/wddx-deserialize.xml
fc74d0ee2da2cc1f5666fc58ccb0437a75b6ce2e
fc74d0ee2da2cc1f5666fc58ccb0437a75b6ce2e
...
...
@@ -3,16 +3,58 @@
3
3
<refentry xml:id="function.wddx-deserialize" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>wddx_deserialize</refname>
6
-
<refpurpose>&Alias; <function>wddx_unserialize</function></refpurpose>
6
+
<refpurpose>Unserializes a WDDX packet</refpurpose>
7
7
</refnamediv>
8
8
9
+
<refsynopsisdiv>
10
+
&warn.removed.function-7-4-0;
11
+
</refsynopsisdiv>
12
+
9
13
<refsect1 role="description">
10
14
&reftitle.description;
11
-
<simpara>
12
-
&info.function.alias;
13
-
<function>wddx_unserialize</function>.
14
-
</simpara>
15
+
<methodsynopsis>
16
+
<type>mixed</type><methodname>wddx_deserialize</methodname>
17
+
<methodparam><type>string</type><parameter>packet</parameter></methodparam>
18
+
</methodsynopsis>
19
+
<para>
20
+
Unserializes a WDDX <parameter>packet</parameter>.
21
+
</para>
22
+
<warning>
23
+
<para>
24
+
Do not pass untrusted user input to <function>wddx_deserialize</function>.
25
+
Unserialization can result in code being loaded and executed due to object
26
+
instantiation and autoloading, and a malicious user may be able to exploit
27
+
this. Use a safe, standard data interchange format such as JSON (via
28
+
<function>json_decode</function> and <function>json_encode</function>) if
29
+
you need to pass serialized data to the user.
30
+
</para>
31
+
</warning>
32
+
</refsect1>
33
+
34
+
<refsect1 role="parameters">
35
+
&reftitle.parameters;
36
+
<para>
37
+
<variablelist>
38
+
<varlistentry>
39
+
<term><parameter>packet</parameter></term>
40
+
<listitem>
41
+
<para>
42
+
A WDDX packet, as a string or stream.
43
+
</para>
44
+
</listitem>
45
+
</varlistentry>
46
+
</variablelist>
47
+
</para>
15
48
</refsect1>
49
+
50
+
<refsect1 role="returnvalues">
51
+
&reftitle.returnvalues;
52
+
<para>
53
+
Returns the deserialized value which can be a string, a number or an
54
+
array. Note that structures are deserialized into associative arrays.
55
+
</para>
56
+
</refsect1>
57
+
16
58
</refentry>
17
59
18
60
<!-- Keep this comment at the end of the file
19
61