PHPLIB-340: Deprecate maxScan query option

Author: kvwalker

docs/includes/apiargs-MongoDBCollection-method-find-option.yaml

@@ -148,6 +148,7 @@ type: integer
 description: |
   Maximum number of documents or index keys to scan when executing the query.
 
+  .. deprecated:: 1.4
   .. versionadded:: 1.2
 interface: phpmethod
 operation: ~

src/Operation/Find.php

@@ -85,6 +85,8 @@ class Find implements Executable, Explainable
      *  * maxScan (integer): Maximum number of documents or index keys to scan
      *    when executing the query.
      *
+     *    This option has been deprecated since version 1.4.
+     *
      *  * maxTimeMS (integer): The maximum amount of time to allow the query to
      *    run. If "$maxTimeMS" also exists in the modifiers document, this
      *    option will take precedence.
@@ -265,6 +267,10 @@ public function __construct($databaseName, $collectionName, $filter, array $opti
             trigger_error('The "snapshot" option is deprecated and will be removed in a future release', E_USER_DEPRECATED);
         }
 
+        if (isset($options['maxScan'])) {
+            trigger_error('The "maxScan" option is deprecated and will be removed in a future release', E_USER_DEPRECATED);
+        }
+
         $this->databaseName = (string) $databaseName;
         $this->collectionName = (string) $collectionName;
         $this->filter = $filter;

src/Operation/FindOne.php

@@ -56,6 +56,8 @@ class FindOne implements Executable, Explainable
      *  * maxScan (integer): Maximum number of documents or index keys to scan
      *    when executing the query.
      *
+     *    This option has been deprecated since version 1.4.
+     *
      *  * maxTimeMS (integer): The maximum amount of time to allow the query to
      *    run. If "$maxTimeMS" also exists in the modifiers document, this
      *    option will take precedence.

tests/Operation/FindTest.php

@@ -139,6 +139,13 @@ public function testSnapshotOptionIsDeprecated()
         });
     }
 
+    public function testMaxScanOptionIsDeprecated()
+    {
+        $this->assertDeprecated(function() {
+            new Find($this->getDatabaseName(), $this->getCollectionName(), [], ['maxScan' => 1]);
+        });
+    }
+
     private function getInvalidHintValues()
     {
         return [123, 3.14, true];