Merge pull request #533

Author: jmikola

docs/includes/apiargs-MongoDBDatabase-method-createCollection-option.yaml

@@ -9,7 +9,10 @@ description: |
 
      For replica sets, do not set ``autoIndexId`` to ``false``.
 
-  .. deprecated:: 3.2. The ``autoIndexId`` option will be removed in MongoDB 3.4.
+  .. deprecated:: 1.4
+     This option has been deprecated since MongoDB 3.2. As of MongoDB 4.0, this
+     option cannot be ``false`` when creating a replicated collection (i.e. a
+     collection outside of the ``local`` database in any mongod mode).
 interface: phpmethod
 operation: ~
 optional: true

src/Operation/CreateCollection.php

@@ -53,6 +53,10 @@ class CreateCollection implements Executable
      *    of an index on the _id field. For replica sets, this option cannot be
      *    false. The default is true.
      *
+     *    This option has been deprecated since MongoDB 3.2. As of MongoDB 4.0,
+     *    this option cannot be false when creating a replicated collection
+     *    (i.e. a collection outside of the local database in any mongod mode).
+     *
      *  * capped (boolean): Specify true to create a capped collection. If set,
      *    the size option must also be specified. The default is false.
      *
@@ -170,6 +174,10 @@ public function __construct($databaseName, $collectionName, array $options = [])
             unset($options['writeConcern']);
         }
 
+        if (isset($options['autoIndexId'])) {
+            trigger_error('The "autoIndexId" option is deprecated and will be removed in a future release', E_USER_DEPRECATED);
+        }
+
         $this->databaseName = (string) $databaseName;
         $this->collectionName = (string) $collectionName;
         $this->options = $options;

tests/Operation/CreateCollectionTest.php

@@ -82,4 +82,15 @@ public function provideInvalidConstructorOptions()
 
         return $options;
     }
+
+    public function testAutoIndexIdOptionIsDeprecated()
+    {
+        $this->assertDeprecated(function() {
+            new CreateCollection($this->getDatabaseName(), $this->getCollectionName(), ['autoIndexId' => true]);
+        });
+
+        $this->assertDeprecated(function() {
+            new CreateCollection($this->getDatabaseName(), $this->getCollectionName(), ['autoIndexId' => false]);
+        });
+    }
 }

tests/TestCase.php

@@ -52,6 +52,23 @@ public function provideInvalidDocumentValues()
         return $this->wrapValuesForDataProvider($this->getInvalidDocumentValues());
     }
 
+    protected function assertDeprecated(callable $execution)
+    {
+        $errors = [];
+
+        set_error_handler(function($errno, $errstr) use (&$errors) {
+            $errors[] = $errstr;
+        }, E_USER_DEPRECATED);
+
+        try {
+            call_user_func($execution);
+        } finally {
+            restore_error_handler();
+        }
+
+        $this->assertCount(1, $errors);
+    }
+
     protected function assertSameDocument($expectedDocument, $actualDocument)
     {
         $this->assertEquals(