Added orderRaw (#370)

* add orderRaw method * add test for orderRaw method * add Readme for orderRaw * add readme for sortPayload * styleci fix * styleci fix Co-authored-by: Aidyn Makhataev <[email protected]>
babenkoivan · Jun 1, 2020 · 3b8e570 · 3b8e570
1 parent 39a550f
commit 3b8e570
Show file tree

Hide file tree

Showing 4 changed files with 59 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -274,6 +274,28 @@ App\MyModel::search('sales')
     ->get();
 ```
 
+And add more complex sorting (geo_distance eg.)
+
+```php
+$model = App\MyModel::search('sales')
+    ->orderRaw([
+       '_geo_distance' =>  [
+           'coordinates' => [
+               'lat'   =>  51.507351,
+               'lon'   =>  -0.127758
+           ],
+           'order'     =>  'asc',
+           'unit'      =>  'm'
+       ]
+    ])
+    ->get();
+
+// To retrieve sort result, use model `sortPayload` attribute:
+$model->sortPayload;
+```
+
+
+
 At last, if you want to send a custom request, you can use the `searchRaw` method:
 
 ```php

diff --git a/src/Builders/FilterBuilder.php b/src/Builders/FilterBuilder.php
@@ -446,6 +446,19 @@ public function orderBy($field, $direction = 'asc')
         return $this;
     }
 
+    /**
+     * Add a raw order clause.
+     *
+     * @param array $payload
+     * @return $this
+     */
+    public function orderRaw(array $payload)
+    {
+        $this->orders[] = $payload;
+
+        return $this;
+    }
+
     /**
      * Explain the request.
      *

diff --git a/src/ElasticEngine.php b/src/ElasticEngine.php
@@ -326,6 +326,11 @@ public function map(Builder $builder, $results, $model)
                         $model->highlight = new Highlight($hit['highlight']);
                     }
 
+                    //add sort information to results for use
+                    if (isset($hit['sort'])) {
+                        $model->sortPayload = $hit['sort'];
+                    }
+
                     return $model;
                 }
             })

diff --git a/tests/Builders/FilterBuilderTest.php b/tests/Builders/FilterBuilderTest.php
@@ -424,6 +424,25 @@ public function testOrderBy()
         );
     }
 
+    public function testOrderRaw()
+    {
+        $orderRaw = [
+            '_geo_distance' =>  [
+                'coordinates' => [
+                    'lat'   =>  51.507351,
+                    'lon'   =>  -0.127758,
+                ],
+                'order'     =>  'asc',
+                'unit'      =>  'm',
+            ],
+        ];
+
+        $builder = (new FilterBuilder($this->mockModel()))
+            ->orderRaw($orderRaw);
+
+        $this->assertSame([$orderRaw], $builder->orders);
+    }
+
     public function testWith()
     {
         $builder = (new FilterBuilder($this->mockModel()))