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:
| 1 | <?php namespace Bardex\Elastic; |
||
| 3 | class Where |
||
| 4 | { |
||
| 5 | protected $field; |
||
| 6 | |||
| 7 | protected $query; |
||
| 8 | |||
| 9 | |||
| 10 | public function __construct(SearchQuery $query) |
||
| 14 | |||
| 15 | /** |
||
| 16 | * @param mixed $field |
||
| 17 | */ |
||
| 18 | public function setField($field) |
||
| 22 | |||
| 23 | /** |
||
| 24 | * @param $value |
||
| 25 | * @return SearchQuery |
||
| 26 | */ |
||
| 27 | public function equal($value) |
||
| 32 | |||
| 33 | /** |
||
| 34 | * Добавить фильтр совпадения хотя бы одного значения из набора, этот фильтр не влияет на поле релевантности _score. |
||
| 35 | * |
||
| 36 | * @param $values - массив допустимых значений |
||
| 37 | * @example $query->where('channel')->in([1,2,3])->where('page.categoryId')->in([10,11]); |
||
| 38 | * @return SearchQuery; |
||
|
|
|||
| 39 | */ |
||
| 40 | View Code Duplication | public function in(array $values) |
|
| 47 | |||
| 48 | /** |
||
| 49 | * Добавить фильтр вхождения значение в диапазон (обе границы включительно). |
||
| 50 | * Можно искать по диапазону дат. |
||
| 51 | * Этот фильтр не влияет на поле релевантности _score. |
||
| 52 | * |
||
| 53 | * @param $min - нижняя граница диапазона (включительно) |
||
| 54 | * @param $max - верхняя граница диапазона (включительно) |
||
| 55 | * @param $dateFormat - необязательное поле описание формата даты |
||
| 56 | * @link https://www.elastic.co/guide/en/elasticsearch/reference/5.0/query-dsl-range-query.html |
||
| 57 | * @return SearchQuery; |
||
| 58 | */ |
||
| 59 | public function between($min, $max, $dateFormat = null) |
||
| 64 | |||
| 65 | /** |
||
| 66 | * Добавить фильтр "больше или равно" |
||
| 67 | * @param $value - значение |
||
| 68 | * @param null $dateFormat - необязательный формат даты |
||
| 69 | * @return SearchQuery |
||
| 70 | */ |
||
| 71 | public function greaterOrEqual($value, $dateFormat = null) |
||
| 76 | |||
| 77 | /** |
||
| 78 | * Добавить фильтр "больше чем" |
||
| 79 | * @param $value - значение |
||
| 80 | * @param null $dateFormat - необязательный формат даты |
||
| 81 | * @return SearchQuery |
||
| 82 | */ |
||
| 83 | public function greater($value, $dateFormat = null) |
||
| 88 | |||
| 89 | /** |
||
| 90 | * Добавить фильтр "меньше или равно" |
||
| 91 | * @param $value - значение |
||
| 92 | * @param null $dateFormat - необязательный формат даты |
||
| 93 | * @return SearchQuery |
||
| 94 | */ |
||
| 95 | public function lessOrEqual($value, $dateFormat = null) |
||
| 100 | |||
| 101 | |||
| 102 | /** |
||
| 103 | * Добавить фильтр "меньше чем" |
||
| 104 | * @param $value - значение |
||
| 105 | * @param null $dateFormat - - необязательный формат даты |
||
| 106 | * @return SearchQuery |
||
| 107 | */ |
||
| 108 | public function less($value, $dateFormat = null) |
||
| 113 | |||
| 114 | |||
| 115 | protected function range($params, $dateFormat = null) |
||
| 123 | |||
| 124 | |||
| 125 | /** |
||
| 126 | * Добавить фильтр полнотекстового поиска, этот фильтр влияет на поле релевантности _score. |
||
| 127 | * |
||
| 128 | * @param $text - поисковая фраза |
||
| 129 | * @return SearchQuery; |
||
| 130 | */ |
||
| 131 | View Code Duplication | public function match($text) |
|
| 143 | |||
| 144 | /** |
||
| 145 | * Поле существует и имеет не null значение |
||
| 146 | * @return SearchQuery |
||
| 147 | */ |
||
| 148 | public function exists() |
||
| 153 | |||
| 154 | /** |
||
| 155 | * @param $value |
||
| 156 | * @return SearchQuery |
||
| 157 | */ |
||
| 158 | public function not($value) |
||
| 163 | |||
| 164 | |||
| 165 | /** |
||
| 166 | * @param $values - массив допустимых значений |
||
| 167 | * @example $query->where('channel')->notIn([1,2,3]); |
||
| 168 | * @return SearchQuery; |
||
| 169 | */ |
||
| 170 | View Code Duplication | public function notIn(array $values) |
|
| 177 | |||
| 178 | |||
| 179 | /** |
||
| 180 | * @param $min |
||
| 181 | * @param $max |
||
| 182 | * @param null $dateFormat |
||
| 183 | * @return SearchQuery |
||
| 184 | */ |
||
| 185 | public function notBetween($min, $max, $dateFormat = null) |
||
| 194 | |||
| 195 | /** |
||
| 196 | * @param $text |
||
| 197 | * @return SearchQuery |
||
| 198 | */ |
||
| 199 | View Code Duplication | public function notMatch($text) |
|
| 211 | |||
| 212 | /** |
||
| 213 | * @return SearchQuery |
||
| 214 | */ |
||
| 215 | public function notExists() |
||
| 220 | |||
| 221 | /** |
||
| 222 | * маска должна указываться в нижнем регистре, см. оф.документацию |
||
| 223 | * Внимание! низкая производительность |
||
| 224 | * @param $mask |
||
| 225 | * @return SearchQuery |
||
| 226 | * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-wildcard-query.html |
||
| 227 | */ |
||
| 228 | public function wildcard($mask) |
||
| 233 | |||
| 234 | /** |
||
| 235 | * Регулярное выражение должно указываться в нижнем регистре, см. оф.документацию |
||
| 236 | * Внимание! низкая производительность |
||
| 237 | * @param $regexp |
||
| 238 | * @return SearchQuery |
||
| 239 | * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-regexp-query.html |
||
| 240 | */ |
||
| 241 | public function regexp($regexp, $flags = null, $maxDeterminizedStates = null) |
||
| 256 | } |
||
| 257 |
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.