-
Notifications
You must be signed in to change notification settings - Fork 70
/
tophp.xml
168 lines (157 loc) · 5.55 KB
/
tophp.xml
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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: e9214a2619efc5906fab59cd42fb7404c4dc49a5 Maintainer: sergey Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.mongodb.bson-tophp" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>MongoDB\BSON\toPHP</refname>
<refpurpose>Возвращает PHP-представление значения BSON</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>array</type><type>object</type></type><methodname>MongoDB\BSON\toPHP</methodname>
<methodparam><type>string</type><parameter>bson</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>typeMap</parameter><initializer>array()</initializer></methodparam>
</methodsynopsis>
<para>
Метод десериализует документ BSON (т. е. двоичную строку) в его представление PHP.
Через параметр <parameter>typeMap</parameter> управляют типами PHP,
которые используются для преобразования массивов и документов BSON (как корневых, так и встроенных).
</para>
&mongodb.warning.duplicate-keys;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>bson</parameter> (<type>string</type>)</term>
<listitem>
<para>
Значение BSON для десериализации.
</para>
</listitem>
</varlistentry>
&mongodb.parameter.typeMap;
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Десериализованное значение PHP.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<simplelist>
<member>
Метод выбрасывает исключение
<classname>MongoDB\Driver\Exception\InvalidArgumentException</classname>, если
класс в карте типов не может быть создан или не реализует интерфейс
<interfacename>MongoDB\BSON\Unserializable</interfacename>.
</member>
&mongodb.throws.bson.unexpected;
</simplelist>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>PECL mongodb 1.4.0</entry>
<entry>
<para>
Если входные данные содержат неподдерживаемый устаревший тип BSON,
модуль больше не будет записывать предупреждение в журнал отладки, а вместо этого
создаст объект, представляющий этот тип.
</para>
</entry>
</row>
<row>
<entry>PECL mongodb 1.3.2</entry>
<entry>
<para>
Исключение <classname>MongoDB\Driver\Exception\UnexpectedValueException</classname>
больше не выдаётся, если входные данные содержат неподдерживаемый, устаревший
тип BSON. Такие типы будут игнорироваться (как они были в версиях до
1.3.0), хотя модуль теперь будет записывать предупреждение в журнал отладки
(смотрите: <link linkend="ini.mongodb.debug">mongodb.debug</link>).
</para>
</entry>
</row>
<row>
<entry>PECL mongodb 1.3.0</entry>
<entry>
<para>
Исключение <classname>MongoDB\Driver\Exception\UnexpectedValueException</classname>
выдаётся, если входные данные содержат неподдерживаемый, устаревший тип BSON.
Ранее такие типы игнорировались.
</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Пример использования метода <function>MongoDB\BSON\toPHP</function></title>
<programlisting role="php">
<![CDATA[
<?php
$bson = hex2bin('0e00000010666f6f000100000000');
$value = MongoDB\BSON\toPHP($bson);
var_dump($value);
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
object(stdClass)#1 (1) {
["foo"]=>
int(1)
}
]]>
</screen>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><methodname>MongoDB\BSON\Document::toPHP</methodname></member>
<member><function>MongoDB\BSON\fromPHP</function></member>
<member><link xlink:href="&url.mongodb.docs.bson;">MongoDB BSON</link></member>
<member><xref linkend="mongodb.persistence"/></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
-->