Merge pull request #2 from hanspeerstra/feature-script-fields

Add script_fields support
babenkoivan · Feb 1, 2021 · e89e5db · e89e5db
2 parents bafe7f1 + 9e12c40
commit e89e5db
Show file tree

Hide file tree

Showing 3 changed files with 63 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -291,6 +291,20 @@ $request->setTrackTotalHits(true);
 // track scores
 $request->setTrackScores(true);
 
+// script fields
+$request->setScriptFields([
+    'my_doubled_field' => [
+        'script' => [
+            'lang' => 'painless',
+            'source' => 'doc[params.field] * params.multiplier',
+            'params' => [
+                'field' => 'my_field',
+                'multiplier' => 2,
+            ],
+        ],
+    ],
+]);
+
 // boost indices
 $request->setIndicesBoost([
     ['my-alias' => 1.4],

diff --git a/src/Search/SearchRequest.php b/src/Search/SearchRequest.php
@@ -58,6 +58,10 @@ final class SearchRequest implements ArrayableInterface
      * @var bool|null
      */
     private $trackScores;
+    /**
+     * @var array|null
+     */
+    private $scriptFields;
 
     public function __construct(array $query)
     {
@@ -142,6 +146,12 @@ public function setTrackScores(bool $trackScores): self
         return $this;
     }
 
+    public function setScriptFields(array $scriptFields): self
+    {
+        $this->scriptFields = $scriptFields;
+        return $this;
+    }
+
     public function toArray(): array
     {
         $request = [
@@ -161,6 +171,7 @@ public function toArray(): array
             'trackTotalHits' => 'track_total_hits',
             'indicesBoost' => 'indices_boost',
             'trackScores' => 'track_scores',
+            'scriptFields' => 'script_fields',
         ] as $property => $requestParameter) {
             if (isset($this->$property)) {
                 $request[$requestParameter] = $this->$property;

diff --git a/tests/Unit/Search/SearchRequestTest.php b/tests/Unit/Search/SearchRequestTest.php
@@ -296,4 +296,42 @@ public function test_array_casting_with_track_scores(): void
             'track_scores' => true,
         ], $request->toArray());
     }
+
+    public function test_array_casting_with_script_fields(): void
+    {
+        $request = new SearchRequest([
+            'match_all' => new stdClass(),
+        ]);
+
+        $request->setScriptFields([
+            'my_doubled_field' => [
+                'script' => [
+                    'lang' => 'painless',
+                    'source' => 'doc[params.field] * params.multiplier',
+                    'params' => [
+                        'field' => 'my_field',
+                        'multiplier' => 2,
+                    ],
+                ],
+            ],
+        ]);
+
+        $this->assertEquals([
+            'query' => [
+                'match_all' => new stdClass(),
+            ],
+            'script_fields' => [
+                'my_doubled_field' => [
+                    'script' => [
+                        'lang' => 'painless',
+                        'source' => 'doc[params.field] * params.multiplier',
+                        'params' => [
+                            'field' => 'my_field',
+                            'multiplier' => 2,
+                        ],
+                    ],
+                ],
+            ],
+        ], $request->toArray());
+    }
 }