Merge pull request #126 from apisearch-io/feature/added-weight-score-strategy-option

Added weight score_strategy boosting

Author: mmoreram

Query/Query.php

@@ -1243,6 +1243,21 @@ public function setScoreStrategies(ScoreStrategies $scoreStrategies)
         return $this;
     }
 
+    /**
+     * Add score strategy.
+     *
+     * @param ScoreStrategy $scoreStrategy
+     *
+     * @return Query
+     */
+    public function addScoreStrategy(ScoreStrategy $scoreStrategy)
+    {
+        $this->scoreStrategies = $this->scoreStrategies ?: ScoreStrategies::createEmpty();
+        $this->scoreStrategies->addScoreStrategy($scoreStrategy);
+
+        return $this;
+    }
+
     /**
      * Get Fuzziness.
      *

Query/ScoreStrategy.php

@@ -51,6 +51,13 @@ class ScoreStrategy implements HttpTransportable
      */
     const CUSTOM_FUNCTION = 'custom_function';
 
+    /**
+     * @var string
+     *
+     * Boosting by relevance field
+     */
+    const WEIGHT = 'weight';
+
     /**
      * @var string
      *
@@ -320,6 +327,29 @@ public static function createCustomFunction(
         return $scoreStrategy;
     }
 
+    /**
+     * Create custom function scoring.
+     *
+     * @param float  $weight
+     * @param Filter $filter
+     * @param bool   $matchMainQuery
+     *
+     * @return ScoreStrategy
+     */
+    public static function createWeightFunction(
+        float $weight = self::DEFAULT_WEIGHT,
+        Filter $filter = null,
+        bool $matchMainQuery = true
+    ): ScoreStrategy {
+        $scoreStrategy = self::createDefault();
+        $scoreStrategy->type = 'weight';
+        $scoreStrategy->weight = $weight;
+        $scoreStrategy->filter = self::fixFilterFieldPath($filter);
+        $scoreStrategy->configuration['match_main_query'] = $matchMainQuery;
+
+        return $scoreStrategy;
+    }
+
     /**
      * Create custom function scoring.
      *

Tests/Query/QueryTest.php

@@ -18,6 +18,7 @@
 use Apisearch\Model\IndexUUID;
 use Apisearch\Query\Query;
 use Apisearch\Query\ScoreStrategies;
+use Apisearch\Query\ScoreStrategy;
 use Apisearch\Query\SortBy;
 use Apisearch\Tests\HttpHelper;
 use PHPUnit\Framework\TestCase;
@@ -231,4 +232,16 @@ public function testSearchableFields()
         $query = HttpHelper::emulateHttpTransport($query);
         $this->assertEquals(['field1'], $query->getsearchableFields());
     }
+
+    /**
+     * Test add score strategy when empty.
+     */
+    public function testAddScoreStrategyWhenEmpty()
+    {
+        $query = Query::createMatchAll();
+        $this->assertNull($query->getScoreStrategies());
+        $query->addScoreStrategy(ScoreStrategy::createDefault());
+        $this->assertInstanceof(ScoreStrategies::class, $query->getScoreStrategies());
+        $this->assertCount(1, $query->getScoreStrategies()->getScoreStrategies());
+    }
 }

Tests/Query/ScoreStrategiesTest.php

@@ -15,6 +15,7 @@
 
 namespace Apisearch\Tests\Query;
 
+use Apisearch\Query\Filter;
 use Apisearch\Query\ScoreStrategies;
 use Apisearch\Query\ScoreStrategy;
 use PHPUnit\Framework\TestCase;
@@ -60,4 +61,28 @@ public function testMultiple()
             $scoreStrategies->getScoreStrategies()
         );
     }
+
+    /**
+     * Test to array and from array.
+     */
+    public function testArrayTransformation()
+    {
+        $scoreStrategies = ScoreStrategies::createEmpty(ScoreStrategies::AVG);
+        $scoreStrategies
+            ->addScoreStrategy(ScoreStrategy::createDefault())
+            ->addScoreStrategy(ScoreStrategy::createDefault())
+            ->addScoreStrategy(ScoreStrategy::createWeightFunction(1.1, Filter::create('a', ['b'], Filter::MUST_ALL, Filter::TYPE_FIELD)))
+            ->addScoreStrategy(ScoreStrategy::createFieldBoosting('field1', 1.1, 2.2, 'avg', 4.4, Filter::create('a2', ['b2'], Filter::MUST_ALL, Filter::TYPE_FIELD), 'none'))
+            ->addScoreStrategy(ScoreStrategy::createDecayFunction('gauss', 'a1', 'a2', 'a3', 'a4', 1.1, 2.2, Filter::create('a3', ['b3'], Filter::MUST_ALL, Filter::TYPE_FIELD), 'kk'));
+        $scoreStrategiesAsArray = $scoreStrategies->toArray();
+        $this->assertCount(5, $scoreStrategies->getScoreStrategies());
+        $covertedScoreStrategies = ScoreStrategies::createFromArray($scoreStrategiesAsArray);
+
+        $this->assertEquals(
+            $scoreStrategiesAsArray,
+            $covertedScoreStrategies->toArray()
+        );
+
+        $this->assertCount(5, $covertedScoreStrategies->getScoreStrategies());
+    }
 }