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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
|
<?php
/**
* NOTE: the following class has been copied from elastica 2.3.1 :
* https://github.com/ruflin/Elastica/blob/2.3.1/lib/Elastica/Query/FuzzyLikeThis.php
* (few modifications have been made to comply with phpcs rules used by this extension)
* It is intended to be used as a temporary workaround with the wmf extra
* elasticsearch plugin with elasticsearch 2.x.
*
* The MIT License (MIT)
*
* Copyright (c) 2014 Nicolas Ruflin
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*
* (c.f. https://github.com/ruflin/Elastica/blob/2.3.1/LICENSE.txt)
*
* @file
* @license MIT
* @ingroup TTMServer
*/
/**
* Fuzzy Like This query.
*
* @author Raul Martinez, Jr <juneym@gmail.com>
*
* @link https://www.elastic.co/guide/en/elasticsearch/reference/1.7/query-dsl-flt-query.html
*
* @since 2016.05
* @ingroup TTMServer
*/
class FuzzyLikeThis extends \Elastica\Query\AbstractQuery {
// phpcs:disable PSR2.Classes.PropertyDeclaration.Underscore
/**
* Field names.
*
* @var array Field names
*/
protected $_fields = [];
/**
* Like text.
*
* @var string Like text
*/
protected $_likeText = '';
/**
* Ignore term frequency.
*
* @var bool ignore term frequency
*/
protected $_ignoreTF = false;
/**
* Max query terms value.
*
* @var int Max query terms value
*/
protected $_maxQueryTerms = 25;
/**
* fuzziness.
*
* @var int fuzziness
*/
protected $_fuzziness = 2;
/**
* Prefix Length.
*
* @var int Prefix Length
*/
protected $_prefixLength = 0;
/**
* Analyzer.
*
* @var string Analyzer
*/
protected $_analyzer;
// phpcs:enable
/**
* Adds field to flt query.
*
* @param array $fields Field names
*
* @return $this
*/
public function addFields( array $fields ) {
$this->_fields = $fields;
return $this;
}
/**
* Set the "like_text" value.
*
* @param string $text
*
* @return $this
*/
public function setLikeText( $text ) {
$text = trim( $text );
$this->_likeText = $text;
return $this;
}
/**
* Set the "ignore_tf" value (ignore term frequency).
*
* @param bool $ignoreTF
*
* @return $this
*/
public function setIgnoreTF( $ignoreTF ) {
$this->_ignoreTF = (bool)$ignoreTF;
return $this;
}
/**
* Set the minimum similarity.
*
* @param int $value
*
* @return $this
*/
public function setFuzziness( $value ) {
$value = (int)$value;
$this->_fuzziness = $value;
return $this;
}
/**
* Set Prefix Length.
*
* @param int $value Prefix length
*
* @return $this
*/
public function setPrefixLength( $value ) {
$this->_prefixLength = (int)$value;
return $this;
}
/**
* Set max_query_terms.
*
* @param int $value Max query terms value
*
* @return $this
*/
public function setMaxQueryTerms( $value ) {
$this->_maxQueryTerms = (int)$value;
return $this;
}
/**
* Set analyzer.
*
* @param string $text Analyzer text
*
* @return $this
*/
public function setAnalyzer( $text ) {
$text = trim( $text );
$this->_analyzer = $text;
return $this;
}
/**
* Converts fuzzy like this query to array.
*
* @return array Query array
*
* @see \Elastica\Query\AbstractQuery::toArray()
*/
public function toArray() {
$args = [];
if ( !empty( $this->_fields ) ) {
$args['fields'] = $this->_fields;
}
if ( !empty( $this->_analyzer ) ) {
$args['analyzer'] = $this->_analyzer;
}
$args['fuzziness'] = ( $this->_fuzziness > 0 ) ? $this->_fuzziness : 0;
$args['like_text'] = $this->_likeText;
$args['prefix_length'] = $this->_prefixLength;
$args['ignore_tf'] = $this->_ignoreTF;
$args['max_query_terms'] = $this->_maxQueryTerms;
$data = parent::toArray();
$args = array_merge( $args, $data['fuzzy_like_this'] );
return [ 'fuzzy_like_this' => $args ];
}
}
|