SynonymSet.php

<?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;
    
    private array $typesenseSynonymSetItems = [];

    /**
     * SynonymSet constructor.
     *
     * @param string $synonymSetName
     * @param ApiCall $apiCall
     */
    public function __construct(string $synonymSetName, ApiCall $apiCall)
    {
        $this->synonymSetName = $synonymSetName;
        $this->apiCall        = $apiCall;
    }

    /**
     * @param $id
     *
     * @return mixed
     */
    public function __get($id)
    {
        if (isset($this->{$id})) {
            return $this->{$id};
        }

        if (!isset($this->typesenseSynonymSetItems[$id])) {
            $this->typesenseSynonymSetItems[$id] = new SynonymSetItems($this->synonymSetName, $this->apiCall);
        }

        return $this->typesenseSynonymSetItems[$id];
    }

    /**
     * @return string
     */
    private function endPointPath(): string
    {
        return sprintf(
            '%s/%s',
            SynonymSets::RESOURCE_PATH,
            encodeURIComponent($this->synonymSetName)
        );
    }

    /**
     * Create or update a synonym set with the given name.
     *
     * @example
     * $client->synonymSets['my-set']->upsert(['items' => [['id' => 'syn-1', 'synonyms' => ['nyc', 'new york']]]])
     *
     * @see https://typesense.org/docs/latest/api/synonyms.html
     *
     * @param array $params
     *
     * @return array
     * @throws TypesenseClientError|HttpClientException
     */
    public function upsert(array $params): array
    {
        return $this->apiCall->put($this->endPointPath(), $params);
    }

    /**
     * Retrieve a specific synonym set by its name.
     *
     * @example
     * $client->synonymSets['my-set']->retrieve()
     *
     * @see https://typesense.org/docs/latest/api/synonyms.html
     *
     * @return array
     * @throws TypesenseClientError|HttpClientException
     */
    public function retrieve(): array
    {
        return $this->apiCall->get($this->endPointPath(), []);
    }

    /**
     * Delete a specific synonym set by its name.
     *
     * @example
     * $client->synonymSets['my-set']->delete()
     *
     * @see https://typesense.org/docs/latest/api/synonyms.html
     *
     * @return array
     * @throws TypesenseClientError|HttpClientException
     */
    public function delete(): array
    {
        return $this->apiCall->delete($this->endPointPath());
    }

    /**
     * Access the items in this synonym set. Use the returned object as an array to access
     * a single item by ID, or call `retrieve()` to list all items.
     *
     * @example
     * $client->synonymSets['my-set']->getItems()->retrieve()
     * @example
     * $client->synonymSets['my-set']->getItems()['syn-1']->retrieve()
     *
     * @see https://typesense.org/docs/latest/api/synonyms.html
     *
     * @return SynonymSetItems
     */
    public function getItems(): SynonymSetItems
    {
        return $this->__get('items');
    }
}