From e9d4e36814b3a781d55389337b3cafcd1413a43a Mon Sep 17 00:00:00 2001
From: Derick Rethans <derick@php.net>
Date: Tue, 23 Apr 2013 09:27:56 +0000
Subject: [PATCH] PHP-702: Support the autoIndexId option for createCollection

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@330136 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/mongo/mongodb/createcollection.xml | 133 +++++++++++++++----
 1 file changed, 107 insertions(+), 26 deletions(-)

diff --git a/reference/mongo/mongodb/createcollection.xml b/reference/mongo/mongodb/createcollection.xml
index e3bfbafe1f..d828b2625a 100644
--- a/reference/mongo/mongodb/createcollection.xml
+++ b/reference/mongo/mongodb/createcollection.xml
@@ -11,10 +11,9 @@
   <methodsynopsis>
    <modifier>public</modifier> <type>MongoCollection</type><methodname>MongoDB::createCollection</methodname>
    <methodparam><type>string</type><parameter>name</parameter></methodparam>
-   <methodparam choice="opt"><type>bool</type><parameter>capped</parameter><initializer>&false;</initializer></methodparam>
-   <methodparam choice="opt"><type>int</type><parameter>size</parameter><initializer>0</initializer></methodparam>
-   <methodparam choice="opt"><type>int</type><parameter>max</parameter><initializer>0</initializer></methodparam>
+   <methodparam choice="opt"><type>array</type><parameter>options</parameter></methodparam>
   </methodsynopsis>
+  
   <para>
    This method is used to create capped collections and other collections 
    requiring special options.  It is identical to running:
@@ -30,8 +29,10 @@ $collection = $db->command(array("create" => $name, "size" => $size, "capped" =>
    See <function>MongoDB::command</function> for more information about database commands.
   </para>
  </refsect1>
+
  <refsect1 role="parameters">
-  &reftitle.parameters;    
+  &reftitle.parameters;
+
   <para>
    <variablelist>
     <varlistentry>
@@ -44,39 +45,72 @@ $collection = $db->command(array("create" => $name, "size" => $size, "capped" =>
       </para>
      </listitem>
     </varlistentry>   
+
     <varlistentry>
      <term>
-      <parameter>capped</parameter>
+      <parameter>options</parameter>
      </term>
      <listitem>
       <para>
-       If the collection should be a fixed size.
+       An array containing options for the collections. Each option is its own
+       element in the options array, with the option name listed below being
+       the key of the element. The supported options depend on the MongoDB
+       server version. At the moment, the following options are supported:
       </para>
-     </listitem>
-    </varlistentry>   
-    <varlistentry>
-     <term>
-      <parameter>size</parameter>
-     </term>
-     <listitem>
       <para>
-       If the collection is fixed size, its size in bytes.
+       <variablelist>
+        <varlistentry>
+         <term>
+          <parameter>capped</parameter>
+         </term>
+         <listitem>
+          <para>
+           If the collection should be a fixed size.
+          </para>
+         </listitem>
+        </varlistentry>   
+        <varlistentry>
+         <term>
+          <parameter>size</parameter>
+         </term>
+         <listitem>
+          <para>
+           If the collection is fixed size, its size in bytes.
+          </para>
+         </listitem>
+        </varlistentry>   
+        <varlistentry>
+         <term>
+          <parameter>max</parameter>
+         </term>
+         <listitem>
+          <para>
+           If the collection is fixed size, the maximum number of elements to
+           store in the collection.
+          </para>
+         </listitem>
+        </varlistentry>   
+        <varlistentry>
+         <term>
+          <parameter>autoIndexId</parameter>
+         </term>
+         <listitem>
+          <para>
+           If capped is &true; you can specify &false; to disable the
+           automatic index created on the <literal>_id</literal> field.
+           Before MongoDB 2.2, the default value for
+           <literal>autoIndexId</literal> was false.
+          </para>
+         </listitem>
+        </varlistentry>   
+       </variablelist>
       </para>
      </listitem>
-    </varlistentry>   
-    <varlistentry>
-     <term>
-      <parameter>max</parameter>
-     </term>
-     <listitem>
-      <para>
-       If the collection is fixed size, the maximum number of elements to store in the collection.
-      </para>
-     </listitem>
-    </varlistentry>   
+    </varlistentry>
    </variablelist>
   </para>
  </refsect1>
+
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
@@ -103,7 +137,14 @@ $collection = $db->command(array("create" => $name, "size" => $size, "capped" =>
 <![CDATA[
 <?php
 
-$log = $db->createCollection("logger", true, 10*1024, 10); 
+$log = $db->createCollection(
+    "logger",
+    array(
+        'capped' => true,
+        'size' => 10*1024,
+        'max' => 10
+    )
+);
 
 for ($i = 0; $i < 100; $i++) {
     $log->insert(array("level" => WARN, "msg" => "sample log message #$i", "ts" => new MongoDate()));
@@ -133,6 +174,46 @@ sample log message #99
    </screen>
   </example>
  </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.4.0</entry>
+       <entry>
+        <para>
+         In versions before 1.4.0, the options were all arguments to the method. The
+         function synopsis in those older versions is:
+        </para>
+        <para>
+         <methodsynopsis>
+          <modifier>public</modifier> <type>MongoCollection</type><methodname>MongoDB::createCollection</methodname>
+          <methodparam><type>string</type><parameter>name</parameter></methodparam>
+          <methodparam choice="opt"><type>bool</type><parameter>capped</parameter><initializer>&false;</initializer></methodparam>
+          <methodparam choice="opt"><type>int</type><parameter>size</parameter><initializer>0</initializer></methodparam>
+          <methodparam choice="opt"><type>int</type><parameter>max</parameter><initializer>0</initializer></methodparam>
+         </methodsynopsis>
+        </para>
+        <para>
+         The meaning of the options is the same as described under the
+         <parameter>options</parameter> argument above.
+        </para>
+       </entry>
+      </row>
+     </tbody>
+    </tgroup>
+   </informaltable>
+  </para>
+ </refsect1>
 </refentry>
 <!-- Keep this comment at the end of the file
 Local variables: