1<?php
2/**
3 * Elasticsearch PHP client
4 *
5 * @link      https://github.com/elastic/elasticsearch-php/
6 * @copyright Copyright (c) Elasticsearch B.V (https://www.elastic.co)
7 * @license   http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0
8 * @license   https://www.gnu.org/licenses/lgpl-2.1.html GNU Lesser General Public License, Version 2.1
9 *
10 * Licensed to Elasticsearch B.V under one or more agreements.
11 * Elasticsearch B.V licenses this file to you under the Apache 2.0 License or
12 * the GNU Lesser General Public License, Version 2.1, at your option.
13 * See the LICENSE file in the project root for more information.
14 */
15declare(strict_types = 1);
16
17namespace Elasticsearch\Endpoints;
18
19use Elasticsearch\Common\Exceptions\RuntimeException;
20use Elasticsearch\Endpoints\AbstractEndpoint;
21
22/**
23 * Class TermVectors
24 * Elasticsearch API name termvectors
25 *
26 * NOTE: this file is autogenerated using util/GenerateEndpoints.php
27 * and Elasticsearch 7.16.0-SNAPSHOT (dfc9a8e7563ed5f24b5210ed21ed92ae182cd0ee)
28 */
29class TermVectors extends AbstractEndpoint
30{
31
32    public function getURI(): string
33    {
34        if (isset($this->index) !== true) {
35            throw new RuntimeException(
36                'index is required for termvectors'
37            );
38        }
39        $index = $this->index;
40        $id = $this->id ?? null;
41        $type = $this->type ?? null;
42        if (isset($type)) {
43            @trigger_error('Specifying types in urls has been deprecated', E_USER_DEPRECATED);
44        }
45
46        if (isset($type) && isset($id)) {
47            return "/$index/$type/$id/_termvectors";
48        }
49        if (isset($type)) {
50            return "/$index/$type/_termvectors";
51        }
52        if (isset($id)) {
53            return "/$index/_termvectors/$id";
54        }
55        return "/$index/_termvectors";
56    }
57
58    public function getParamWhitelist(): array
59    {
60        return [
61            'term_statistics',
62            'field_statistics',
63            'fields',
64            'offsets',
65            'positions',
66            'payloads',
67            'preference',
68            'routing',
69            'realtime',
70            'version',
71            'version_type'
72        ];
73    }
74
75    public function getMethod(): string
76    {
77        return isset($this->body) ? 'POST' : 'GET';
78    }
79
80    public function setBody($body): TermVectors
81    {
82        if (isset($body) !== true) {
83            return $this;
84        }
85        $this->body = $body;
86
87        return $this;
88    }
89}
90