Merge pull request #95 from apisearch-io/fix/fixed-searchable-fields-naming

Fixed field name from filter_fields to searchable_fields

Author: mmoreram

Query/Query.php

@@ -165,9 +165,9 @@ class Query implements HttpTransportable
     /**
      * @var string[]
      *
-     * Filter fields
+     * Searchable fields
      */
-    private $filterFields = [];
+    private $searchableFields = [];
 
     /**
      * @var ScoreStrategies
@@ -720,13 +720,13 @@ public function filterUniverseByLocation(LocationRange $locationRange): self
     /**
      * Set filter fields.
      *
-     * @param string[] $filterFields
+     * @param string[] $searchableFields
      *
      * @return Query
      */
-    public function setFilterFields(array $filterFields)
+    public function setsearchableFields(array $searchableFields)
     {
-        $this->filterFields = $filterFields;
+        $this->searchableFields = $searchableFields;
 
         return $this;
     }
@@ -736,9 +736,9 @@ public function setFilterFields(array $filterFields)
      *
      * @return string[]
      */
-    public function getFilterFields(): array
+    public function getsearchableFields(): array
     {
-        return $this->filterFields;
+        return $this->searchableFields;
     }
 
     /**
@@ -1489,7 +1489,7 @@ public function toArray(): array
             'aggregations_enabled' => $this->aggregationsEnabled
                 ? null
                 : false,
-            'filter_fields' => $this->filterFields,
+            'searchable_fields' => $this->searchableFields,
             'score_strategies' => $this->scoreStrategies instanceof ScoreStrategies
                 ? $this->scoreStrategies->toArray()
                 : null,
@@ -1568,7 +1568,7 @@ public static function createFromArray(array $array): self
             return ItemUUID::createFromArray($itemUUID);
         }, $array['items_promoted'] ?? []));
         $query->fuzziness = $array['fuzziness'] ?? null;
-        $query->filterFields = $array['filter_fields'] ?? [];
+        $query->searchableFields = $array['searchable_fields'] ?? [];
         $query->scoreStrategies = isset($array['score_strategies'])
             ? ScoreStrategies::createFromArray($array['score_strategies'])
             : null;

Tests/Query/QueryTest.php

@@ -73,6 +73,7 @@ public function testDefaults()
         $this->assertEquals($query, HttpHelper::emulateHttpTransport($query));
         $this->assertNull($query->getUUID());
         $this->assertNull($query->getIndexUUID());
+        $this->assertEquals([], $query->getsearchableFields());
     }
 
     /**
@@ -218,4 +219,16 @@ public function testIndexUUID()
         $this->assertEquals($indexUUID, $query->getIndexUUID());
         $this->assertEquals($indexUUID->toArray(), $query->toArray()['index_uuid']);
     }
+
+    /**
+     * Test searchable fields.
+     */
+    public function testSearchableFields()
+    {
+        $query = Query::createMatchAll()->setsearchableFields(['field1']);
+        $this->assertEquals(['field1'], $query->getsearchableFields());
+        $this->assertEquals(['field1'], $query->toArray()['searchable_fields']);
+        $query = HttpHelper::emulateHttpTransport($query);
+        $this->assertEquals(['field1'], $query->getsearchableFields());
+    }
 }