add request params to client->deleteDocuments (#1419)

Author: fvilpoix

CHANGELOG.md

@@ -11,6 +11,8 @@ All notable changes to this project will be documented in this file based on the
 
 ### Added
 
+* Added request parameters to `Client->deleteDocuments()`. [#1419](https://github.com/ruflin/Elastica/pull/1419)
+
 ### Improvements
 
 ### Deprecated

lib/Elastica/Client.php

@@ -481,12 +481,13 @@ protected function _populateDocumentFieldsFromResponse(Response $response, Docum
      * Bulk deletes documents.
      *
      * @param array|\Elastica\Document[] $docs
+     * @param array                      $requestParams
      *
      * @throws \Elastica\Exception\InvalidException
      *
      * @return \Elastica\Bulk\ResponseSet
      */
-    public function deleteDocuments(array $docs)
+    public function deleteDocuments(array $docs, array $requestParams = [])
     {
         if (empty($docs)) {
             throw new InvalidException('Array has to consist of at least one element');
@@ -495,6 +496,10 @@ public function deleteDocuments(array $docs)
         $bulk = new Bulk($this);
         $bulk->addDocuments($docs, Action::OP_TYPE_DELETE);
 
+        foreach ($requestParams as $key => $value) {
+            $bulk->setRequestParam($key, $value);
+        }
+
         return $bulk->send();
     }
 

test/Elastica/ClientTest.php

@@ -927,6 +927,49 @@ public function testDeleteDocuments()
         $this->assertEquals(1, $type->count());
     }
 
+    /**
+     * @group functional
+     */
+    public function testDeleteDocumentsWithRequestParameters()
+    {
+        $index = $this->_createIndex();
+        $type = $index->getType('test');
+        $client = $index->getClient();
+
+        $docs = [
+            new Document(1, ['field' => 'value1'], $type, $index),
+            new Document(2, ['field' => 'value2'], $type, $index),
+            new Document(3, ['field' => 'value3'], $type, $index),
+        ];
+
+        $response = $client->addDocuments($docs);
+
+        $this->assertInstanceOf(ResponseSet::class, $response);
+        $this->assertEquals(3, count($response));
+        $this->assertTrue($response->isOk());
+        $this->assertFalse($response->hasError());
+        $this->assertEquals('', $response->getError());
+
+        $index->refresh();
+
+        $this->assertEquals(3, $type->count());
+
+        $deleteDocs = [
+            $docs[0],
+            $docs[2],
+        ];
+
+        $response = $client->deleteDocuments($deleteDocs, ['refresh' => true]);
+
+        $this->assertInstanceOf(ResponseSet::class, $response);
+        $this->assertEquals(2, count($response));
+        $this->assertTrue($response->isOk());
+        $this->assertFalse($response->hasError());
+        $this->assertEquals('', $response->getError());
+
+        $this->assertEquals(1, $type->count());
+    }
+
     /**
      * @group functional
      */