PHPLIB-93: Insert result classes should always track IDs

Author: jmikola

src/Collection.php

@@ -961,7 +961,7 @@ public function getWriteOptions()
      *
      * @see http://docs.mongodb.org/manual/reference/command/insert/
      *
-     * @param array $documents The documents to insert
+     * @param array[]|object[] $documents The documents to insert
      * @return InsertManyResult
      */
     public function insertMany(array $documents)
@@ -976,6 +976,8 @@ public function insertMany(array $documents)
 
             if ($insertedId !== null) {
                 $insertedIds[$i] = $insertedId;
+            } else {
+                $insertedIds[$i] = is_array($document) ? $document['_id'] : $document->_id;
             }
         }
 
@@ -989,18 +991,21 @@ public function insertMany(array $documents)
      *
      * @see http://docs.mongodb.org/manual/reference/command/insert/
      *
-     * @param array $document  The document to insert
-     * @param array $options   Additional options
+     * @param array|object $document The document to insert
      * @return InsertOneResult
      */
-    public function insertOne(array $document)
+    public function insertOne($document)
     {
         $options = array_merge($this->getWriteOptions());
 
         $bulk = new BulkWrite($options["ordered"]);
         $id    = $bulk->insert($document);
         $wr    = $this->manager->executeBulkWrite($this->ns, $bulk, $this->wc);
 
+        if ($id === null) {
+            $id = is_array($document) ? $document['_id'] : $document->_id;
+        }
+
         return new InsertOneResult($wr, $id);
     }
 

src/InsertManyResult.php

@@ -16,7 +16,7 @@ class InsertManyResult
      * Constructor.
      *
      * @param WriteResult $writeResult
-     * @param array       $insertedIds
+     * @param mixed[]     $insertedIds
      */
     public function __construct(WriteResult $writeResult, array $insertedIds = array())
     {
@@ -41,10 +41,11 @@ public function getInsertedCount()
      * Return the map of inserted IDs that were generated by the driver.
      *
      * The index of each ID in the map corresponds to the document's position
-     * in bulk operation. If an inserted document already had an ID (e.g. it was
-     * generated by the application), it will not be present in this map.
+     * 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".
+     * Any driver-generated ID will be an MongoDB\Driver\ObjectID instance.
      *
-     * @return array
+     * @return mixed[]
      */
     public function getInsertedIds()
     {

src/InsertOneResult.php

@@ -2,7 +2,6 @@
 
 namespace MongoDB;
 
-use BSON\ObjectId;
 use MongoDB\Driver\WriteResult;
 
 /**
@@ -17,9 +16,9 @@ class InsertOneResult
      * Constructor.
      *
      * @param WriteResult $writeResult
-     * @param ObjectId    $insertedId
+     * @param mixed       $insertedId
      */
-    public function __construct(WriteResult $writeResult, ObjectId $insertedId = null)
+    public function __construct(WriteResult $writeResult, $insertedId)
     {
         $this->writeResult = $writeResult;
         $this->insertedId = $insertedId;
@@ -41,10 +40,11 @@ public function getInsertedCount()
     /**
      * Return the inserted ID that was generated by the driver.
      *
-     * If the inserted document already had an ID (e.g. it was generated by the
-     * application), this will be null.
+     * 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
+     * driver-generated ID will be an MongoDB\Driver\ObjectID instance.
      *
-     * @return ObjectId|null
+     * @return mixed
      */
     public function getInsertedId()
     {