added MongoCursor::fields

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@296627 c90b9560-bf6c-de11-be94-00142212c4b1

reference/mongo/mongocollection/ensureindex.xml

@@ -18,7 +18,9 @@
    <methodparam><type>array</type><parameter>options</parameter></methodparam>
   </methodsynopsis>
   <para>
-   A unique index cannot be created on a field if multiple existing documents do not contain the field.  The field is effectively &null; for these documents and thus already non-unique.
+   A unique index cannot be created on a field if multiple existing documents do
+   not contain the field.  The field is effectively &null; for these documents 
+   and thus already non-unique.
   </para>
  </refsect1>
 

reference/mongo/mongocursor/fields.xml

@@ -0,0 +1,98 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<!-- $Revision$ -->
+<refentry xml:id="mongocursor.fields" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>MongoCursor::fields</refname>
+  <refpurpose>Sets the fields for a query</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>MongoCursor</type><methodname>MongoCursor::fields</methodname>
+   <methodparam><type>array</type><parameter>f</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+   Fields are specified by <literal>"fieldname" : bool</literal>.  &true; 
+   indicates that a field should be returned, &false; indicates that it should
+   not be returned.  You can also use 1 and 0 instead of &true; and &false;.
+  </para>
+  <para>
+   Thus, to return only the "summary" field, one could say:
+  </para>
+  <programlisting role="php">
+<![CDATA[
+<?php
+
+$cursor->fields(array("summary" => true));
+
+?>
+]]>
+  </programlisting>
+  <para>
+   To return all fields except the "hidden" field:
+  </para>
+  <programlisting role="php">
+<![CDATA[
+<?php
+
+$cursor->fields(array("hidden" => false));
+
+?>
+]]>
+  </programlisting>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term>
+      <parameter>f</parameter>
+     </term>
+     <listitem>
+      <para>
+       Fields to return (or not return).
+      </para>
+     </listitem>
+    </varlistentry>   
+   </variablelist>
+  </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;  
+  <para>
+   Returns this cursor.
+  </para>
+ </refsect1>
+
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <para>
+   Throws <classname>MongoCursorException</classname> if this cursor has started
+   iterating or a scalar argument is given.
+  </para>
+ </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
+--> 

reference/mongo/mongodb/command.xml

@@ -66,6 +66,8 @@ public function command($data) {
 <![CDATA[
 <?php
 
+$people = $db->people;
+
 $people->insert(array("name" => "Joe", "age" => 4));
 $people->insert(array("name" => "Sally", "age" => 22));
 $people->insert(array("name" => "Dave", "age" => 22));

reference/mongo/versions.xml

@@ -72,6 +72,7 @@
  <function name='mongocursor::getnext' from='PECL mongo &gt;=0.9.0'/>
  <function name='mongocursor::hint' from='PECL mongo &gt;=0.9.0'/>
  <function name='mongocursor::limit' from='PECL mongo &gt;=0.9.0'/>
+ <function name='mongocursor::fields' from='PECL mongo &gt;=1.0.6'/>
  <function name='mongocursor::next' from='PECL mongo &gt;=0.9.0'/>
  <function name='mongocursor::skip' from='PECL mongo &gt;=0.9.0'/>
  <function name='mongocursor::sort' from='PECL mongo &gt;=0.9.0'/>