- Changed how query explanation works

- Added the profile method to the query builder

Author: babenkoivan

README.md

@@ -382,11 +382,22 @@ In most cases it's better to use raw fields to filter records, i.e. not analyzed
 
 ## Debug
 
-To analyze results of a search query you can set the `explain` flag to true and get explanation from received models:
+There are two methods that can help you to analyze results of a search query:
+
+* [explain](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-explain.html)
 
-```php
-App\MyModel::search('Brazil')
-    ->explain(true)
-    ->first()
-    ->getExplanation();
-```
+    ```php
+    App\MyModel::search('Brazil')
+        ->first()
+        ->explain();
+    ```
+    
+* [profile](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-profile.html)
+
+    ```php
+    App\MyModel::search('Brazil')
+        ->first()
+        ->profile();
+    ```
+    
+Both methods return raw data from ES.

src/Builders/FilterBuilder.php

@@ -6,8 +6,6 @@
 
 class FilterBuilder extends Builder
 {
-    public $explain = false;
-
     public function __construct($model, $callback = null)
     {
         $this->model = $model;
@@ -122,10 +120,13 @@ public function whereRegexp($field, $value, $flags = 'ALL')
         return $this;
     }
 
-    public function explain($bool)
+    public function explain()
     {
-        $this->explain = $bool;
+        return $this->engine()->explain($this);
+    }
 
-        return $this;
+    public function profile()
+    {
+        return $this->engine()->profile($this);
     }
 }

src/ElasticEngine.php

@@ -183,8 +183,10 @@ protected function buildSearchQueryPayload(Builder $builder, $queryPayload, arra
             }
         }
 
-        if ($builder->explain) {
-            $payload['explain'] = true;
+        foreach (['explain', 'profile'] as $key) {
+            if (isset($options[$key])) {
+                $payload[$key] = $options[$key];
+            }
         }
 
         return $this->buildTypePayload(
@@ -290,6 +292,20 @@ public function paginate(Builder $builder, $perPage, $page)
         ]);
     }
 
+    public function explain(Builder $builder)
+    {
+        return $this->performSearch($builder, [
+            'explain' => true
+        ]);
+    }
+
+    public function profile(Builder $builder)
+    {
+        return $this->performSearch($builder, [
+            'profile' => true
+        ]);
+    }
+
     public function searchRaw(Model $model, $query)
     {
         $payload = $this->buildTypePayload($model, $query);
@@ -319,14 +335,7 @@ public function map($results, $model)
             $id = $hit['_id'];
 
             if (isset($models[$id])) {
-                /** @var Searchable $model */
-                $model = $models[$id];
-
-                if (isset($hit['_explanation'])) {
-                    $model->setExplanation($hit['_explanation']);
-                }
-
-                return $model;
+                return $models[$id];
             }
         })->filter();
     }

src/Features/HasExplanation.php

@@ -6,11 +6,9 @@
 use ScoutElastic\Builders\FilterBuilder;
 use ScoutElastic\Builders\SearchBuilder;
 use \Exception;
-use ScoutElastic\Features\HasExplanation;
 
 trait Searchable {
-    use ScoutSearchable,
-        HasExplanation;
+    use ScoutSearchable;
 
     /**
      * @return IndexConfigurator