1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="mongodb-bson-document.tophp" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>MongoDB\BSON\Document::toPHP</refname>
<refpurpose>Returns the PHP representation of the BSON document</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>final</modifier> <modifier>public</modifier> <type class="union"><type>array</type><type>object</type></type><methodname>MongoDB\BSON\Document::toPHP</methodname>
<methodparam choice="opt"><type class="union"><type>array</type><type>null</type></type><parameter>typeMap</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Unserializes the BSON document to its PHP representation. The
<parameter>typeMap</parameter> paramater may be used to control the PHP types
used for converting BSON arrays and documents (both root and embedded).
</para>
&mongodb.warning.duplicate-keys;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
&mongodb.parameter.typeMap;
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The decoded PHP value.
</para>
<note>
<simpara>
When encountering a value encoded as 64-bit integer in the BSON document,
the return value of this method will be a
<classname>MongoDB\BSON\Int64</classname> instance.
</simpara>
</note>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<simplelist>
<member>
Throws
<classname>MongoDB\Driver\Exception\InvalidArgumentException</classname> if
a class in the type map cannot be instantiated or does not implement
<interfacename>MongoDB\BSON\Unserializable</interfacename>.
</member>
</simplelist>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>MongoDB\BSON\toPHP</function></member>
<member><link xlink:href="&url.mongodb.docs.bson;">BSON Types</link></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|
