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 Explain
24 * Elasticsearch API name explain
25 *
26 * NOTE: this file is autogenerated using util/GenerateEndpoints.php
27 * and Elasticsearch 7.16.0-SNAPSHOT (dfc9a8e7563ed5f24b5210ed21ed92ae182cd0ee)
28 */
29class Explain extends AbstractEndpoint
30{
31
32    public function getURI(): string
33    {
34        if (isset($this->id) !== true) {
35            throw new RuntimeException(
36                'id is required for explain'
37            );
38        }
39        $id = $this->id;
40        if (isset($this->index) !== true) {
41            throw new RuntimeException(
42                'index is required for explain'
43            );
44        }
45        $index = $this->index;
46        $type = $this->type ?? null;
47        if (isset($type)) {
48            @trigger_error('Specifying types in urls has been deprecated', E_USER_DEPRECATED);
49        }
50
51        if (isset($type)) {
52            return "/$index/$type/$id/_explain";
53        }
54        return "/$index/_explain/$id";
55    }
56
57    public function getParamWhitelist(): array
58    {
59        return [
60            'analyze_wildcard',
61            'analyzer',
62            'default_operator',
63            'df',
64            'stored_fields',
65            'lenient',
66            'preference',
67            'q',
68            'routing',
69            '_source',
70            '_source_excludes',
71            '_source_includes'
72        ];
73    }
74
75    public function getMethod(): string
76    {
77        return isset($this->body) ? 'POST' : 'GET';
78    }
79
80    public function setBody($body): Explain
81    {
82        if (isset($body) !== true) {
83            return $this;
84        }
85        $this->body = $body;
86
87        return $this;
88    }
89}
90