NatLibFi /
Skosmos
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 ConceptSearchParameters 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 ConceptSearchParameters, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 6 | class ConceptSearchParameters |
||
|
|
|||
| 7 | { |
||
| 8 | |||
| 9 | private $config; |
||
| 10 | private $request; |
||
| 11 | private $vocabs; |
||
| 12 | private $rest; |
||
| 13 | private $hidden; |
||
| 14 | private $unique; |
||
| 15 | |||
| 16 | public function __construct($request, $config, $rest = false) |
||
| 17 | { |
||
| 18 | $this->request = $request; |
||
| 19 | $this->config = $config; |
||
| 20 | $this->rest = $rest; |
||
| 21 | $this->hidden = true; |
||
| 22 | $this->unique = $request->getQueryParamBoolean('unique', false); |
||
| 23 | } |
||
| 24 | |||
| 25 | public function getLang() |
||
| 26 | { |
||
| 27 | if ($this->rest && $this->request->getQueryParam('labellang')) { |
||
| 28 | return $this->request->getQueryParam('labellang'); |
||
| 29 | } |
||
| 30 | return $this->request->getLang(); |
||
| 31 | } |
||
| 32 | |||
| 33 | public function getVocabs() |
||
| 34 | { |
||
| 35 | if ($this->vocabs) { |
||
| 36 | return $this->vocabs; |
||
| 37 | } |
||
| 38 | if ($this->request->getVocab()) { |
||
| 39 | return array($this->request->getVocab()); |
||
| 40 | } |
||
| 41 | return array(); |
||
| 42 | } |
||
| 43 | |||
| 44 | public function getVocabIds() |
||
| 45 | { |
||
| 46 | View Code Duplication | if ($this->rest) { |
|
| 47 | $vocabs = $this->request->getQueryParam('vocab'); |
||
| 48 | return ($vocabs !== null && $vocabs !== '') ? explode(' ', $vocabs) : null; |
||
| 49 | } |
||
| 50 | View Code Duplication | if ($this->request->getQueryParam('vocabs')) { |
|
| 51 | $vocabs = $this->request->getQueryParam('vocabs'); |
||
| 52 | return ($vocabs !== null && $vocabs !== '') ? explode(' ', $vocabs) : null; |
||
| 53 | } |
||
| 54 | $vocabs = $this->getVocabs(); |
||
| 55 | if (isset($vocabs[0])) { |
||
| 56 | return array($vocabs[0]->getId()); |
||
| 57 | } |
||
| 58 | return null; |
||
| 59 | } |
||
| 60 | |||
| 61 | public function setVocabularies($vocabs) |
||
| 65 | |||
| 66 | public function getArrayClass() |
||
| 67 | { |
||
| 68 | if (sizeof($this->getVocabs()) == 1) { // search within vocabulary |
||
| 69 | $vocabs = $this->getVocabs(); |
||
| 70 | return $vocabs[0]->getConfig()->getArrayClassURI(); |
||
| 71 | } |
||
| 72 | return null; |
||
| 73 | } |
||
| 74 | |||
| 75 | public function getSearchTerm() |
||
| 76 | { |
||
| 77 | $term = $this->request->getQueryParam('q') ? $this->request->getQueryParam('q') : $this->request->getQueryParam('query'); |
||
| 78 | if (!$term && $this->rest) |
||
| 79 | $term = $this->request->getQueryParam('label'); |
||
| 80 | $term = trim($term); // surrounding whitespace is not considered significant |
||
| 81 | if ($this->rest) { |
||
| 82 | return $term; |
||
| 83 | } |
||
| 84 | return strpos($term, "*") === false ? $term . "*" : $term; // default to prefix search |
||
| 85 | } |
||
| 86 | |||
| 87 | public function getContentLang() |
||
| 91 | |||
| 92 | public function getSearchLang() |
||
| 93 | { |
||
| 94 | if ($this->rest) { |
||
| 95 | return $this->request->getQueryParam('lang'); |
||
| 96 | } |
||
| 97 | return $this->request->getQueryParam('anylang') ? '' : $this->getContentLang(); |
||
| 99 | |||
| 100 | public function getTypeLimit() |
||
| 120 | |||
| 121 | private function getQueryParam($name, $explode=false) { |
||
| 127 | |||
| 128 | public function getGroupLimit() |
||
| 132 | |||
| 133 | public function getParentLimit() |
||
| 137 | |||
| 138 | public function getSchemeLimit() |
||
| 142 | |||
| 143 | public function getOffset() |
||
| 147 | |||
| 148 | public function getSearchLimit() |
||
| 155 | |||
| 156 | public function getUnique() { |
||
| 159 | |||
| 160 | public function setUnique($unique) { |
||
| 163 | |||
| 164 | public function getAdditionalFields() { |
||
| 167 | |||
| 168 | public function getHidden() { |
||
| 171 | |||
| 172 | public function setHidden($hidden) { |
||
| 175 | |||
| 176 | public function getRest() { |
||
| 179 | } |
||
| 180 |
Loading history...
You can fix this by adding a namespace to your class:
When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries.