typesense-php/src/Stopwords.php at master · typesense/typesense-php · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
<?php

namespace Typesense;

use Http\Client\Exception as HttpClientException;
use Typesense\Exceptions\TypesenseClientError;

/**
 * Class Stopwords
 *
 * @package \Typesense
 * @date    4/5/20
 * @author  Abdullah Al-Faqeir <abdullah@devloops.net>
 */
class Stopwords
{
    /**
     * @var ApiCall
     */
    private $apiCall;

    public const STOPWORDS_PATH = '/stopwords';

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

    /**
     * Retrieve the details of a stopwords set, given its name.
     *
     * @example
     * $client->stopwords->get('en')
     *
     * @see https://typesense.org/docs/latest/api/stopwords.html
     *
     * @return array|string
     * @throws HttpClientException
     * @throws TypesenseClientError
     */
    public function get(string $stopwordsName)
    {
        return $this->apiCall->get(
            $this->endpointPath($stopwordsName),
            []
        );
    }

    /**
     * Retrieve the details of all stopwords sets.
     *
     * @example
     * $client->stopwords->getAll()
     *
     * @see https://typesense.org/docs/latest/api/stopwords.html
     *
     * @return array|string
     * @throws HttpClientException
     * @throws TypesenseClientError
     */
    public function getAll()
    {
        return $this->apiCall->get(static::STOPWORDS_PATH, []);
    }

    /**
     * Upsert a stopwords set. The set's name must be provided as the `name` key on the array.
     *
     * @example
     * $client->stopwords->put(['name' => 'en', 'stopwords' => ['a', 'the']])
     *
     * @see https://typesense.org/docs/latest/api/stopwords.html
     *
     * @param array $stopwordSet
     *
     * @return array
     * @throws HttpClientException
     * @throws TypesenseClientError
     */
    public function put(array $stopwordSet)
    {
        return $this->apiCall->put($this->endpointPath($stopwordSet['name']), $stopwordSet);
    }

    /**
     * Permanently deletes a stopwords set, given its name.
     *
     * @example
     * $client->stopwords->delete('en')
     *
     * @see https://typesense.org/docs/latest/api/stopwords.html
     *
     * @param $stopwordsName
     * @return array
     * @throws HttpClientException
     * @throws TypesenseClientError
     */
    public function delete($stopwordsName)
    {
        return $this->apiCall->delete(
            $this->endpointPath($stopwordsName)
        );
    }

    /**
     * @param $stopwordsName
     * @return string
     */
    private function endpointPath($stopwordsName)
    {
        return sprintf(
            '%s/%s',
            static::STOPWORDS_PATH,
            encodeURIComponent($stopwordsName)
        );
    }
}