feat: add SynonymSet and SynonymSets classes for global synonym management

Author: tharropoulos

src/SynonymSet.php

@@ -0,0 +1,77 @@
+<?php
+
+namespace Typesense;
+
+use Http\Client\Exception as HttpClientException;
+use Typesense\Exceptions\TypesenseClientError;
+
+/**
+ * Class SynonymSet
+ *
+ * @package \Typesense
+ */
+class SynonymSet
+{
+    /**
+     * @var string
+     */
+    private string $synonymSetName;
+
+    /**
+     * @var ApiCall
+     */
+    private ApiCall $apiCall;
+
+    /**
+     * SynonymSet constructor.
+     *
+     * @param string $synonymSetName
+     * @param ApiCall $apiCall
+     */
+    public function __construct(string $synonymSetName, ApiCall $apiCall)
+    {
+        $this->synonymSetName = $synonymSetName;
+        $this->apiCall        = $apiCall;
+    }
+
+    /**
+     * @return string
+     */
+    private function endPointPath(): string
+    {
+        return sprintf(
+            '%s/%s',
+            SynonymSets::RESOURCE_PATH,
+            encodeURIComponent($this->synonymSetName)
+        );
+    }
+
+    /**
+     * @param array $params
+     *
+     * @return array
+     * @throws TypesenseClientError|HttpClientException
+     */
+    public function upsert(array $params): array
+    {
+        return $this->apiCall->put($this->endPointPath(), $params);
+    }
+
+    /**
+     * @return array
+     * @throws TypesenseClientError|HttpClientException
+     */
+    public function retrieve(): array
+    {
+        return $this->apiCall->get($this->endPointPath(), []);
+    }
+
+    /**
+     * @return array
+     * @throws TypesenseClientError|HttpClientException
+     */
+    public function delete(): array
+    {
+        return $this->apiCall->delete($this->endPointPath());
+    }
+} 

src/SynonymSets.php

@@ -0,0 +1,93 @@
+<?php
+
+namespace Typesense;
+
+use Http\Client\Exception as HttpClientException;
+use Typesense\Exceptions\TypesenseClientError;
+
+/**
+ * Class SynonymSets
+ *
+ * @package \Typesense
+ */
+class SynonymSets implements \ArrayAccess
+{
+    public const RESOURCE_PATH = '/synonym_sets';
+
+    /**
+     * @var ApiCall
+     */
+    private ApiCall $apiCall;
+
+    /**
+     * @var array
+     */
+    private array $synonymSets = [];
+
+    /**
+     * SynonymSets constructor.
+     *
+     * @param ApiCall $apiCall
+     */
+    public function __construct(ApiCall $apiCall)
+    {
+        $this->apiCall = $apiCall;
+    }
+
+    /**
+     * @param string $synonymSetName
+     * @param array $config
+     *
+     * @return array
+     * @throws TypesenseClientError|HttpClientException
+     */
+    public function upsert(string $synonymSetName, array $config): array
+    {
+        return $this->apiCall->put(sprintf('%s/%s', static::RESOURCE_PATH, encodeURIComponent($synonymSetName)), $config);
+    }
+
+    /**
+     * @return array
+     * @throws TypesenseClientError|HttpClientException
+     */
+    public function retrieve(): array
+    {
+        return $this->apiCall->get(static::RESOURCE_PATH, []);
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function offsetExists($synonymSetName): bool
+    {
+        return isset($this->synonymSets[$synonymSetName]);
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function offsetGet($synonymSetName): SynonymSet
+    {
+        if (!isset($this->synonymSets[$synonymSetName])) {
+            $this->synonymSets[$synonymSetName] = new SynonymSet($synonymSetName, $this->apiCall);
+        }
+
+        return $this->synonymSets[$synonymSetName];
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function offsetSet($synonymSetName, $value): void
+    {
+        $this->synonymSets[$synonymSetName] = $value;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function offsetUnset($synonymSetName): void
+    {
+        unset($this->synonymSets[$synonymSetName]);
+    }
+}