-
Notifications
You must be signed in to change notification settings - Fork 152
/
getid.xml
151 lines (136 loc) · 4.4 KB
/
getid.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
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 73789d960f338c138390304c251451851485e7b7 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="mongodb-driver-cursor.getid" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>MongoDB\Driver\Cursor::getId</refname>
<refpurpose>Retourne l'ID de ce curseur</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>final</modifier> <modifier>public</modifier> <type class="union"><type>MongoDB\Driver\CursorId</type><type>MongoDB\BSON\Int64</type></type><methodname>MongoDB\Driver\Cursor::getId</methodname>
<methodparam><type>bool</type><parameter>asInt64</parameter><initializer>&false;</initializer></methodparam>
</methodsynopsis>
<para>
Renvoie l'ID de ce curseur, qui identifie de manière unique le curseur sur le serveur.
</para>
<warning>
<para>
Retourner un objet <classname>MongoDB\Driver\CursorId</classname> depuis
cette méthode est <emphasis>DÉPRÉCIÉ</emphasis> depuis la version 1.20.0 de
l'extension. Dans la version 2.0, l'argument <parameter>asInt64</parameter>
sera supprimé et cette méthode retournera toujours un objet
<classname>MongoDB\BSON\Int64</classname>.
</para>
</warning>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Renvoie l'ID de ce curseur. Si <parameter>asInt64</parameter> est &true;, l'ID
sera retourné sous la forme d'un objet <classname>MongoDB\BSON\Int64</classname> ;
sinon, il sera retourné sous la forme d'un objet
<classname>MongoDB\Driver\CursorId</classname> et un avertissement de dépréciation sera émis.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<simplelist>
&mongodb.throws.argumentparsing;
</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.20.0</entry>
<entry>
Dépréciation du retour d'un <classname>MongoDB\Driver\CursorId</classname>.
Ajout de l'argument <parameter>asInt64</parameter> pour faciliter
la migration vers les versions futures. Si <parameter>asInt64</parameter>
est &true;, l'ID sera retourné sous la forme d'un
<classname>MongoDB\BSON\Int64</classname>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Exemple avec <function>MongoDB\Driver\Cursor::getId</function></title>
<programlisting role="php">
<![CDATA[
<?php
/* Dans cet exemple, nous introduisons plusieurs documents dans la collection et
* spécifions un BatchSize plus petit pour garantir que le premier lot ne contient
* qu'un sous-ensemble de nos résultats et que le curseur reste ouvert sur le
* serveur. */
$manager = new MongoDB\Driver\Manager("mongodb://localhost:27017");
$query = new MongoDB\Driver\Query([], ['batchSize' => 2]);
$bulk = new MongoDB\Driver\BulkWrite;
$bulk->insert(['x' => 1]);
$bulk->insert(['x' => 2]);
$bulk->insert(['x' => 3]);
$manager->executeBulkWrite('db.collection', $bulk);
$cursor = $manager->executeQuery('db.collection', $query);
var_dump($cursor->getId(true));
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
object(MongoDB\BSON\Int64)#5 (1) {
["integer"]=>
string(11) "94810124093"
}
]]>
</screen>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><classname>MongoDB\Driver\CursorId</classname></member>
<member><classname>MongoDB\BSON\Int64</classname></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
-->