PHPLIB-109: Extract DeleteOne and DeleteMany operation classes

Author: jmikola

src/Collection.php

@@ -16,6 +16,8 @@
 use MongoDB\Operation\Aggregate;
 use MongoDB\Operation\CreateIndexes;
 use MongoDB\Operation\Count;
+use MongoDB\Operation\DeleteMany;
+use MongoDB\Operation\DeleteOne;
 use MongoDB\Operation\Distinct;
 use MongoDB\Operation\DropCollection;
 use MongoDB\Operation\DropIndexes;
@@ -289,35 +291,41 @@ public function createIndexes(array $indexes)
     }
 
     /**
-     * Deletes a document matching the $filter criteria.
-     * NOTE: Will delete ALL documents matching $filter
+     * Deletes all documents matching the filter.
      *
+     * @see DeleteMany::__construct() for supported options
      * @see http://docs.mongodb.org/manual/reference/command/delete/
-     *
-     * @param array $filter The $filter criteria to delete
+     * @param array|object $filter  Query by which to delete documents
+     * @param array        $options Command options
      * @return DeleteResult
      */
-    public function deleteMany(array $filter)
+    public function deleteMany($filter, array $options = array())
     {
-        $wr = $this->_delete($filter, 0);
+        $options += array('writeConcern' => $this->wc);
 
-        return new DeleteResult($wr);
+        $operation = new DeleteMany($this->dbname, $this->collname, $filter, $options);
+        $server = $this->manager->selectServer(new ReadPreference(ReadPreference::RP_PRIMARY));
+
+        return $operation->execute($server);
     }
 
     /**
-     * Deletes a document matching the $filter criteria.
-     * NOTE: Will delete at most ONE document matching $filter
+     * Deletes at most one document matching the filter.
      *
+     * @see DeleteOne::__construct() for supported options
      * @see http://docs.mongodb.org/manual/reference/command/delete/
-     *
-     * @param array $filter The $filter criteria to delete
+     * @param array|object $filter  Query by which to delete documents
+     * @param array        $options Command options
      * @return DeleteResult
      */
-    public function deleteOne(array $filter)
+    public function deleteOne($filter, array $options = array())
     {
-        $wr = $this->_delete($filter);
+        $options += array('writeConcern' => $this->wc);
+
+        $operation = new DeleteOne($this->dbname, $this->collname, $filter, $options);
+        $server = $this->manager->selectServer(new ReadPreference(ReadPreference::RP_PRIMARY));
 
-        return new DeleteResult($wr);
+        return $operation->execute($server);
     }
 
     /**
@@ -656,19 +664,6 @@ public function updateOne(array $filter, array $update, array $options = array()
         return new UpdateResult($wr);
     }
 
-    /**
-     * Internal helper for delete one/many documents
-     * @internal
-     */
-    final protected function _delete($filter, $limit = 1)
-    {
-        $options = array_merge($this->getWriteOptions(), array("limit" => $limit));
-
-        $bulk  = new BulkWrite($options["ordered"]);
-        $bulk->delete($filter, $options);
-        return $this->manager->executeBulkWrite($this->ns, $bulk, $this->wc);
-    }
-
     /**
      * Internal helper for replacing/updating one/many documents
      * @internal

src/Operation/Delete.php

@@ -0,0 +1,83 @@
+<?php
+
+namespace MongoDB\Operation;
+
+use MongoDB\DeleteResult;
+use MongoDB\Driver\BulkWrite;
+use MongoDB\Driver\Server;
+use MongoDB\Driver\WriteConcern;
+use MongoDB\Exception\InvalidArgumentException;
+use MongoDB\Exception\InvalidArgumentTypeException;
+
+/**
+ * Operation for the delete command.
+ *
+ * This class is used internally by the DeleteMany and DeleteOne operation
+ * classes.
+ *
+ * @internal
+ * @see http://docs.mongodb.org/manual/reference/command/delete/
+ */
+class Delete implements Executable
+{
+    private $databaseName;
+    private $collectionName;
+    private $filter;
+    private $limit;
+    private $options;
+
+    /**
+     * Constructs a delete command.
+     *
+     * Supported options:
+     *
+     *  * writeConcern (MongoDB\Driver\WriteConcern): Write concern.
+     *
+     * @param string       $databaseName   Database name
+     * @param string       $collectionName Collection name
+     * @param array|object $filter         Query by which to delete documents
+     * @param integer      $limit          The number of matching documents to
+     *                                     delete. Must be 0 or 1, for all or a
+     *                                     single document, respectively.
+     * @param array        $options        Command options
+     * @throws InvalidArgumentException
+     */
+    public function __construct($databaseName, $collectionName, $filter, $limit, array $options = array())
+    {
+        if ( ! is_array($filter) && ! is_object($filter)) {
+            throw new InvalidArgumentTypeException('$filter', $filter, 'array or object');
+        }
+
+        if ($limit !== 0 && $limit !== 1) {
+            throw new InvalidArgumentException('$limit must be 0 or 1');
+        }
+
+        if (isset($options['writeConcern']) && ! $options['writeConcern'] instanceof WriteConcern) {
+            throw new InvalidArgumentTypeException('"writeConcern" option', $options['writeConcern'], 'MongoDB\Driver\WriteConcern');
+        }
+
+        $this->databaseName = (string) $databaseName;
+        $this->collectionName = (string) $collectionName;
+        $this->filter = $filter;
+        $this->limit = $limit;
+        $this->options = $options;
+    }
+
+    /**
+     * Execute the operation.
+     *
+     * @see Executable::execute()
+     * @param Server $server
+     * @return DeleteResult
+     */
+    public function execute(Server $server)
+    {
+        $bulk = new BulkWrite();
+        $bulk->delete($this->filter, array('limit' => $this->limit));
+
+        $writeConcern = isset($this->options['writeConcern']) ? $this->options['writeConcern'] : null;
+        $writeResult = $server->executeBulkWrite($this->databaseName . '.' . $this->collectionName, $bulk, $writeConcern);
+
+        return new DeleteResult($writeResult);
+    }
+}

