mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-28 23:08:55 +00:00
8bbdbb8d6b
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@328550 c90b9560-bf6c-de11-be94-00142212c4b1
130 lines
2.9 KiB
XML
130 lines
2.9 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="mongocursor.info" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>MongoCursor::info</refname>
|
|
<refpurpose>Gets the query, fields, limit, and skip for this cursor</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>public</modifier> <type>array</type><methodname>MongoCursor::info</methodname>
|
|
<void/>
|
|
</methodsynopsis>
|
|
<para>
|
|
This can be called before or after the query.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
&no.function.parameters;
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns the namespace, limit, skip, query, and fields for this cursor.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="changelog">
|
|
&reftitle.changelog;
|
|
<para>
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>&Version;</entry>
|
|
<entry>&Description;</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>1.1.0</entry>
|
|
<entry>
|
|
Added a number of other fields, including <literal>id</literal> (the
|
|
cursor id), <literal>at</literal> (the driver's counter of which
|
|
document is current), <literal>numReturned</literal> (the number
|
|
returned by the server in the current batch), and
|
|
<literal>server</literal> (which server the query was sent
|
|
to—useful in conjunction with
|
|
<xref linkend="mongo.readpreferences" />.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>1.0.10</entry>
|
|
<entry>
|
|
Added <literal>started_iterating</literal> field, a boolean indicating
|
|
if cursor is pre- or post-query.
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<example>
|
|
<title><function>MongoCursor::info</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
|
|
$m = new MongoClient();
|
|
$cursor = $m->foo->bar->find(array("x" => 4), array("y" => false));
|
|
var_dump($cursor->info());
|
|
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs.similar;
|
|
<screen>
|
|
<![CDATA[
|
|
array(5) {
|
|
["ns"]=>
|
|
string(7) "foo.bar"
|
|
["limit"]=>
|
|
int(0)
|
|
["skip"]=>
|
|
int(0)
|
|
["query"]=>
|
|
array(1) {
|
|
["x"]=>
|
|
int(4)
|
|
}
|
|
["fields"]=>
|
|
array(1) {
|
|
["y"]=>
|
|
int(0)
|
|
}
|
|
}
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</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
|
|
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
|
|
-->
|