Added ability to specify what fields you want to select

Author: babenkoivan

README.md

@@ -191,6 +191,8 @@ Basic search usage example:
 ```php
 // set query string
 App\MyModel::search('phone')
+    // specify columns to select
+    ->select(['title', 'price'])
     // filter 
     ->where('color', 'red')
     // sort

src/Builders/FilterBuilder.php

@@ -20,6 +20,11 @@ class FilterBuilder extends Builder
      */
     public $collapse;
 
+    /**
+     * @var array
+     */
+    public $select = [];
+
     public function __construct($model, $callback = null)
     {
         $this->model = $model;
@@ -175,9 +180,9 @@ public function whereGeoPolygon($field, array $points)
         return $this;
     }
 
-    public function orderBy($column, $direction = 'asc')
+    public function orderBy($field, $direction = 'asc')
     {
-        $this->orders[] = [$column => strtolower($direction) == 'asc' ? 'asc' : 'desc'];
+        $this->orders[] = [$field => strtolower($direction) == 'asc' ? 'asc' : 'desc'];
 
         return $this;
     }
@@ -251,4 +256,18 @@ public function collapse(string $field)
 
         return $this;
     }
+
+    /**
+     * @param mixed $fields
+     * @return $this
+     */
+    public function select($fields)
+    {
+        $this->select = array_merge(
+            $this->select,
+            array_wrap($fields)
+        );
+
+        return $this;
+    }
 }

src/ElasticEngine.php

@@ -75,6 +75,7 @@ protected function buildSearchQueryPayload(Builder $builder, $queryPayload, arra
         }
 
         $payload = (new TypePayload($builder->model))
+            ->setIfNotEmpty('body._source', $builder->select)
             ->setIfNotEmpty('body.query.bool', $queryPayload)
             ->setIfNotEmpty('body.collapse.field', $builder->collapse)
             ->setIfNotEmpty('body.sort', $builder->orders)
@@ -193,21 +194,33 @@ public function mapIds($results)
         return array_pluck($results['hits']['hits'], '_id');
     }
 
+    /**
+     * @inheritdoc
+     */
     public function map($results, $model)
     {
         if ($this->getTotalCount($results) == 0) {
             return Collection::make();
         }
 
-        $ids = $this->mapIds($results);
+        $hits = $results['hits']['hits'];
+        $firstHit = reset($hits);
+
+        $primaryKey = $model->getKeyName();
 
-        $modelKey = $model->getKeyName();
+        $columns = array_merge(
+            array_keys($firstHit['_source']),
+            [$primaryKey]
+        );
+
+        $ids = $this->mapIds($results);
 
-        $models = $model->whereIn($modelKey, $ids)
-                        ->get()
-                        ->keyBy($modelKey);
+        $models = $model
+            ->whereIn($primaryKey, $ids)
+            ->get($columns)
+            ->keyBy($primaryKey);
 
-        return Collection::make($results['hits']['hits'])->map(function($hit) use ($models) {
+        return Collection::make($hits)->map(function($hit) use ($models) {
             $id = $hit['_id'];
 
             if (isset($models[$id])) {

tests/Builders/FilterBuilderTest.php

@@ -385,4 +385,16 @@ public function testCollapse()
             $this->builder->collapse
         );
     }
+
+    public function testSelect()
+    {
+        $this
+            ->builder
+            ->select(['foo', 'bar']);
+
+        $this->assertEquals(
+            ['foo', 'bar'],
+            $this->builder->select
+        );
+    }
 }

tests/ElasticEngineTest.php

@@ -44,6 +44,8 @@ public function testBuildSearchQueryPayloadCollection()
                     ]
                 ];
             })
+            ->select('title')
+            ->select(['price', 'color'])
             ->where('id', '>', 20)
             ->orderBy('id', 'asc')
             ->collapse('brand')
@@ -60,6 +62,11 @@ public function testBuildSearchQueryPayloadCollection()
                     'index' => 'test',
                     'type' => 'test',
                     'body' => [
+                        '_source' => [
+                            'title',
+                            'price',
+                            'color'
+                        ],
                         'query' => [
                             'bool' => [
                                 'must' => [
@@ -98,6 +105,11 @@ public function testBuildSearchQueryPayloadCollection()
                     'index' => 'test',
                     'type' => 'test',
                     'body' => [
+                        '_source' => [
+                            'title',
+                            'price',
+                            'color'
+                        ],
                         'query' => [
                             'bool' => [
                                 'must' => [
@@ -249,8 +261,18 @@ public function testMap()
             'hits' => [
                 'total' => 2,
                 'hits' => [
-                    ['_id' => 1],
-                    ['_id' => 2]
+                    [
+                        '_id' => 1,
+                        '_source' => [
+                            'title' => 'foo'
+                        ]
+                    ],
+                    [
+                        '_id' => 2,
+                        '_source' => [
+                            'title' => 'bar'
+                        ]
+                    ]
                 ]
             ]
         ];