From 1624dcaf80de955f612559ca0745c31ba80f3a1a Mon Sep 17 00:00:00 2001
From: Hannes Magnusson <bjori@php.net>
Date: Fri, 14 Mar 2014 23:49:51 +0000
Subject: [PATCH] Document the MongoWriteBatch constants

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@333001 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/mongo/mongowritebatch.xml           | 47 +++++++++++++++++++
 reference/mongo/mongowritebatch/add.xml       |  6 +--
 reference/mongo/mongowritebatch/construct.xml |  6 +--
 reference/mongo/mongowritebatch/execute.xml   | 10 ++--
 4 files changed, 58 insertions(+), 11 deletions(-)

diff --git a/reference/mongo/mongowritebatch.xml b/reference/mongo/mongowritebatch.xml
index 7cac10e830..23c91b44ea 100644
--- a/reference/mongo/mongowritebatch.xml
+++ b/reference/mongo/mongowritebatch.xml
@@ -46,12 +46,59 @@
     </classsynopsisinfo>
 <!-- }}} -->
     
+    <classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
+    <fieldsynopsis>
+     <modifier>const</modifier>
+     <type>int</type>
+     <varname linkend="mongowritebatch.constants.command.insert">MongoWriteBatch::COMMAND_INSERT</varname>
+     <initializer>1</initializer>
+    </fieldsynopsis>
+    <fieldsynopsis>
+     <modifier>const</modifier>
+     <type>int</type>
+     <varname linkend="mongowritebatch.constants.command.update">MongoWriteBatch::COMMAND_UPDATE</varname>
+     <initializer>2</initializer>
+    </fieldsynopsis>
+    <fieldsynopsis>
+     <modifier>const</modifier>
+     <type>int</type>
+     <varname linkend="mongowritebatch.constants.command.delete">MongoWriteBatch::COMMAND_DELETE</varname>
+     <initializer>3</initializer>
+    </fieldsynopsis>
+
     <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
     <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.mongowritebatch')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])" />
     <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.mongowritebatch')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
    </classsynopsis>
 <!-- }}} -->
 
+   <section xml:id="mongowritebatch.constants">
+    <title>MongoWriteBatch types</title>
+    <variablelist>
+
+     <varlistentry xml:id="mongowritebatch.constants.command.insert">
+      <term><constant>MongoWriteBatch::COMMAND_INSERT</constant></term>
+      <listitem>
+       <para>Create an Insert Write Batch</para>
+      </listitem>
+     </varlistentry>
+
+     <varlistentry xml:id="mongowritebatch.constants.command.update">
+      <term><constant>MongoWriteBatch::COMMAND_UPDATE</constant></term>
+      <listitem>
+       <para>Create an Update Write Batch</para>
+      </listitem>
+     </varlistentry>
+
+     <varlistentry xml:id="mongowritebatch.constants.command.delete">
+      <term><constant>MongoWriteBatch::COMMAND_DELETE</constant></term>
+      <listitem>
+       <para>Create an Delete Write Batch</para>
+      </listitem>
+     </varlistentry>
+
+    </variablelist>
+   </section>
   </section>
 
   <section xml:id="mongowritebatch.description">
diff --git a/reference/mongo/mongowritebatch/add.xml b/reference/mongo/mongowritebatch/add.xml
index 05fc33e703..cd1e6b5082 100644
--- a/reference/mongo/mongowritebatch/add.xml
+++ b/reference/mongo/mongowritebatch/add.xml
@@ -40,18 +40,18 @@
        </thead>
        <tbody>
         <row>
-         <entry>INSERT</entry>
+         <entry>MongoWriteBatch::COMMAND_INSERT</entry>
          <entry>The document to add</entry>
         </row>
         <row>
-         <entry>UPDATE</entry>
+         <entry>MongoWriteBatch::COMMAND_UPDATE</entry>
          <entry>
           <simpara>Raw update operation. Required keys are: array("q" => <link linkend="mongocollection.update.criteria">array("criteria")</link>, "u" => array("new data"))</simpara>
           <simpara>Optionally with the "multi" and "upsert" keys as boolean values</simpara>
          </entry>
         </row>
         <row>
-         <entry>DELETE</entry>
+         <entry>MongoWriteBatch::COMMAND_DELETE</entry>
          <entry>
           <simpara>Raw delete operation. Required keys are: array("q" => <link linkend="mongocollection.delete.criteria">array("criteria")</link>, "limit" => 1)</simpara>
          </entry>
diff --git a/reference/mongo/mongowritebatch/construct.xml b/reference/mongo/mongowritebatch/construct.xml
index 004d02f592..907b663523 100644
--- a/reference/mongo/mongowritebatch/construct.xml
+++ b/reference/mongo/mongowritebatch/construct.xml
@@ -39,9 +39,9 @@
      <para>
       One of:
       <simplelist>
-       <member><literal>0</literal> - make an INSERT batch</member>
-       <member><literal>1</literal> - make an UPDATE batch</member>
-       <member><literal>2</literal> - make a  DELETE batch</member>
+       <member><literal>0</literal> - make an MongoWriteBatch::COMMAND_INSERT batch</member>
+       <member><literal>1</literal> - make an MongoWriteBatch::COMMAND_UPDATE batch</member>
+       <member><literal>2</literal> - make a  MongoWriteBatch::COMMAND_DELETE batch</member>
       </simplelist>
      </para>
     </listitem>
diff --git a/reference/mongo/mongowritebatch/execute.xml b/reference/mongo/mongowritebatch/execute.xml
index e6f4829b44..670c145fe4 100644
--- a/reference/mongo/mongowritebatch/execute.xml
+++ b/reference/mongo/mongowritebatch/execute.xml
@@ -57,27 +57,27 @@
      <row>
       <entry>nInserted</entry>
       <entry>Number of inserted documents</entry>
-      <entry>INSERT batch</entry>
+      <entry>MongoWriteBatch::COMMAND_INSERT batch</entry>
      </row>
      <row>
       <entry>nMatched</entry>
       <entry>Number of documents matching the query criteria</entry>
-      <entry>UPDATE batch</entry>
+      <entry>MongoWriteBatch::COMMAND_UPDATE batch</entry>
      </row>
      <row>
       <entry>nModified</entry>
       <entry>Number of documents actually needed to be modied</entry>
-      <entry>UPDATE batch</entry>
+      <entry>MongoWriteBatch::COMMAND_UPDATE batch</entry>
      </row>
      <row>
       <entry>nUpserted</entry>
       <entry>Number of upserted documents</entry>
-      <entry>UPDATE batch</entry>
+      <entry>MongoWriteBatch::COMMAND_UPDATE batch</entry>
      </row>
      <row>
       <entry>nRemoved</entry>
       <entry>Number of documents removed</entry>
-      <entry>DELETE batch</entry>
+      <entry>MongoWriteBatch::COMMAND_DELETE batch</entry>
      </row>
      <row>
       <entry>ok</entry>