bardex /
elastic-query
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like Query often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Query, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 6 | class Query implements \JsonSerializable |
||
| 7 | { |
||
| 8 | /** |
||
| 9 | * @var \Elasticsearch\Client $client |
||
| 10 | */ |
||
| 11 | protected $elastic; |
||
| 12 | |||
| 13 | /** |
||
| 14 | * Параметры запроса |
||
| 15 | * @var array |
||
| 16 | */ |
||
| 17 | protected $params=[]; |
||
| 18 | |||
| 19 | /** |
||
| 20 | * сколько всего в индексе ES строк удовлетворяющих параметрам поиска |
||
| 21 | * @var integer $totalResults |
||
| 22 | */ |
||
| 23 | protected $totalResults; |
||
| 24 | |||
| 25 | /** |
||
| 26 | * Логгер |
||
| 27 | * @var \Psr\Log\LoggerInterface $logger |
||
| 28 | */ |
||
| 29 | protected $logger; |
||
| 30 | |||
| 31 | |||
| 32 | public function __construct(\Elasticsearch\Client $elastic) |
||
| 37 | |||
| 38 | |||
| 39 | public function setLogger(\Psr\Log\LoggerInterface $logger) |
||
| 44 | |||
| 45 | |||
| 46 | /** |
||
| 47 | * Установить имя индекса для поиска |
||
| 48 | * @param $index |
||
| 49 | * @return $this |
||
| 50 | */ |
||
| 51 | public function setIndex($index) |
||
| 56 | |||
| 57 | |||
| 58 | /** |
||
| 59 | * Установить имя типа для поиска |
||
| 60 | * @param $type |
||
| 61 | * @return $this |
||
| 62 | */ |
||
| 63 | public function setType($type) |
||
| 68 | |||
| 69 | |||
| 70 | /** |
||
| 71 | * Выводить перечисленные поля. |
||
| 72 | * (не обязательный метод, по-умолчанию, выводятся все) |
||
| 73 | * Методы select() и exclude() могут работать совместно. |
||
| 74 | * @param array $fields |
||
| 75 | * @return $this; |
||
|
|
|||
| 76 | * @example $q->select(['id', 'title', 'brand.id', 'brand.title']); |
||
| 77 | */ |
||
| 78 | public function select(array $fields) |
||
| 83 | |||
| 84 | |||
| 85 | /** |
||
| 86 | * Добавить в результаты вычисляемое поле, на скриптовом языке painless или groovy |
||
| 87 | * ``` |
||
| 88 | * $q->addScriptField('pricefactor', 'return doc["product.price"].value * params.factor', ['factor' => 2]); |
||
| 89 | * ``` |
||
| 90 | * Использование параметров рекомендуется, для увеличения производительности и эффективности компилирования скриптов. |
||
| 91 | * @param string $fieldName - имя поля в результатах (если такое поле уже есть в документе, то оно будет заменено) |
||
| 92 | * @param string $script - текст скрипта |
||
| 93 | * @param array $params - параметры которые нужно передать в скрипт |
||
| 94 | * @param string $lang - язык скрипта painless или groovy |
||
| 95 | * @link https://www.elastic.co/guide/en/elasticsearch/reference/5.0/search-request-script-fields.html |
||
| 96 | * @return self $this |
||
| 97 | */ |
||
| 98 | public function addScriptField($fieldName, $script, array $params = null, $lang = 'painless') |
||
| 112 | |||
| 113 | |||
| 114 | /** |
||
| 115 | * Удалить из выборки поля. |
||
| 116 | * (не обязательный метод, по-умолчанию, выводятся все) |
||
| 117 | * Методы select() и exclude() могут работать совместно. |
||
| 118 | * @param array $fields |
||
| 119 | * @return $this; |
||
| 120 | * @example $q->exclude(['anons', '*.anons']); |
||
| 121 | */ |
||
| 122 | public function exclude(array $fields) |
||
| 127 | |||
| 128 | |||
| 129 | /** |
||
| 130 | * Добавить фильтр в raw формате, если готовые методы фильтрации не подходят. |
||
| 131 | * Для удобства используй готовые методы фильтрации: where(), whereIn(), whereBetween(), whereMatch() |
||
| 132 | * whereLess() и другие методы where*() |
||
| 133 | * |
||
| 134 | * @param $type - тип фильтрации (term|terms|match|range) |
||
| 135 | * @param $filter - сам фильтр |
||
| 136 | * @link https://www.elastic.co/guide/en/elasticsearch/reference/5.0/query-dsl-terms-query.html |
||
| 137 | * @return $this |
||
| 138 | */ |
||
| 139 | public function addFilter($type, $filter) |
||
| 149 | |||
| 150 | |||
| 151 | /** |
||
| 152 | * Добавить фильтр ТОЧНОГО совпадения, |
||
| 153 | * этот фильтр не влияет на поле релевантности _score. |
||
| 154 | * |
||
| 155 | * @param $field - поле по которому фильтруем (id, page.categoryId...) |
||
| 156 | * @param $value - искомое значение |
||
| 157 | * @example $q->where('channel', 1)->where('page.categoryId', 10); |
||
| 158 | * @return $this; |
||
| 159 | */ |
||
| 160 | public function where($field, $value) |
||
| 165 | |||
| 166 | |||
| 167 | /** |
||
| 168 | * Добавить фильтр совпадения хотя бы одного значения из набора, |
||
| 169 | * этот фильтр не влияет на поле релевантности _score. |
||
| 170 | * |
||
| 171 | * @param $field - поле по которому фильтруем |
||
| 172 | * @param $values - массив допустимых значений |
||
| 173 | * @example $q->whereIn('channel', [1,2,3])->whereIn('page.categoryId', [10,11]); |
||
| 174 | * @return $this; |
||
| 175 | */ |
||
| 176 | public function whereIn($field, array $values) |
||
| 183 | |||
| 184 | |||
| 185 | /** |
||
| 186 | * Добавить фильтр вхождения значение в диапазон (обе границы включительно) |
||
| 187 | * Можно искать по диапазону дат |
||
| 188 | * этот фильтр не влияет на поле релевантности _score. |
||
| 189 | * |
||
| 190 | * @param $field - поле, по которому фильтруем |
||
| 191 | * @param $min - нижняя граница диапазона (включительно) |
||
| 192 | * @param $max - верхняя граница диапазона (включительно) |
||
| 193 | * @param $dateFormat - необязательное поле описание формата даты |
||
| 194 | * @example $q->whereBetween('created', '01/01/2010','01/01/2011', 'dd/MM/yyyy'); |
||
| 195 | * @link https://www.elastic.co/guide/en/elasticsearch/reference/5.0/query-dsl-range-query.html |
||
| 196 | * @return $this; |
||
| 197 | */ |
||
| 198 | View Code Duplication | public function whereBetween($field, $min, $max, $dateFormat = null) |
|
| 207 | |||
| 208 | |||
| 209 | /** |
||
| 210 | * Добавить в фильтр сложное условие с вычислениями, на скриптовом языке painless или groovy |
||
| 211 | * ``` |
||
| 212 | * $q->whereScript('doc["id"].value == params.id', ['id' => 5169]); |
||
| 213 | * ``` |
||
| 214 | * Использование параметров рекомендуется, для увеличения производительности и эффективности компилирования скриптов |
||
| 215 | * |
||
| 216 | * @param string $script - строка скрипта |
||
| 217 | * @param array $params - параматеры для скрипта |
||
| 218 | * @param string $lang - язык painless или groovy |
||
| 219 | * @return self $this; |
||
| 220 | * @link https://www.elastic.co/guide/en/elasticsearch/reference/5.0/query-dsl-script-query.html |
||
| 221 | * @link https://www.elastic.co/guide/en/elasticsearch/reference/5.0/modules-scripting-painless.html |
||
| 222 | */ |
||
| 223 | public function whereScript($script, array $params = null, $lang = 'painless') |
||
| 237 | |||
| 238 | |||
| 239 | /** |
||
| 240 | * добавить фильтр "больше или равно" |
||
| 241 | * @param $field |
||
| 242 | * @param $value |
||
| 243 | * @param null $dateFormat |
||
| 244 | * @return $this |
||
| 245 | */ |
||
| 246 | View Code Duplication | public function whereGreaterOrEqual($field, $value, $dateFormat = null) |
|
| 255 | |||
| 256 | /** |
||
| 257 | * добавить фильтр "больше чем" |
||
| 258 | * @param $field |
||
| 259 | * @param $value |
||
| 260 | * @param null $dateFormat |
||
| 261 | * @return $this |
||
| 262 | */ |
||
| 263 | View Code Duplication | public function whereGreater($field, $value, $dateFormat = null) |
|
| 272 | |||
| 273 | /** |
||
| 274 | * добавить фильтр "меньше или равно" |
||
| 275 | * @param $field |
||
| 276 | * @param $value |
||
| 277 | * @param null $dateFormat |
||
| 278 | * @return $this |
||
| 279 | */ |
||
| 280 | View Code Duplication | public function whereLessOrEqual($field, $value, $dateFormat = null) |
|
| 289 | |||
| 290 | /** |
||
| 291 | * добавить фильтр "меньше чем" |
||
| 292 | * @param $field |
||
| 293 | * @param $value |
||
| 294 | * @param null $dateFormat |
||
| 295 | * @return $this |
||
| 296 | */ |
||
| 297 | View Code Duplication | public function whereLess($field, $value, $dateFormat = null) |
|
| 306 | |||
| 307 | |||
| 308 | /** |
||
| 309 | * Добавить фильтр полнотекстового поиска |
||
| 310 | * этот фильтр влияет на поле релевантности _score. |
||
| 311 | * |
||
| 312 | * @param $field - поле по которому фильтруем |
||
| 313 | * @param $text - поисковая фраза |
||
| 314 | * @example $q->whereMatch('title', 'яблочная слойка')->setOrderBy('_score', 'desc'); |
||
| 315 | * @return $this; |
||
| 316 | */ |
||
| 317 | public function whereMatch($field, $text) |
||
| 330 | |||
| 331 | |||
| 332 | /** |
||
| 333 | * Добавить поле сортировки. |
||
| 334 | * Для сортировки по релевантности существует псевдополе _score (значение больше - релевантность лучше) |
||
| 335 | * @param $field - поле сортировки |
||
| 336 | * @param string $order - направление сортировки asc|desc |
||
| 337 | * @example $q->addOrderBy('_score', 'desc'); |
||
| 338 | * @return $this |
||
| 339 | */ |
||
| 340 | public function addOrderBy($field, $order = 'asc') |
||
| 350 | |||
| 351 | |||
| 352 | /** |
||
| 353 | * Установить поле сортировки. |
||
| 354 | * Для сортировки по релевантности существует псевдополе _score (значение больше - релевантность лучше) |
||
| 355 | * @param $field - поле сортировки |
||
| 356 | * @param string $order - направление сортировки asc|desc |
||
| 357 | * @example $q->setOrderBy('_score', 'desc'); |
||
| 358 | * @return $this |
||
| 359 | */ |
||
| 360 | public function setOrderBy($field, $order = 'asc') |
||
| 366 | |||
| 367 | |||
| 368 | /** |
||
| 369 | * Установить лимиты выборки |
||
| 370 | * @param $limit - сколько строк выбирать |
||
| 371 | * @param int $offset - сколько строк пропустить |
||
| 372 | * @return $this; |
||
| 373 | */ |
||
| 374 | public function limit($limit, $offset = 0) |
||
| 380 | |||
| 381 | |||
| 382 | public function fetchRaw() |
||
| 415 | |||
| 416 | |||
| 417 | /** |
||
| 418 | * Выполнить запрос к ES и вернуть результаты поиска. |
||
| 419 | * Внимание! для экономии памяти результаты не хранятся в этом объекте, а сразу возвращаются. |
||
| 420 | * Чтобы получить кол-во строк всего найденных в индексе (без учета лимита), используй метод getTotalResults() |
||
| 421 | * @return array - возвращает набор документов |
||
| 422 | */ |
||
| 423 | public function fetchAll() |
||
| 445 | |||
| 446 | |||
| 447 | /** |
||
| 448 | * Выполнить запрос к ES и вернуть первый результат. |
||
| 449 | * Внимание! для экономии памяти результаты не хранятся в этом объекте, а сразу возвращаются. |
||
| 450 | * Чтобы получить кол-во строк всего найденных в индексе (без учета лимита), используй метод getTotalResults() |
||
| 451 | * @return array|null возращает первый найденный документ или null. |
||
| 452 | */ |
||
| 453 | public function fetchOne() |
||
| 463 | |||
| 464 | |||
| 465 | /** |
||
| 466 | * Количество документов всего найденных в индексе, для последнего запроса. |
||
| 467 | * @return int |
||
| 468 | */ |
||
| 469 | public function getTotalResults() |
||
| 473 | |||
| 474 | |||
| 475 | /** |
||
| 476 | * Собрать запрос |
||
| 477 | * @return array |
||
| 478 | */ |
||
| 479 | public function getQuery() |
||
| 489 | |||
| 490 | |||
| 491 | public function jsonSerialize() { |
||
| 494 | |||
| 495 | |||
| 496 | /** |
||
| 497 | * Получить JSON-дамп запроса для отладки |
||
| 498 | * @return string |
||
| 499 | */ |
||
| 500 | public function getJsonQuery() |
||
| 504 | } |
Loading history...
This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.