-
Notifications
You must be signed in to change notification settings - Fork 76
/
Copy pathtorelaxedextendedjson.xml
104 lines (95 loc) · 3.69 KB
/
torelaxedextendedjson.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
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 3c84b0297195da8c0c2dad2d33f2c143dd3421b0 Maintainer: malferov Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="mongodb-bson-packedarray.torelaxedextendedjson" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>MongoDB\BSON\PackedArray::toRelaxedExtendedJSON</refname>
<refpurpose>Возвращает представление BSON-массива в слабом расширенном JSON-формате</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>final</modifier> <modifier>public</modifier> <type>string</type><methodname>MongoDB\BSON\PackedArray::toRelaxedExtendedJSON</methodname>
<void/>
</methodsynopsis>
<para>
Метод преобразовывает BSON-массив в представление
<link xlink:href="&url.mongodb.specs.extendedjson;#relaxed-extended-json-example">в слабом расширенном JSON-формате</link>.
В слабом формате в ущерб точности типов отдают преимущество работе с примитивами JSON-типа.
В слабом формате создают данные вывода для API-интерфейсов к веб-сервисам
и такие данных проще воспринимать людям.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Метод возвращает строку, которая содержит представление BSON-массива в формате
<link xlink:href="&url.mongodb.specs.extendedjson;#relaxed-extended-json-example">
в слабом расширенном JSON-формате
</link>.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>
Пример преобразования BSON-массива в представление в формате Relaxed Extended JSON
методом <methodname>MongoDB\BSON\PackedArray::toRelaxedExtendedJSON</methodname>
</title>
<programlisting role="php">
<![CDATA[
<?php
$array = [
'foo',
123,
4294967295,
new MongoDB\BSON\ObjectId('56315a7c6118fd1b920270b1'),
];
$packedArray = MongoDB\BSON\PackedArray::fromPHP($array);
echo $packedArray->toRelaxedExtendedJSON(), "\n";
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
["foo", 123, 4294967295, {"$oid": "56315a7c6118fd1b920270b1"}]
]]>
</screen>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><methodname>MongoDB\BSON\PackedArray::fromJSON</methodname></member>
<member><methodname>MongoDB\BSON\PackedArray::toCanonicalExtendedJSON</methodname></member>
<member><function>MongoDB\BSON\toRelaxedExtendedJSON</function></member>
<member><link xlink:href="&url.mongodb.specs.extendedjson;">Спецификация расширенного JSON-формата</link></member>
<member><link xlink:href="&url.mongodb.docs.bson;">BSON-типы</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
-->