Merge pull request #643 from einorler/issue40

Implemented multi get API

Author: saimaz

Resources/doc/find_functions.md

@@ -19,6 +19,20 @@ $content = $repo->find(1); // 5 is the document _uid in the elasticsearch.
 
 > All `find` methods return an object. If you want to get raw result use `execute($search, Result::RESULTS_RAW)`.
 
+## Find multiple documents by ID
+
+If multiple documents need to be found by their IDs, `findByIds()` method can be used. It accepts an array of document IDs
+and returns `DocumentIterator` with found documents:
+
+```php
+
+$documents = $repo->findByIds(['26', '8', '11']);
+
+```
+
+For this functionality the `Repository` uses
+[elasticsearch multi get API](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-multi-get.html).
+
 ## Find by field
 
 Find by field uses [query_string query](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html) to fetch results by a specified field value.

Service/Repository.php

@@ -92,6 +92,42 @@ public function find($id, $routing = null)
         return $this->manager->find($this->type, $id, $routing);
     }
 
+    /**
+     * Returns documents by a set of ids
+     *
+     * @param array  $ids
+     *
+     * @return DocumentIterator The objects.
+     */
+    public function findByIds(array $ids)
+    {
+        $args = [];
+        $manager = $this->getManager();
+        $args['body']['docs'] = [];
+        $args['index'] = $manager->getIndexName();
+        $args['type'] = $this->getType();
+
+        foreach ($ids as $id) {
+            $args['body']['docs'][] = [
+                '_id' => $id
+            ];
+        }
+
+        $mgetResponse = $manager->getClient()->mget($args);
+
+        $return = [];
+
+        foreach ($mgetResponse['docs'] as $item) {
+            if ($item['found']) {
+                $return['hits']['hits'][] = $item;
+            }
+        }
+
+        $return['hits']['total'] = count($return['hits']['hits']);
+
+        return new DocumentIterator($return, $manager);
+    }
+
     /**
      * Finds documents by a set of criteria.
      *

Tests/Functional/Service/RepositoryTest.php

@@ -11,6 +11,7 @@
 
 namespace ONGR\ElasticsearchBundle\Tests\Functional;
 
+use ONGR\ElasticsearchBundle\Result\DocumentIterator;
 use ONGR\ElasticsearchBundle\Tests\app\fixture\Acme\BarBundle\Document\Product;
 use ONGR\ElasticsearchDSL\Query\MatchAllQuery;
 use ONGR\ElasticsearchDSL\Query\PrefixQuery;
@@ -491,4 +492,25 @@ public function testCountApiRawResponse()
 
         $this->assertEquals($shards, $count['_shards']);
     }
+
+    /**
+     * Tests mget method
+     */
+    public function testFindByIds()
+    {
+        $manager = $this->getManager('default');
+        $repository = $manager->getRepository('AcmeBarBundle:Product');
+        $results = $repository->findByIds([1, 2, 5]);
+
+        $this->assertInstanceOf(DocumentIterator::class, $results);
+        $this->assertEquals(2, count($results));
+        $i = 0;
+        foreach ($results as $product) {
+            $this->assertInstanceOf(Product::class, $product);
+            $this->assertEquals(
+                $this->getDataArray()['default']['product'][$i++]['price'],
+                $product->getPrice()
+            );
+        }
+    }
 }