src/Operation/DeleteMany.php

@@ -0,0 +1,49 @@
+<?php
+
+namespace MongoDB\Operation;
+
+use MongoDB\DeleteResult;
+use MongoDB\Driver\Server;
+use MongoDB\Exception\InvalidArgumentException;
+
+/**
+ * Operation for deleting multiple document with the delete command.
+ *
+ * @api
+ * @see MongoDB\Collection::deleteOne()
+ * @see http://docs.mongodb.org/manual/reference/command/delete/
+ */
+class DeleteMany implements Executable
+{
+    private $delete;
+
+    /**
+     * Constructs a delete command.
+     *
+     * Supported options:
+     *
+     *  * writeConcern (MongoDB\Driver\WriteConcern): Write concern.
+     *
+     * @param string       $databaseName   Database name
+     * @param string       $collectionName Collection name
+     * @param array|object $filter         Query by which to delete documents
+     * @param array        $options        Command options
+     * @throws InvalidArgumentException
+     */
+    public function __construct($databaseName, $collectionName, $filter, array $options = array())
+    {
+        $this->delete = new Delete($databaseName, $collectionName, $filter, 0, $options);
+    }
+
+    /**
+     * Execute the operation.
+     *
+     * @see Executable::execute()
+     * @param Server $server
+     * @return DeleteResult
+     */
+    public function execute(Server $server)
+    {
+        return $this->delete->execute($server);
+    }
+}

src/Operation/DeleteOne.php

@@ -0,0 +1,49 @@
+<?php
+
+namespace MongoDB\Operation;
+
+use MongoDB\DeleteResult;
+use MongoDB\Driver\Server;
+use MongoDB\Exception\InvalidArgumentException;
+
+/**
+ * Operation for deleting a single document with the delete command.
+ *
+ * @api
+ * @see MongoDB\Collection::deleteOne()
+ * @see http://docs.mongodb.org/manual/reference/command/delete/
+ */
+class DeleteOne implements Executable
+{
+    private $delete;
+
+    /**
+     * Constructs a delete command.
+     *
+     * Supported options:
+     *
+     *  * writeConcern (MongoDB\Driver\WriteConcern): Write concern.
+     *
+     * @param string       $databaseName   Database name
+     * @param string       $collectionName Collection name
+     * @param array|object $filter         Query by which to delete documents
+     * @param array        $options        Command options
+     * @throws InvalidArgumentException
+     */
+    public function __construct($databaseName, $collectionName, $filter, array $options = array())
+    {
+        $this->delete = new Delete($databaseName, $collectionName, $filter, 1, $options);
+    }
+
+    /**
+     * Execute the operation.
+     *
+     * @see Executable::execute()
+     * @param Server $server
+     * @return DeleteResult
+     */
+    public function execute(Server $server)
+    {
+        return $this->delete->execute($server);
+    }
+}