PHPLIB-94: Implement BulkWriteResult class for CRUD spec

src/BulkWriteResult.php

@@ -0,0 +1,136 @@
+<?php
+
+namespace MongoDB;
+
+use BSON\ObjectId;
+use MongoDB\Driver\WriteResult;
+
+/**
+ * Result class for a bulk write operation.
+ */
+class BulkWriteResult
+{
+    private $writeResult;
+    private $insertedIds;
+
+    /**
+     * Constructor.
+     *
+     * @param WriteResult $writeResult
+     * @param mixed[]     $insertedIds
+     */
+    public function __construct(WriteResult $writeResult, array $insertedIds)
+    {
+        $this->writeResult = $writeResult;
+        $this->insertedIds = $insertedIds;
+    }
+
+    /**
+     * Return the number of documents that were deleted.
+     *
+     * This value is undefined if the write was not acknowledged.
+     *
+     * @see BulkWriteResult::isAcknowledged()
+     * @return integer
+     */
+    public function getDeletedCount()
+    {
+        return $this->writeResult->getDeletedCount();
+    }
+
+    /**
+     * Return the number of documents that were inserted.
+     *
+     * This value is undefined if the write was not acknowledged.
+     *
+     * @see BulkWriteResult::isAcknowledged()
+     * @return integer
+     */
+    public function getInsertedCount()
+    {
+        return $this->writeResult->getInsertedCount();
+    }
+
+    /**
+     * Return a map of the inserted documents' IDs.
+     *
+     * The index of each ID in the map corresponds to the document's position
+     * in bulk operation. If the document had an ID prior to insertion (i.e. the
+     * driver did not generate an ID), this will contain its "_id" field value.
+     * Any driver-generated ID will be an MongoDB\Driver\ObjectID instance.
+     *
+     * @return mixed[]
+     */
+    public function getInsertedIds()
+    {
+        return $this->insertedIds;
+    }
+
+    /**
+     * Return the number of documents that were matched by the filter.
+     *
+     * This value is undefined if the write was not acknowledged.
+     *
+     * @see BulkWriteResult::isAcknowledged()
+     * @return integer
+     */
+    public function getMatchedCount()
+    {
+        return $this->writeResult->getMatchedCount();
+    }
+
+    /**
+     * Return the number of documents that were modified.
+     *
+     * This value is undefined if the write was not acknowledged or if the write
+     * executed as a legacy operation instead of write command.
+     *
+     * @see BulkWriteResult::isAcknowledged()
+     * @return integer|null
+     */
+    public function getModifiedCount()
+    {
+        return $this->writeResult->getModifiedCount();
+    }
+
+    /**
+     * Return the number of documents that were upserted.
+     *
+     * This value is undefined if the write was not acknowledged.
+     *
+     * @see BulkWriteResult::isAcknowledged()
+     * @return integer
+     */
+    public function getUpsertedCount()
+    {
+        return $this->writeResult->getUpsertedCount();
+    }
+
+    /**
+     * Return a map of the upserted documents' IDs.
+     *
+     * The index of each ID in the map corresponds to the document's position
+     * in bulk operation. If the document had an ID prior to upserting (i.e. the
+     * server did not need to generate an ID), this will contain its "_id". Any
+     * server-generated ID will be an MongoDB\Driver\ObjectID instance.
+     *
+     * @return mixed[]
+     */
+    public function getUpsertedIds()
+    {
+        return $this->writeResult->getUpsertedIds();
+    }
+
+    /**
+     * Return whether this update was acknowledged by the server.
+     *
+     * If the update was not acknowledged, other fields from the WriteResult
+     * (e.g. matchedCount) will be undefined.
+     *
+     * @return boolean
+     */
+    public function isAcknowledged()
+    {
+        return $this->writeResult->isAcknowledged();
+    }
+}

src/Collection.php

@@ -198,32 +198,44 @@ function (\stdClass $document) { return (array) $document; },
      *
      * @see Collection::getBulkOptions() for supported $options
      *
-     * @param array $bulk    Array of operations
+     * @param array $ops    Array of operations
      * @param array $options Additional options
      * @return WriteResult
      */
