Complex classes like Search 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 Search, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
35 | class Search |
||
36 | { |
||
37 | /** |
||
38 | * If you don’t need to track the total number of hits at all you can improve |
||
39 | * query times by setting this option to false. Defaults to true. |
||
40 | * |
||
41 | * @var bool |
||
42 | */ |
||
43 | private $trackTotalHits; |
||
44 | |||
45 | /** |
||
46 | * To retrieve hits from a certain offset. Defaults to 0. |
||
47 | * |
||
48 | * @var int |
||
49 | */ |
||
50 | private $from; |
||
51 | |||
52 | /** |
||
53 | * The number of hits to return. Defaults to 10. If you do not care about getting some |
||
54 | * hits back but only about the number of matches and/or aggregations, setting the value |
||
55 | * to 0 will help performance. |
||
56 | * |
||
57 | * @var int |
||
58 | */ |
||
59 | private $size; |
||
60 | |||
61 | /** |
||
62 | * Allows to control how the _source field is returned with every hit. By default |
||
63 | * operations return the contents of the _source field unless you have used the |
||
64 | * stored_fields parameter or if the _source field is disabled. |
||
65 | * |
||
66 | * @var bool |
||
67 | */ |
||
68 | private $source; |
||
69 | |||
70 | /** |
||
71 | * Allows to selectively load specific stored fields for each document represented by a search hit. |
||
72 | * |
||
73 | * @var array |
||
74 | */ |
||
75 | private $storedFields; |
||
76 | |||
77 | /** |
||
78 | * Allows to return a script evaluation (based on different fields) for each hit. |
||
79 | * Script fields can work on fields that are not stored, and allow to return custom |
||
80 | * values to be returned (the evaluated value of the script). Script fields can |
||
81 | * also access the actual _source document indexed and extract specific elements |
||
82 | * to be returned from it (can be an "object" type). |
||
83 | * |
||
84 | * @var array |
||
85 | */ |
||
86 | private $scriptFields; |
||
87 | |||
88 | /** |
||
89 | * Allows to return the doc value representation of a field for each hit. Doc value |
||
90 | * fields can work on fields that are not stored. Note that if the fields parameter |
||
91 | * specifies fields without docvalues it will try to load the value from the fielddata |
||
92 | * cache causing the terms for that field to be loaded to memory (cached), which will |
||
93 | * result in more memory consumption. |
||
94 | * |
||
95 | * @var array |
||
96 | */ |
||
97 | private $docValueFields; |
||
98 | |||
99 | /** |
||
100 | * Enables explanation for each hit on how its score was computed. |
||
101 | * |
||
102 | * @var bool |
||
103 | */ |
||
104 | private $explain; |
||
105 | |||
106 | /** |
||
107 | * Returns a version for each search hit. |
||
108 | * |
||
109 | * @var bool |
||
110 | */ |
||
111 | private $version; |
||
112 | |||
113 | /** |
||
114 | * Allows to configure different boost level per index when searching across more |
||
115 | * than one indices. This is very handy when hits coming from one index matter more |
||
116 | * than hits coming from another index (think social graph where each user has an index). |
||
117 | * |
||
118 | * @var array |
||
119 | */ |
||
120 | private $indicesBoost; |
||
121 | |||
122 | /** |
||
123 | * Exclude documents which have a _score less than the minimum specified in min_score. |
||
124 | * |
||
125 | * @var int |
||
126 | */ |
||
127 | private $minScore; |
||
128 | |||
129 | /** |
||
130 | * Pagination of results can be done by using the from and size but the cost becomes |
||
131 | * prohibitive when the deep pagination is reached. The index.max_result_window which |
||
132 | * defaults to 10,000 is a safeguard, search requests take heap memory and time |
||
133 | * proportional to from + size. The Scroll api is recommended for efficient deep |
||
134 | * scrolling but scroll contexts are costly and it is not recommended to use it for |
||
135 | * real time user requests. The search_after parameter circumvents this problem by |
||
136 | * providing a live cursor. The idea is to use the results from the previous page to |
||
137 | * help the retrieval of the next page. |
||
138 | * |
||
139 | * @var array |
||
140 | */ |
||
141 | private $searchAfter; |
||
142 | |||
143 | /** |
||
144 | * URI parameters alongside Request body search. |
||
145 | * |
||
146 | * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/search-uri-request.html |
||
147 | * |
||
148 | * @var array |
||
149 | */ |
||
150 | private $uriParams = []; |
||
151 | |||
152 | /** |
||
153 | * While a search request returns a single “page” of results, the scroll API can be used to retrieve |
||
154 | * large numbers of results (or even all results) from a single search request, in much the same way |
||
155 | * as you would use a cursor on a traditional database. Scrolling is not intended for real time user |
||
156 | * requests, but rather for processing large amounts of data, e.g. in order to reindex the contents |
||
157 | * of one index into a new index with a different configuration. |
||
158 | * |
||
159 | * @var string |
||
160 | */ |
||
161 | private $scroll; |
||
162 | |||
163 | /** |
||
164 | * @var OrderedSerializer |
||
165 | */ |
||
166 | private static $serializer; |
||
167 | |||
168 | /** |
||
169 | * @var SearchEndpointInterface[] |
||
170 | */ |
||
171 | private $endpoints = []; |
||
172 | |||
173 | /** |
||
174 | * Constructor to initialize static properties |
||
175 | */ |
||
176 | public function __construct() |
||
180 | |||
181 | /** |
||
182 | * Wakeup method to initialize static properties |
||
183 | */ |
||
184 | public function __wakeup() |
||
188 | |||
189 | /** |
||
190 | * Initializes the serializer |
||
191 | */ |
||
192 | private function initializeSerializer() |
||
203 | |||
204 | /** |
||
205 | * Destroys search endpoint. |
||
206 | * |
||
207 | * @param string $type Endpoint type. |
||
208 | */ |
||
209 | public function destroyEndpoint($type) |
||
213 | |||
214 | /** |
||
215 | * Adds query to the search. |
||
216 | * |
||
217 | * @param BuilderInterface $query |
||
218 | * @param string $boolType |
||
219 | * @param string $key |
||
220 | * |
||
221 | * @return $this |
||
222 | */ |
||
223 | public function addQuery(BuilderInterface $query, $boolType = BoolQuery::MUST, $key = null) |
||
230 | |||
231 | /** |
||
232 | * Returns endpoint instance. |
||
233 | * |
||
234 | * @param string $type Endpoint type. |
||
235 | * |
||
236 | * @return SearchEndpointInterface |
||
237 | */ |
||
238 | private function getEndpoint($type) |
||
246 | |||
247 | /** |
||
248 | * Returns queries inside BoolQuery instance. |
||
249 | * |
||
250 | * @return BoolQuery |
||
251 | */ |
||
252 | public function getQueries() |
||
258 | |||
259 | /** |
||
260 | * Sets query endpoint parameters. |
||
261 | * |
||
262 | * @param array $parameters |
||
263 | * |
||
264 | * @return $this |
||
265 | */ |
||
266 | public function setQueryParameters(array $parameters) |
||
272 | |||
273 | /** |
||
274 | * Sets parameters to the endpoint. |
||
275 | * |
||
276 | * @param string $endpointName |
||
277 | * @param array $parameters |
||
278 | * |
||
279 | * @return $this |
||
280 | */ |
||
281 | public function setEndpointParameters($endpointName, array $parameters) |
||
289 | |||
290 | /** |
||
291 | * Adds a post filter to search. |
||
292 | * |
||
293 | * @param BuilderInterface $filter Filter. |
||
294 | * @param string $boolType Example boolType values: |
||
295 | * - must |
||
296 | * - must_not |
||
297 | * - should. |
||
298 | * @param string $key |
||
299 | * |
||
300 | * @return $this. |
||
301 | */ |
||
302 | public function addPostFilter(BuilderInterface $filter, $boolType = BoolQuery::MUST, $key = null) |
||
310 | |||
311 | /** |
||
312 | * Returns queries inside BoolFilter instance. |
||
313 | * |
||
314 | * @return BoolQuery |
||
315 | */ |
||
316 | public function getPostFilters() |
||
322 | |||
323 | /** |
||
324 | * Sets post filter endpoint parameters. |
||
325 | * |
||
326 | * @param array $parameters |
||
327 | * |
||
328 | * @return $this |
||
329 | */ |
||
330 | public function setPostFilterParameters(array $parameters) |
||
336 | |||
337 | /** |
||
338 | * Adds aggregation into search. |
||
339 | * |
||
340 | * @param AbstractAggregation $aggregation |
||
341 | * |
||
342 | * @return $this |
||
343 | */ |
||
344 | public function addAggregation(AbstractAggregation $aggregation) |
||
350 | |||
351 | /** |
||
352 | * Returns all aggregations. |
||
353 | * |
||
354 | * @return BuilderInterface[] |
||
355 | */ |
||
356 | public function getAggregations() |
||
360 | |||
361 | /** |
||
362 | * Adds inner hit into search. |
||
363 | * |
||
364 | * @param NestedInnerHit $innerHit |
||
365 | * |
||
366 | * @return $this |
||
367 | */ |
||
368 | public function addInnerHit(NestedInnerHit $innerHit) |
||
374 | |||
375 | /** |
||
376 | * Returns all inner hits. |
||
377 | * |
||
378 | * @return BuilderInterface[] |
||
379 | */ |
||
380 | public function getInnerHits() |
||
384 | |||
385 | /** |
||
386 | * Adds sort to search. |
||
387 | * |
||
388 | * @param BuilderInterface $sort |
||
389 | * |
||
390 | * @return $this |
||
391 | */ |
||
392 | public function addSort(BuilderInterface $sort) |
||
398 | |||
399 | /** |
||
400 | * Returns all set sorts. |
||
401 | * |
||
402 | * @return BuilderInterface[] |
||
403 | */ |
||
404 | public function getSorts() |
||
408 | |||
409 | /** |
||
410 | * Allows to highlight search results on one or more fields. |
||
411 | * |
||
412 | * @param Highlight $highlight |
||
413 | * |
||
414 | * @return $this. |
||
415 | */ |
||
416 | public function addHighlight($highlight) |
||
422 | |||
423 | /** |
||
424 | * Returns highlight builder. |
||
425 | * |
||
426 | * @return BuilderInterface |
||
427 | */ |
||
428 | public function getHighlights() |
||
435 | |||
436 | /** |
||
437 | * Adds suggest into search. |
||
438 | * |
||
439 | * @param BuilderInterface $suggest |
||
440 | * |
||
441 | * @return $this |
||
442 | */ |
||
443 | public function addSuggest(NamedBuilderInterface $suggest) |
||
449 | |||
450 | /** |
||
451 | * Returns all suggests. |
||
452 | * |
||
453 | * @return BuilderInterface[] |
||
454 | */ |
||
455 | public function getSuggests() |
||
459 | |||
460 | /** |
||
461 | * @return int |
||
462 | */ |
||
463 | public function getFrom() |
||
467 | |||
468 | /** |
||
469 | * @param int $from |
||
470 | * |
||
471 | * @return $this |
||
472 | */ |
||
473 | public function setFrom($from) |
||
479 | |||
480 | /** |
||
481 | * @return bool |
||
482 | */ |
||
483 | public function isTrackTotalHits() |
||
487 | |||
488 | /** |
||
489 | * @param bool $trackTotalHits |
||
490 | * |
||
491 | * @return $this |
||
492 | */ |
||
493 | public function setTrackTotalHits(bool $trackTotalHits) |
||
499 | |||
500 | /** |
||
501 | * @return int |
||
502 | */ |
||
503 | public function getSize() |
||
507 | |||
508 | /** |
||
509 | * @param int $size |
||
510 | * |
||
511 | * @return $this |
||
512 | */ |
||
513 | public function setSize($size) |
||
519 | |||
520 | /** |
||
521 | * @return bool |
||
522 | */ |
||
523 | public function isSource() |
||
527 | |||
528 | /** |
||
529 | * @param bool $source |
||
530 | * |
||
531 | * @return $this |
||
532 | */ |
||
533 | public function setSource($source) |
||
539 | |||
540 | /** |
||
541 | * @return array |
||
542 | */ |
||
543 | public function getStoredFields() |
||
547 | |||
548 | /** |
||
549 | * @param array $storedFields |
||
550 | * |
||
551 | * @return $this |
||
552 | */ |
||
553 | public function setStoredFields($storedFields) |
||
559 | |||
560 | /** |
||
561 | * @return array |
||
562 | */ |
||
563 | public function getScriptFields() |
||
567 | |||
568 | /** |
||
569 | * @param array $scriptFields |
||
570 | * |
||
571 | * @return $this |
||
572 | */ |
||
573 | public function setScriptFields($scriptFields) |
||
579 | |||
580 | /** |
||
581 | * @return array |
||
582 | */ |
||
583 | public function getDocValueFields() |
||
587 | |||
588 | /** |
||
589 | * @param array $docValueFields |
||
590 | * |
||
591 | * @return $this |
||
592 | */ |
||
593 | public function setDocValueFields($docValueFields) |
||
599 | |||
600 | /** |
||
601 | * @return bool |
||
602 | */ |
||
603 | public function isExplain() |
||
607 | |||
608 | /** |
||
609 | * @param bool $explain |
||
610 | * |
||
611 | * @return $this |
||
612 | */ |
||
613 | public function setExplain($explain) |
||
619 | |||
620 | /** |
||
621 | * @return bool |
||
622 | */ |
||
623 | public function isVersion() |
||
627 | |||
628 | /** |
||
629 | * @param bool $version |
||
630 | * |
||
631 | * @return $this |
||
632 | */ |
||
633 | public function setVersion($version) |
||
639 | |||
640 | /** |
||
641 | * @return array |
||
642 | */ |
||
643 | public function getIndicesBoost() |
||
647 | |||
648 | /** |
||
649 | * @param array $indicesBoost |
||
650 | * |
||
651 | * @return $this |
||
652 | */ |
||
653 | public function setIndicesBoost($indicesBoost) |
||
659 | |||
660 | /** |
||
661 | * @return int |
||
662 | */ |
||
663 | public function getMinScore() |
||
667 | |||
668 | /** |
||
669 | * @param int $minScore |
||
670 | * |
||
671 | * @return $this |
||
672 | */ |
||
673 | public function setMinScore($minScore) |
||
679 | |||
680 | /** |
||
681 | * @return array |
||
682 | */ |
||
683 | public function getSearchAfter() |
||
687 | |||
688 | /** |
||
689 | * @param array $searchAfter |
||
690 | * |
||
691 | * @return $this |
||
692 | */ |
||
693 | public function setSearchAfter($searchAfter) |
||
699 | |||
700 | /** |
||
701 | * @return string |
||
702 | */ |
||
703 | public function getScroll() |
||
707 | |||
708 | /** |
||
709 | * @param string $scroll |
||
710 | * |
||
711 | * @return $this |
||
712 | */ |
||
713 | public function setScroll($scroll = '5m') |
||
721 | |||
722 | /** |
||
723 | * @param string $name |
||
724 | * @param string|array|bool $value |
||
725 | * |
||
726 | * @return $this |
||
727 | */ |
||
728 | public function addUriParam($name, $value) |
||
763 | |||
764 | /** |
||
765 | * Returns query url parameters. |
||
766 | * |
||
767 | * @return array |
||
768 | */ |
||
769 | public function getUriParams() |
||
773 | |||
774 | /** |
||
775 | * {@inheritdoc} |
||
776 | */ |
||
777 | public function toArray() |
||
804 | } |
||
805 |
Let’s assume you have a class which uses late-static binding:
The code above will run fine in your PHP runtime. However, if you now create a sub-class and call the
getSomeVariable()
on that sub-class, you will receive a runtime error:In the case above, it makes sense to update
SomeClass
to useself
instead: