Merge pull request #172 from helitik/script-fields-query-support

Add script fields query support

Author: babenkoivan

README.md

@@ -167,6 +167,7 @@ The builder supports various search parameters and provides a number of useful h
 * [trackScores](docs/available-methods.md#trackscores)
 * [trackTotalHits](docs/available-methods.md#tracktotalhits)
 * [when](docs/available-methods.md#when)
+* [scriptFields](docs/available-methods.md#scriptfields)
 
 ### Search Results
 

docs/available-methods.md

@@ -564,3 +564,16 @@ $searchResult = Book::searchQuery($query)
      })
     ->execute();
 ```
+
+### scriptFields
+
+This method allows you to [write scripts](https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting-using.html):
+
+```php
+$searchResult = Book::searchQuery($query)
+    ->scriptFields('title_length', [
+        'lang' => 'painless',
+        'source' => "doc['title'].value.length()",
+    ])
+    ->execute();
+```

src/Builders/SearchParametersBuilder.php

@@ -63,6 +63,7 @@ class SearchParametersBuilder
     private ?bool $explain;
     private ?int $terminateAfter;
     private ?bool $requestCache;
+    private array $scriptFields;
 
     public function __construct(Model $model)
     {
@@ -321,6 +322,21 @@ public function requestCache(bool $requestCache): self
         return $this;
     }
 
+    public function scriptFieldsRaw(array $scriptFields): self
+    {
+        $this->scriptFields = $scriptFields;
+        return $this;
+    }
+
+    public function scriptFields(string $script, array $parameters): self
+    {
+        if (!isset($this->scriptFields)) {
+            $this->scriptFields = [];
+        }
+        $this->scriptFields[$script] = ['script' => $parameters];
+        return $this;
+    }
+
     public function buildSearchParameters(): SearchParameters
     {
         $searchParameters = new SearchParameters();
@@ -419,6 +435,10 @@ public function buildSearchParameters(): SearchParameters
             $searchParameters->requestCache($this->requestCache);
         }
 
+        if (isset($this->scriptFields)) {
+            $searchParameters->scriptFields($this->scriptFields);
+        }
+
         return $searchParameters;
     }
 

tests/Integration/Builders/SearchParametersBuilderTest.php

@@ -652,4 +652,51 @@ public function test_search_parameters_with_request_cache_can_be_built(): void
 
         $this->assertEquals($expected, $actual);
     }
+
+    public function test_search_parameters_with_raw_script_fields_can_be_built(): void
+    {
+        $rawScriptFields = [
+            'title_length' => [
+                'script' => [
+                    'lang' => 'painless',
+                    'source' => "doc['title'].value.length()",
+                ],
+            ],
+        ];
+
+        $expected = (new SearchParameters())
+          ->indices([(new Book())->searchableAs()])
+          ->scriptFields($rawScriptFields);
+
+        $actual = (new SearchParametersBuilder(new Book()))
+          ->scriptFieldsRaw($rawScriptFields)
+          ->buildSearchParameters();
+
+        $this->assertEquals($expected, $actual);
+    }
+
+    public function test_search_parameters_with_script_fields_can_be_built(): void
+    {
+        $scriptFields = [
+            'title_length' => [
+                'script' => [
+                    'lang' => 'painless',
+                    'source' => "doc['title'].value.length()",
+                ],
+            ],
+        ];
+
+        $expected = (new SearchParameters())
+          ->indices([(new Book())->searchableAs()])
+          ->scriptFields($scriptFields);
+
+        $actual = (new SearchParametersBuilder(new Book()))
+          ->scriptFields('title_length', [
+              'lang' => 'painless',
+              'source' => "doc['title'].value.length()",
+          ])
+          ->buildSearchParameters();
+
+        $this->assertEquals($expected, $actual);
+    }
 }