Merge pull request #19 from janaculenova/main

Added Functions Query and Function Score Query

Author: erichard

composer.json

@@ -50,4 +50,4 @@
             "symfony/thanks": false
         }
     }
-}
+}

src/Query/FunctionScoreQuery.php

@@ -0,0 +1,73 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Erichard\ElasticQueryBuilder\Query;
+
+use Erichard\ElasticQueryBuilder\Contracts\QueryInterface;
+
+class FunctionScoreQuery implements QueryInterface
+{
+    protected ?string $boost = null;
+
+    protected ?string $boostMode = null;
+
+    private ?array $functions = null;
+
+    /**
+     * @param array[]|string[] $fields
+     */
+    public function __construct(
+        protected array $fields,
+        protected string $query,
+    ) {
+    }
+
+    public function setBoost(string $boost): self
+    {
+        $this->boost = $boost;
+
+        return $this;
+    }
+
+    public function setBoostMode(string $boostMode): self
+    {
+        $this->boostMode = $boostMode;
+
+        return $this;
+    }
+
+    public function setFunctions(array $functions): self
+    {
+        $this->functions = $functions;
+
+        return $this;
+    }
+
+    public function build(): array
+    {
+        $build = [];
+        if (null !== $this->boostMode) {
+            $build['boost_mode'] = $this->boostMode;
+        }
+
+        if (null !== $this->functions) {
+            $build['functions'] = $this->functions;
+        }
+
+        $build['query'] = [
+            'query_string' => [
+                'query' => $this->query,
+                'fields' => $this->fields,
+            ],
+        ];
+
+        if (null !== $this->boost) {
+            $build['query']['query_string'] = $this->boost;
+        }
+
+        return [
+            'function_score' => $build,
+        ];
+    }
+}

src/Query/FunctionsQuery.php

@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Erichard\ElasticQueryBuilder\Query;
+
+use Erichard\ElasticQueryBuilder\Contracts\QueryInterface;
+
+class FunctionsQuery implements QueryInterface
+{
+    protected ?float $weight = null;
+
+    public function __construct(
+        protected string $field,
+    ) {
+    }
+
+    public function setWeight(float $weight): self
+    {
+        $this->weight = $weight;
+
+        return $this;
+    }
+
+    public function build(): array
+    {
+        $functions = [];
+        $functions['filter'] = [
+            'term' => [
+                '_index' => $this->field,
+            ],
+        ];
+
+        if (null !== $this->weight) {
+            $functions['weight'] = $this->weight;
+        }
+
+        return $functions;
+    }
+}

src/Query/Query.php

@@ -76,6 +76,16 @@ public static function multiMatch(array $fields, string $query): MultiMatchQuery
         return new MultiMatchQuery($fields, $query);
     }
 
+    public static function functionScoreQuery(array $fields, string $query): FunctionScoreQuery
+    {
+        return new FunctionScoreQuery($fields, $query);
+    }
+
+    public static function functionsQuery(string $field): FunctionsQuery
+    {
+        return new FunctionsQuery($field);
+    }
+
     /**
      * @param float[]|int[] $position
      */

tests/Query/FunctionScoreQueryTest.php

@@ -0,0 +1,71 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Erichard\ElasticQueryBuilder\Query;
+
+use PHPUnit\Framework\TestCase;
+
+class FunctionScoreQueryTest extends TestCase
+{
+    public function testBuildFunctionScoreQuery(): void
+    {
+        $fields = ['column1', 'column2'];
+        $query = '(*name*) OR name';
+
+        $functionScoreQuery = new FunctionScoreQuery($fields, $query);
+
+        $response = [
+            'function_score' => [
+                'query' => [
+                    'query_string' => [
+                        'query' => '(*name*) OR name',
+                        'fields' => ['column1', 'column2'],
+                    ],
+                ],
+            ],
+        ];
+
+        $this->assertEquals($response, $functionScoreQuery->build());
+    }
+
+    public function testBuildFunctionScoreQuerySetParams(): void
+    {
+        $fields = ['column1', 'column2'];
+        $query = '(*name*) OR name';
+
+        $functionScoreQuery = new FunctionScoreQuery($fields, $query);
+        $functionScoreQuery->setBoostMode('multiply');
+        $functionScoreQuery->setFunctions($this->functions());
+
+        $response = [
+            'function_score' => [
+                'boost_mode' => 'multiply',
+                'functions' => [
+                    'filter' => [
+                        'term' => [
+                            '_index' => 'column2',
+                        ],
+                    ],
+                    'weight' => 2.50,
+                ],
+                'query' => [
+                    'query_string' => [
+                        'query' => '(*name*) OR name',
+                        'fields' => ['column1', 'column2'],
+                    ],
+                ],
+            ],
+        ];
+
+        $this->assertEquals($response, $functionScoreQuery->build());
+    }
+
+    private function functions(): array
+    {
+        $functions = new FunctionsQuery('column2');
+        $functions->setWeight(2.50);
+
+        return $functions->build();
+    }
+}

tests/Query/FunctionsQueryTest.php

@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Erichard\ElasticQueryBuilder\Query;
+
+use Erichard\ElasticQueryBuilder\Query\FunctionsQuery;
+use PHPUnit\Framework\TestCase;
+
+class FunctionsQueryTest extends TestCase
+{
+    public function testFunctionsQuery(): void
+    {
+        $functionsQuery = new FunctionsQuery('column1');
+
+        $response = [
+            'filter' => [
+                'term' => [
+                    '_index' => 'column1',
+                ],
+            ],
+        ];
+
+        $this->assertEquals($response, $functionsQuery->build());
+    }
+
+    public function testFunctionsQuerySetWeight(): void
+    {
+        $functionsQuery = new FunctionsQuery('column1');
+        $functionsQuery->setWeight(2.50);
+
+        $response = [
+            'filter' => [
+                'term' => [
+                    '_index' => 'column1',
+                ],
+            ],
+            'weight' => 2.50,
+        ];
+
+        $this->assertEquals($response, $functionsQuery->build());
+    }
+}