-    public function bulkWrite(array $bulk, array $options = array())
+    public function bulkWrite(array $ops, array $options = array())
     {
         $options = array_merge($this->getBulkOptions(), $options);
 
         $bulk = new BulkWrite($options["ordered"]);
+        $insertedIds = array();
 
-        foreach ($bulk as $n => $op) {
+        foreach ($ops as $n => $op) {
             foreach ($op as $opname => $args) {
                 if (!isset($args[0])) {
                     throw new InvalidArgumentException(sprintf("Missing argument#1 for '%s' (operation#%d)", $opname, $n));
                 }
 
                 switch ($opname) {
                 case "insertOne":
-                    $bulk->insert($args[0]);
+                    $insertedId = $bulk->insert($args[0]);
+
+                    if ($insertedId !== null) {
+                        $insertedIds[$n] = $insertedId;
+                    } else {
+                        $insertedIds[$n] = is_array($args[0]) ? $args[0]['_id'] : $args[0]->_id;
+                    }
+
                     break;
 
                 case "updateMany":
                     if (!isset($args[1])) {
                         throw new InvalidArgumentException(sprintf("Missing argument#2 for '%s' (operation#%d)", $opname, $n));
                     }
-                    $options = array_merge($this->getWriteOptions(), isset($args[2]) ? $args[2] : array(), array("limit" => 0));
+                    $options = array_merge($this->getWriteOptions(), isset($args[2]) ? $args[2] : array(), array("multi" => true));
+                    $firstKey = key($args[1]);
+                    if (!isset($firstKey[0]) || $firstKey[0] != '$') {
+                        throw new InvalidArgumentException("First key in \$update must be a \$operator");
+                    }
 
                     $bulk->update($args[0], $args[1], $options);
                     break;
@@ -232,7 +244,7 @@ public function bulkWrite(array $bulk, array $options = array())
                     if (!isset($args[1])) {
                         throw new InvalidArgumentException(sprintf("Missing argument#2 for '%s' (operation#%d)", $opname, $n));
                     }
-                    $options = array_merge($this->getWriteOptions(), isset($args[2]) ? $args[2] : array(), array("limit" => 1));
+                    $options = array_merge($this->getWriteOptions(), isset($args[2]) ? $args[2] : array(), array("multi" => false));
                     $firstKey = key($args[1]);
                     if (!isset($firstKey[0]) || $firstKey[0] != '$') {
                         throw new InvalidArgumentException("First key in \$update must be a \$operator");
@@ -245,7 +257,7 @@ public function bulkWrite(array $bulk, array $options = array())
                     if (!isset($args[1])) {
                         throw new InvalidArgumentException(sprintf("Missing argument#2 for '%s' (operation#%d)", $opname, $n));
                     }
-                    $options = array_merge($this->getWriteOptions(), isset($args[2]) ? $args[2] : array(), array("limit" => 1));
+                    $options = array_merge($this->getWriteOptions(), isset($args[2]) ? $args[2] : array(), array("multi" => false));
                     $firstKey = key($args[1]);
                     if (isset($firstKey[0]) && $firstKey[0] == '$') {
                         throw new InvalidArgumentException("First key in \$update must NOT be a \$operator");
@@ -269,7 +281,10 @@ public function bulkWrite(array $bulk, array $options = array())
                 }
             }
         }
-        return $this->manager->executeBulkWrite($this->ns, $bulk, $this->wc);
+
+        $writeResult = $this->manager->executeBulkWrite($this->ns, $bulk, $this->wc);
+
+        return new BulkWriteResult($writeResult, $insertedIds);
     }
 
     /**

src/InsertManyResult.php

@@ -18,7 +18,7 @@ class InsertManyResult
      * @param WriteResult $writeResult
      * @param mixed[]     $insertedIds
      */
-    public function __construct(WriteResult $writeResult, array $insertedIds = array())
+    public function __construct(WriteResult $writeResult, array $insertedIds)
     {
         $this->writeResult = $writeResult;
         $this->insertedIds = $insertedIds;
@@ -38,11 +38,11 @@ public function getInsertedCount()
     }
 
     /**
-     * Return the map of inserted IDs that were generated by the driver.
+     * Return a map of the inserted documents' IDs.
      *
      * The index of each ID in the map corresponds to the document's position
-     * in bulk operation. If the document already an ID prior to insertion (i.e.
-     * the driver did not need to generate an ID), this will contain its "_id".
+     * in bulk operation. If the document had an ID prior to insertion (i.e. the
+     * driver did not generate an ID), this will contain its "_id" field value.
      * Any driver-generated ID will be an MongoDB\Driver\ObjectID instance.
      *
      * @return mixed[]

src/InsertOneResult.php

@@ -38,7 +38,7 @@ public function getInsertedCount()
     }
 
     /**
-     * Return the inserted ID that was generated by the driver.
+     * Return the inserted document's ID.
      *
      * If the document already an ID prior to insertion (i.e. the driver did not
      * need to generate an ID), this will contain its "_id". Any

src/UpdateResult.php

@@ -2,7 +2,6 @@
 
 namespace MongoDB;
 
-use BSON\ObjectId;
 use MongoDB\Driver\WriteResult;
 
 /**
@@ -38,7 +37,8 @@ public function getMatchedCount()
     /**
      * Return the number of documents that were modified.
      *
-     * This value is undefined if the write was not acknowledged.
+     * This value is undefined if the write was not acknowledged or if the write
+     * executed as a legacy operation instead of write command.
      *
      * @see UpdateResult::isAcknowledged()
      * @return integer
@@ -48,12 +48,25 @@ public function getModifiedCount()
         return $this->writeResult->getModifiedCount();
     }
 
+    /**
+     * Return the number of documents that were upserted.
+     *
+     * This value is undefined if the write was not acknowledged.
+     *
+     * @see UpdateResult::isAcknowledged()
+     * @return integer
+     */
+    public function getUpsertedCount()
+    {
+        return $this->writeResult->getUpsertedCount();
+    }
+
     /**
      * Return the ID of the document inserted by an upsert operation.
      *
      * This value is undefined if an upsert did not take place.
      *
-     * @return ObjectId|null
+     * @return mixed|null
      */
     public function getUpsertedId()
     {