NukaCode /
database
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 Collection 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 Collection, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 16 | class Collection extends BaseCollection |
||
| 17 | { |
||
| 18 | /** |
||
| 19 | * Dynamically retrieve attributes on the model. |
||
| 20 | * |
||
| 21 | * @param string $key |
||
| 22 | * |
||
| 23 | * @return mixed |
||
| 24 | */ |
||
| 25 | 1 | public function __get($key) |
|
| 26 | { |
||
| 27 | 1 | $newCollection = new self(); |
|
| 28 | |||
| 29 | 1 | foreach ($this->items as $item) { |
|
| 30 | 1 | if ($item instanceof self) { // This item is a collection. |
|
| 31 | foreach ($item as $subItem) { |
||
| 32 | $newCollection->put($newCollection->count(), $subItem->$key); |
||
| 33 | } |
||
| 34 | |||
| 35 | continue; |
||
| 36 | } |
||
| 37 | |||
| 38 | 1 | if (is_object($item) && ! $item instanceof self && $item->$key instanceof self) { // Next tap is a collection. |
|
| 39 | foreach ($item->$key as $subItem) { |
||
| 40 | $newCollection->put($newCollection->count(), $subItem); |
||
| 41 | } |
||
| 42 | |||
| 43 | continue; |
||
| 44 | } |
||
| 45 | |||
| 46 | 1 | $newCollection->put($newCollection->count(), $item->$key); |
|
| 47 | 1 | } |
|
| 48 | |||
| 49 | 1 | return $newCollection; |
|
| 50 | } |
||
| 51 | |||
| 52 | /** |
||
| 53 | * Allow a method to be run on the entire collection. |
||
| 54 | * |
||
| 55 | * @param string $method |
||
| 56 | * @param array $args |
||
| 57 | * |
||
| 58 | * @return Collection |
||
| 59 | */ |
||
| 60 | 24 | public function __call($method, $args) |
|
| 61 | { |
||
| 62 | // Look for magic where calls. |
||
| 63 | 24 | if (strstr($method, 'getWhere')) { |
|
| 64 | 24 | return $this->magicWhere(snake_case($method), $args); |
|
| 65 | } |
||
| 66 | |||
| 67 | // No data in the collection. |
||
| 68 | if ($this->count() <= 0) { |
||
| 69 | return $this; |
||
| 70 | } |
||
| 71 | |||
| 72 | // Run the command on each object in the collection. |
||
| 73 | foreach ($this->items as $item) { |
||
| 74 | if (! is_object($item)) { |
||
| 75 | continue; |
||
| 76 | } |
||
| 77 | call_user_func_array([$item, $method], $args); |
||
| 78 | } |
||
| 79 | |||
| 80 | return $this; |
||
| 81 | } |
||
| 82 | |||
| 83 | /** |
||
| 84 | * Insert into an object |
||
| 85 | * |
||
| 86 | * Should be able to do this with methods |
||
| 87 | * that already exist on collection. |
||
| 88 | * |
||
| 89 | * @param mixed $value |
||
| 90 | * @param int $afterKey |
||
| 91 | * |
||
| 92 | * @return Collection |
||
| 93 | */ |
||
| 94 | public function insertAfter($value, $afterKey) |
||
| 95 | { |
||
| 96 | $newObject = new self(); |
||
| 97 | |||
| 98 | foreach ((array)$this->items as $k => $v) { |
||
| 99 | if ($afterKey == $k) { |
||
| 100 | $newObject->add($value); |
||
| 101 | } |
||
| 102 | |||
| 103 | $newObject->add($v); |
||
| 104 | } |
||
| 105 | |||
| 106 | $this->items = $newObject->items; |
||
| 107 | |||
| 108 | return $this; |
||
| 109 | } |
||
| 110 | |||
| 111 | /** |
||
| 112 | * Turn a collection into a drop down for an html select element. |
||
| 113 | * |
||
| 114 | * @param string $firstOptionText Text for the first object in the select array. |
||
| 115 | * @param string $idColumn The column to use for the id column in the option element. |
||
| 116 | * @param string $name The column to use for the name column in the option element. |
||
| 117 | * |
||
| 118 | * @return array The new select element array. |
||
| 119 | */ |
||
| 120 | 1 | public function toSelectArray($firstOptionText = 'Select one', $idColumn = 'id', $name = 'name') |
|
| 121 | 1 | { |
|
| 122 | $selectArray = []; |
||
| 123 | |||
| 124 | if ($firstOptionText != false) { |
||
|
Bug
Best Practice
introduced
by
|
|||
| 125 | $selectArray[0] = $firstOptionText; |
||
| 126 | } |
||
| 127 | |||
| 128 | foreach ($this->items as $item) { |
||
| 129 | $selectArray[$item->{$idColumn}] = $item->{$name}; |
||
| 130 | } |
||
| 131 | |||
| 132 | return $selectArray; |
||
| 133 | } |
||
| 134 | |||
| 135 | /** |
||
| 136 | * Turn the magic getWhere into a real where query. |
||
| 137 | * |
||
| 138 | * @param $method |
||
| 139 | * @param $args |
||
| 140 | * |
||
| 141 | * @return Collection |
||
| 142 | */ |
||
| 143 | 24 | private function magicWhere($method, $args) |
|
| 144 | { |
||
| 145 | 24 | $whereStatement = explode('_', $method); |
|
| 146 | |||
| 147 | // Get where |
||
| 148 | 24 | if (count($whereStatement) == 2) { |
|
| 149 | 2 | return $this->getWhere($args[0], '=', $args[1]); |
|
| 150 | } |
||
| 151 | |||
| 152 | $operators = [ |
||
| 153 | 22 | 'in', 'between', 'like', 'null', |
|
| 154 | 22 | 'not', |
|
| 155 | 22 | 'first', 'last', |
|
| 156 | 22 | 'many', |
|
| 157 | 22 | ]; |
|
| 158 | |||
| 159 | // If an operator is found then add operators. |
||
| 160 | 22 | if (array_intersect($whereStatement, $operators)) { |
|
| 161 | 22 | list($operator, $firstOrLast, $inverse) = $this->determineMagicWhereDetails($whereStatement); |
|
| 162 | |||
| 163 | 22 | $column = $args[0]; |
|
| 164 | 22 | $value = (isset($args[1]) ? $args[1] : null); |
|
| 165 | |||
| 166 | 22 | return $this->getWhere( |
|
| 167 | 22 | $column, |
|
| 168 | 22 | $operator, |
|
| 169 | 22 | $value, |
|
| 170 | 22 | $inverse, |
|
| 171 | $firstOrLast |
||
| 172 | 22 | ); |
|
| 173 | } |
||
| 174 | } |
||
| 175 | |||
| 176 | /** |
||
| 177 | * @param $whereStatement |
||
| 178 | * |
||
| 179 | * @return array |
||
| 180 | */ |
||
| 181 | 22 | private function determineMagicWhereDetails($whereStatement) |
|
| 182 | { |
||
| 183 | 22 | $finalOperator = '='; |
|
| 184 | 22 | $position = null; |
|
| 185 | 22 | $not = false; |
|
| 186 | |||
| 187 | 22 | foreach ($whereStatement as $operator) { |
|
| 188 | 22 | $finalOperator = $this->checkMagicWhereFinalOperator($operator, $finalOperator); |
|
| 189 | 22 | $position = $this->checkMagicWherePosition($operator, $position); |
|
| 190 | 22 | $not = $this->checkMagicWhereNot($operator, $not); |
|
| 191 | 22 | } |
|
| 192 | |||
| 193 | 22 | return [$finalOperator, $position, $not]; |
|
| 194 | |||
| 195 | // This is not working at the moment |
||
| 196 | // todo riddles - fix this |
||
| 197 | //if ($finalOperator == 'many') { |
||
| 198 | // $where = null; |
||
| 199 | // foreach ($args[0] as $column => $value) { |
||
| 200 | // $where = $this->getWhere( |
||
| 201 | // $column, // Column |
||
| 202 | // $finalOperator, // Operator |
||
| 203 | // $value, // Value |
||
| 204 | // $not, // Inverse |
||
| 205 | // $position // First or last |
||
| 206 | // ); |
||
| 207 | // } |
||
| 208 | // |
||
| 209 | // return $where; |
||
| 210 | //} |
||
| 211 | } |
||
| 212 | |||
| 213 | 22 | private function checkMagicWhereFinalOperator($operator, $finalOperator) |
|
| 221 | |||
| 222 | 22 | private function checkMagicWherePosition($operator, $position) |
|
| 230 | |||
| 231 | 22 | private function checkMagicWhereNot($operator, $not) |
|
| 239 | |||
| 240 | /** |
||
| 241 | * Search a collection for the value specified. |
||
| 242 | * |
||
| 243 | * @param string $column The column to search. |
||
| 244 | * @param string $operator The operation to use during search. |
||
| 245 | * @param mixed $value The value to search for. |
||
| 246 | * @param boolean $inverse Invert the results. |
||
| 247 | * @param string $position Return the first or last object in the collection. |
||
| 248 | * |
||
| 249 | * @return self Return the filtered collection. |
||
| 250 | */ |
||
| 251 | 24 | protected function getWhere($column, $operator, $value = null, $inverse = false, $position = null) |
|
| 252 | { |
||
| 253 | 24 | $output = clone $this; |
|
| 254 | 24 | foreach ($output->items as $key => $item) { |
|
| 255 | // No tap direct object access |
||
| 256 | 24 | $forget = $this->whereObject($item, $column, $operator, $value, $inverse); |
|
| 257 | |||
| 258 | 12 | if (strstr($column, '->')) { |
|
| 259 | $forget = $this->handleMultiTap($item, $column, $value, $operator, $inverse); |
||
| 260 | } |
||
| 261 | |||
| 262 | 12 | if ($forget == true) { |
|
| 263 | 12 | $output->forget($key); |
|
| 264 | 12 | continue; |
|
| 265 | } |
||
| 266 | 12 | } |
|
| 267 | |||
| 268 | // Handel first and last. |
||
| 269 | 12 | if (! is_null($position)) { |
|
| 270 | 2 | return $output->$position(); |
|
| 271 | } |
||
| 272 | |||
| 273 | 10 | return $output; |
|
| 274 | } |
||
| 275 | |||
| 276 | /** |
||
| 277 | * @param $item |
||
| 278 | * @param $column |
||
| 279 | * @param $value |
||
| 280 | * @param $operator |
||
| 281 | * @param $inverse |
||
| 282 | * |
||
| 283 | * @return bool |
||
| 284 | */ |
||
| 285 | private function handleMultiTap($item, $column, $value, $operator, $inverse) |
||
| 286 | { |
||
| 287 | list($objectToSearch, $columnToSearch) = $this->tapThroughObjects($column, $item); |
||
| 288 | |||
| 289 | if ($objectToSearch instanceof self) { |
||
| 290 | foreach ($objectToSearch as $subObject) { |
||
| 291 | // The column has a tap that ends in a collection. |
||
| 292 | return $this->whereObject($subObject, $columnToSearch, $operator, $value, $inverse); |
||
| 293 | } |
||
| 294 | } |
||
| 295 | |||
| 296 | // The column has a tap that ends in direct access |
||
| 297 | return $this->whereObject($objectToSearch, $columnToSearch, $operator, $value, $inverse); |
||
| 298 | } |
||
| 299 | |||
| 300 | /** |
||
| 301 | * @param $column |
||
| 302 | * @param $item |
||
| 303 | * |
||
| 304 | * @return mixed |
||
| 305 | */ |
||
| 306 | private function tapThroughObjects($column, $item) |
||
| 307 | { |
||
| 308 | $taps = explode('->', $column); |
||
| 309 | |||
| 310 | $objectToSearch = $item; |
||
| 311 | $columnToSearch = array_pop($taps); |
||
| 312 | |||
| 313 | foreach ($taps as $tap) { |
||
| 314 | // Keep tapping till we hit the last object. |
||
| 315 | $objectToSearch = $objectToSearch->$tap; |
||
| 316 | } |
||
| 317 | |||
| 318 | return [$objectToSearch, $columnToSearch]; |
||
| 319 | } |
||
| 320 | |||
| 321 | /** |
||
| 322 | * Compare the object and column passed with the value using the operator |
||
| 323 | * |
||
| 324 | * @param object $object The object we are searching. |
||
| 325 | * @param string $column The column to compare. |
||
| 326 | * @param string $operator What type of comparison operation to perform. |
||
| 327 | * @param mixed $value The value to search for. |
||
| 328 | * @param boolean $inverse Invert the results. |
||
| 329 | * |
||
| 330 | * @return boolean Return true if the object should be removed from the collection. |
||
| 331 | */ |
||
| 332 | 24 | private function whereObject($object, $column, $operator, $value = null, $inverse = false) |
|
| 348 | |||
| 349 | 4 | View Code Duplication | private function getWhereIn($object, $column, $value, $inverse) |
| 360 | |||
| 361 | 2 | private function getWhereBetween($object, $column, $value, $inverse) |
|
| 362 | { |
||
| 363 | 2 | if ($inverse == false) { |
|
| 364 | 1 | if ($object->$column < $value[0] || $object->$column > $value[1]) { |
|
| 365 | 1 | return true; |
|
| 366 | } |
||
| 367 | 1 | } |
|
| 368 | |||
| 369 | 2 | if ($object->$column >= $value[0] && $object->$column <= $value[1]) { |
|
| 370 | 2 | return true; |
|
| 371 | } |
||
| 372 | |||
| 373 | 1 | return false; |
|
| 374 | } |
||
| 375 | |||
| 376 | 2 | View Code Duplication | private function getWhereLike($object, $column, $value, $inverse) |
| 377 | { |
||
| 378 | 2 | if (! strstr($object->$column, $value) && $inverse == false) { |
|
| 379 | 1 | return true; |
|
| 380 | } |
||
| 381 | 2 | if (strstr($object->$column, $value) && $inverse == true) { |
|
| 382 | 1 | return true; |
|
| 383 | } |
||
| 384 | |||
| 385 | 2 | return false; |
|
| 386 | 1 | } |
|
| 387 | |||
| 388 | 2 | private function getWhereNull($object, $column, $value, $inverse) |
|
| 399 | |||
| 400 | 2 | private function getWhereDefault($object, $column, $value, $inverse) |
|
| 411 | } |
||
| 412 |
Loading history...