Completed
Push — master ( 9e3e67...1dbefb )
by Jeroen
08:30 queued 11s
created

SearchBundle/Provider/ElasticaProvider.php (3 issues)

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

1
<?php
2
3
namespace Kunstmaan\SearchBundle\Provider;
4
5
use Elastica\Client;
6
use Elastica\Document;
7
use Elastica\Index;
8
9
class ElasticaProvider implements SearchProviderInterface
10
{
11
    /** @var Client The Elastica client */
12
    private $client;
13
14
    /** @var array An array of Elastica search nodes (each item in the array needs a host and port) */
15
    private $nodes = array();
16
17
    /**
18
     * @return Client
19
     */
20
    public function getClient()
21
    {
22
        if (!$this->client instanceof Client) {
23
            $this->client = new Client(
24
                array('connections' => $this->nodes,
25
                )
26
            );
27
28
            //NEXT_MAJOR: remove checks and update ruflin/elastica dependency constraints
29
            if (!class_exists(\Elastica\Mapping::class)) {
30
                @trigger_error('Using a version of ruflin/elastica below v7.0 is deprecated since KunstmaanSearchBundle 5.6 and support for older versions will be removed in KunstmaanSearchBundle 6.0. Upgrade to ruflin/elastica and elasticsearch v7 instead.', E_USER_DEPRECATED);
31
            }
32
        }
33
34
        return $this->client;
35
    }
36
37
    /**
38
     * @return string
39
     */
40
    public function getName()
41
    {
42
        return 'Elastica';
43
    }
44
45
    /**
46
     * @param string $indexName
47
     *
48
     * @return \Elastica\Index
49
     */
50
    public function createIndex($indexName)
51
    {
52
        return new Index($this->getClient(), $indexName);
53
    }
54
55
    /**
56
     * @param string $indexName
57
     *
58
     * @return \Elastica\Index
59
     */
60
    public function getIndex($indexName)
61
    {
62
        return $this->getClient()->getIndex($indexName);
63
    }
64
65
    /**
66
     * @param string $uid
67
     * @param array  $document
68
     * @param string $indexName
69
     * @param string $indexType
70
     *
71
     * @return \Elastica\Document
72
     */
73
    public function createDocument($uid, $document, $indexName = '', $indexType = '')
74
    {
75
        if (method_exists(Document::class, 'setType')) {
76
            // @phpstan-ignore-next-line
77
            return new Document($uid, $document, $indexType, $indexName);
0 ignored issues
show
The call to Document::__construct() has too many arguments starting with $indexName.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
78
        }
79
80
        return new Document($uid, $document, $indexName);
81
    }
82
83
    /**
84
     * @param string $indexName
85
     * @param string $indexType
86
     * @param array  $document
87
     * @param string $uid
88
     *
89
     * @return \Elastica\Response
90
     */
91 View Code Duplication
    public function addDocument($indexName, $indexType, $document, $uid)
92
    {
93
        $doc = $this->createDocument($uid, $document);
94
        $index = $this->getClient()->getIndex($indexName);
95
        if (method_exists($index, 'getType')) {
96
            return $index->getType($indexType)->addDocument($doc);
0 ignored issues
show
The method getType() does not seem to exist on object<Elastica\Index>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
97
        }
98
99
        return $index->addDocument($doc);
100
    }
101
102
    /**
103
     * @param array  $docs
104
     * @param string $indexName
105
     * @param string $indexType
106
     *
107
     * @return \Elastica\Bulk\ResponseSet
108
     */
109
    public function addDocuments($docs, $indexName = '', $indexType = '')
110
    {
111
        // Ignore indexName & indexType for Elastica, they have already been set in the document...
112
        return $this->getClient()->addDocuments($docs);
113
    }
114
115
    /**
116
     * @param string $indexName
117
     * @param string $indexType
118
     * @param string $uid
119
     *
120
     * @return \Elastica\Bulk\ResponseSet
121
     */
122
    public function deleteDocument($indexName, $indexType, $uid)
123
    {
124
        $ids = array($uid);
125
126
        return $this->deleteDocuments($indexName, $indexType, $ids);
127
    }
128
129
    /**
130
     * @param string $indexName
131
     * @param string $indexType
132
     * @param array  $ids
133
     *
134
     * @return \Elastica\Bulk\ResponseSet
135
     */
136 View Code Duplication
    public function deleteDocuments($indexName, $indexType, array $ids)
137
    {
138
        $index = $this->getIndex($indexName);
139
140
        if (method_exists($index, 'getType')) {
141
            $type = $index->getType($indexType);
0 ignored issues
show
The method getType() does not seem to exist on object<Elastica\Index>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
142
143
            return $this->getClient()->deleteIds($ids, $index, $type);
144
        }
145
146
        return $this->getClient()->deleteIds($ids, $index);
147
    }
148
149
    /**
150
     * @param string $indexName
151
     *
152
     * @return \Elastica\Response|null
153
     */
154
    public function deleteIndex($indexName)
155
    {
156
        $index = $this->getIndex($indexName);
157
        if ($index->exists()) {
158
            return $index->delete();
159
        }
160
161
        return null;
162
    }
163
164
    /**
165
     * @param string      $host
166
     * @param int         $port
167
     * @param string|null $username
168
     * @param string|null $password
169
     */
170
    public function addNode($host, $port, $username = null, $password = null)
171
    {
172
        foreach ($this->nodes as $node) {
173
            if ($node['host'] === $host && $node['port'] === $port) {
174
                return;
175
            }
176
        }
177
178
        $authHeader = null;
179
        if (null !== $username && $password !== null) {
180
            $authHeader = array('Authorization' => 'Basic ' . base64_encode($username . ':' . $password));
181
        }
182
183
        $this->nodes[] = array('host' => $host, 'port' => $port, 'headers' => $authHeader);
184
    }
185
186
    /**
187
     * @param array $nodes
188
     */
189
    public function setNodes($nodes)
190
    {
191
        $this->nodes = $nodes;
192
    }
193
194
    /**
195
     * @return array
196
     */
197
    public function getNodes()
198
    {
199
        return $this->nodes;
200
    }
201
}
202