Model/Item.php

@@ -159,7 +159,7 @@ public static function create(
         array $exactMatchingMetadata = [],
         array $suggest = []
     ) {
-        return new self(
+        return new static(
             $uuid,
             null,
             $metadata,
@@ -192,7 +192,7 @@ public static function createLocated(
         array $exactMatchingMetadata = [],
         array $suggest = []
     ) {
-        return new self(
+        return new static(
             $uuid,
             $coordinate,
             $metadata,
@@ -617,7 +617,7 @@ public static function createFromArray(array $array): self
         }
 
         $item = isset($array['coordinate'])
-            ? self::createLocated(
+            ? static::createLocated(
                 ItemUUID::createFromArray($array['uuid']),
                 Coordinate::createFromArray($array['coordinate']),
                 $array['metadata'] ?? [],
@@ -626,7 +626,7 @@ public static function createFromArray(array $array): self
                 $array['exact_matching_metadata'] ?? [],
                 $array['suggest'] ?? []
             )
-            : self::create(
+            : static::create(
                 ItemUUID::createFromArray($array['uuid']),
                 $array['metadata'] ?? [],
                 $array['indexed_metadata'] ?? [],
@@ -671,7 +671,10 @@ public static function createFromArray(array $array): self
      */
     public static function getPathByField(string $field)
     {
-        if (0 === strpos($field, 'indexed_metadata.')) {
+        if (
+            0 === strpos($field, 'indexed_metadata.') ||
+            0 === strpos($field, '_user')
+        ) {
             return $field;
         }
 

Model/ItemForDeletion.php

@@ -0,0 +1,29 @@
+<?php
+
+/*
+ * This file is part of the Apisearch PHP Client.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * Feel free to edit as you please, and have fun.
+ *
+ * @author Marc Morera <yuhu@mmoreram.com>
+ */
+
+declare(strict_types=1);
+
+namespace Apisearch\Model;
+
+class ItemForDeletion extends Item
+{
+    /**
+     * @param ItemUUID $uuid
+     *
+     * @return Item
+     */
+    public static function createByUUID(ItemUUID $uuid)
+    {
+        return static::create($uuid);
+    }
+}

Query/Query.php

@@ -186,6 +186,11 @@ class Query implements HttpTransportable
      */
     private $queryOperator = null;
 
+    /**
+     * @var array
+     */
+    private $context = [];
+
     /**
      * Construct.
      *
@@ -1535,6 +1540,26 @@ public function getQueryOperator(): ?string
         return $this->queryOperator ?? self::QUERY_OPERATOR_OR;
     }
 
+    /**
+     * @return array
+     */
+    public function getContext(): array
+    {
+        return $this->context;
+    }
+
+    /**
+     * @param array $context
+     *
+     * @return Query
+     */
+    public function setContext(array $context): Query
+    {
+        $this->context = $context;
+
+        return $this;
+    }
+
     /**
      * To array.
      *
@@ -1612,6 +1637,7 @@ public function toArray(): array
             'query_operator' => self::QUERY_OPERATOR_OR !== $this->queryOperator
                 ? $this->queryOperator
                 : null,
+            'context' => $this->context,
         ], function ($element) {
             return
             !(
@@ -1695,6 +1721,8 @@ public static function createFromArray(array $array): self
             $query->queryOperator = $array['query_operator'];
         }
 
+        $query->context = $array['context'] ?? [];
+
         return $query;
     }
 }

Query/SortBy.php

@@ -354,17 +354,20 @@ public function byNestedFieldAndFilter(
      *
      * @param string $function
      * @param string $order
+     * @param array  $params
      *
      * @return SortBy
      */
     public function byFunction(
         string $function,
-        string $order
+        string $order,
+        array $params = []
     ): SortBy {
         $this->sortsBy[] = [
             'type' => self::TYPE_FUNCTION,
             'function' => $function,
             'order' => $order,
+            'params' => $params,
         ];
 
         return $this;

Result/Result.php

@@ -79,6 +79,11 @@ class Result implements HttpTransportable
      */
     private $metadata;
 
+    /**
+     * @var array
+     */
+    private $context = [];
+
     /**
      * Result constructor.
      *
@@ -323,6 +328,14 @@ public function getSuggestions(): array
         return array_values($this->suggestions);
     }
 
+    /**
+     * @param array $suggestions
+     */
+    public function setSuggestions(array $suggestions)
+    {
+        $this->suggestions = $suggestions;
+    }
+
     /**
      * @param string $autocomplete
      */
@@ -389,6 +402,16 @@ public function getSubresults(): array
         return $this->subresults;
     }
 
+    /**
+     * @param array $subResults
+     *
+     * @return array
+     */
+    public function setSubResults(array $subResults)
+    {
+        $this->subresults = $subResults;
+    }
+
     /**
      * Set metadata.
      *
@@ -426,6 +449,26 @@ public function getMetadataValue(string $name)
         return $this->metadata[$name] ?? null;
     }
 
+    /**
+     * @return array
+     */
+    public function getContext(): array
+    {
+        return $this->context;
+    }
+
+    /**
+     * @param array $context
+     *
+     * @return Result
+     */
+    public function setContext(array $context): Result
+    {
+        $this->context = $context;
+
+        return $this;
+    }
+
     /**
      * To array.
      *
@@ -451,6 +494,7 @@ public function toArray(): array
                 return $result->toArray();
             }, $this->subresults),
             'metadata' => $this->metadata,
+            'context' => $this->context,
         ], function ($element) {
             return
             !(
@@ -493,6 +537,8 @@ public static function createFromArray(array $array): self
             }, $array['subresults'] ?? [])
         );
 
+        $result->context = $array['context'] ?? [];
+
         return $result;
     }
 }

Tests/Model/ItemForDeletionTest.php

@@ -0,0 +1,33 @@
+<?php
+
+/*
+ * This file is part of the Apisearch PHP Client.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * Feel free to edit as you please, and have fun.
+ *
+ * @author Marc Morera <yuhu@mmoreram.com>
+ */
+
+declare(strict_types=1);
+
+namespace Apisearch\Tests\Model;
+
+use Apisearch\Model\ItemForDeletion;
+use Apisearch\Model\ItemUUID;
+use PHPUnit\Framework\TestCase;
+
+class ItemForDeletionTest extends TestCase
+{
+    public function testCreation()
+    {
+        $item = ItemForDeletion::createByUUID(ItemUUID::createByComposedUUID('1~product'));
+        $this->assertEquals('1~product', $item->composeUUID());
+        $this->assertInstanceOf(ItemForDeletion::class, $item);
+        $item = ItemForDeletion::createFromArray($item->toArray());
+        $this->assertEquals('1~product', $item->composeUUID());
+        $this->assertInstanceOf(ItemForDeletion::class, $item);
+    }
+}

Tests/Model/ItemTest.php

@@ -545,5 +545,6 @@ public function testPathByField()
         $this->assertEquals('indexed_metadata.another_id', Item::getPathByField('another_id'));
         $this->assertEquals('indexed_metadata._field', Item::getPathByField('_field'));
         $this->assertEquals('indexed_metadata._field', Item::getPathByField('indexed_metadata._field'));
+        $this->assertEquals('_user.lol', Item::getPathByField('_user.lol'));
     }
 }

Tests/Query/QueryTest.php

@@ -385,4 +385,17 @@ public function testForceSizeAndPage()
         $this->assertEquals(3, $query->getPage());
         $this->assertEquals(10, $query->getFrom());
     }
+
+    public function testContext()
+    {
+        $this->assertEmpty(Query::createMatchAll()->getContext());
+        $this->assertEmpty((Query::createMatchAll())->toArray()['context'] ?? []);
+        $query = Query::createMatchAll()->setContext(['context1']);
+        $queryAsArray = [
+            'context' => ['context1'],
+        ];
+        $this->assertEquals($queryAsArray, $query->toArray());
+        $this->assertEquals(['context1'], $query->getContext());
+        $this->assertEquals($queryAsArray, Query::createFromArray($query->toArray())->toArray());
+    }
 }

Tests/Query/SortByTest.php

@@ -387,4 +387,20 @@ public function testMultiplesSorts()
             HttpHelper::emulateHttpTransport($sortBy)
         );
     }
+
+    public function testByFunction()
+    {
+        $sortBy = SortBy::create()->byFunction('function 1', 'asc', ['val1', 'val2']);
+        $sortByAsArray = [
+            [
+                'type' => 'function',
+                'function' => 'function 1',
+                'order' => 'asc',
+                'params' => ['val1', 'val2'],
+            ],
+        ];
+
+        $this->assertEquals($sortByAsArray, $sortBy->toArray());
+        $this->assertEquals($sortByAsArray, SortBy::createFromArray($sortByAsArray)->toArray());
+    }
 }

Tests/Result/ResultTest.php

@@ -246,6 +246,19 @@ public function testMultiResult()
         $this->assertEquals(3, $subqueries['res1']->getTotalHits());
         $this->assertEquals(4, $subqueries['res2']->getTotalHits());
         $this->assertEquals(5, $subqueries['res3']->getTotalHits());
+
+        $result = Result::createFromArray([]);
+        $result->setSubResults([
+            'res1' => Result::create(Query::createMatchAll()->identifyWith('1'), 10, 3, null, [], []),
+            'res2' => Result::create(Query::createMatchAll()->identifyWith('2'), 10, 4, null, [], []),
+            'res3' => Result::create(Query::createMatchAll()->identifyWith('3'), 10, 5, null, [], []),
+        ]);
+
+        $this->assertCount(3, $result->getSubresults());
+        $subqueries = HttpHelper::emulateHttpTransport($result)->getSubresults();
+        $this->assertEquals(3, $subqueries['res1']->getTotalHits());
+        $this->assertEquals(4, $subqueries['res2']->getTotalHits());
+        $this->assertEquals(5, $subqueries['res3']->getTotalHits());
     }
 
     /**
@@ -275,5 +288,23 @@ public function testSuggest()
             'sugg1',
         ], []
         )->toArray()['suggests'][0]);
+
+        $result->setSuggestions(['sugg100']);
+        $this->assertEquals(['sugg100'], $result->getSuggestions());
+    }
+
+    public function testContext()
+    {
+        $this->assertEmpty((new Result(Query::createMatchAll(), 0, 0))->getContext());
+        $this->assertEmpty((new Result(Query::createMatchAll(), 0, 0))->toArray()['context'] ?? []);
+        $result = (new Result(Query::createMatchAll(), 0, 0))->setContext(['context1']);
+        $resultAsArray = [
+            'total_items' => 0,
+            'total_hits' => 0,
+            'context' => ['context1'],
+        ];
+        $this->assertEquals($resultAsArray, $result->toArray());
+        $this->assertEquals(['context1'], $result->getContext());
+        $this->assertEquals(['context' => ['context1']], Query::createFromArray($result->toArray())->toArray());
     }
 }