jenskooij /
cloudcontrol
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 CmsComponent 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 CmsComponent, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 8 | class CmsComponent extends BaseComponent |
||
| 9 | { |
||
| 10 | /** |
||
| 11 | * @var \library\storage\Storage |
||
| 12 | */ |
||
| 13 | protected $storage; |
||
| 14 | /** |
||
| 15 | * @var string |
||
| 16 | */ |
||
| 17 | protected $invalidCredentialsMsg = 'Invalid username / password combination'; |
||
| 18 | |||
| 19 | /** |
||
| 20 | * @var null|string |
||
| 21 | */ |
||
| 22 | protected $subTemplate = null; |
||
| 23 | |||
| 24 | /** |
||
| 25 | * @param \library\storage\Storage $storage |
||
| 26 | * |
||
| 27 | * @return void |
||
| 28 | */ |
||
| 29 | public function run(Storage $storage) |
||
| 44 | |||
| 45 | /** |
||
| 46 | * See if a user is logged or wants to log in and |
||
| 47 | * takes appropriate actions. |
||
| 48 | * |
||
| 49 | * @throws \Exception |
||
| 50 | */ |
||
| 51 | protected function checkLogin() |
||
| 81 | |||
| 82 | /** |
||
| 83 | * Overrides normal behaviour and only renders the |
||
| 84 | * login screen |
||
| 85 | * |
||
| 86 | * @throws \Exception |
||
| 87 | */ |
||
| 88 | protected function showLogin() |
||
| 95 | |||
| 96 | /** |
||
| 97 | * As an exception, to keep the initial file structure simple |
||
| 98 | * the cms implements it's own routing, apart from the regular sitemap functionality |
||
| 99 | * |
||
| 100 | * @throws \Exception |
||
| 101 | */ |
||
| 102 | protected function routing() |
||
| 140 | |||
| 141 | /** |
||
| 142 | * @param $remoteAddress |
||
| 143 | * @throws \Exception |
||
| 144 | */ |
||
| 145 | View Code Duplication | private function checkWhiteList($remoteAddress) |
|
|
|
|||
| 146 | { |
||
| 147 | if (isset($this->parameters['whitelistIps'])) { |
||
| 148 | $whitelistIps = explode(',', $this->parameters['whitelistIps']); |
||
| 149 | $whitelistIps = array_map("trim", $whitelistIps); |
||
| 150 | if (!in_array($remoteAddress, $whitelistIps)) { |
||
| 151 | throw new \Exception('Ip address ' . $remoteAddress . ' is not on whitelist'); |
||
| 152 | } |
||
| 153 | } |
||
| 154 | } |
||
| 155 | |||
| 156 | /** |
||
| 157 | * @param $remoteAddress |
||
| 158 | * @throws \Exception |
||
| 159 | */ |
||
| 160 | View Code Duplication | private function checkBlackList($remoteAddress) |
|
| 161 | { |
||
| 162 | if (isset($this->parameters['blacklistIps'])) { |
||
| 163 | $blacklistIps = explode(',', $this->parameters['blacklistIps']); |
||
| 164 | $blacklistIps = array_map("trim", $blacklistIps); |
||
| 165 | if (in_array($remoteAddress, $blacklistIps)) { |
||
| 166 | throw new \Exception('Ip address ' . $remoteAddress . ' is on blacklist'); |
||
| 167 | } |
||
| 168 | } |
||
| 169 | } |
||
| 170 | |||
| 171 | /** |
||
| 172 | * @param $request |
||
| 173 | * @return mixed|string |
||
| 174 | */ |
||
| 175 | private function getRelativeCmsUri($request) |
||
| 185 | |||
| 186 | /** |
||
| 187 | * @param $request |
||
| 188 | * @param $relativeCmsUri |
||
| 189 | */ |
||
| 190 | private function documentsRouting($request, $relativeCmsUri) |
||
| 200 | |||
| 201 | /** |
||
| 202 | * @param $request |
||
| 203 | * @param $relativeCmsUri |
||
| 204 | */ |
||
| 205 | private function sitemapRouting($request, $relativeCmsUri) |
||
| 206 | { |
||
| 207 | if ($relativeCmsUri == '/sitemap') { |
||
| 208 | $this->subTemplate = 'cms/sitemap'; |
||
| 209 | if (isset($request::$post['save'])) { |
||
| 210 | $this->storage->saveSitemap($request::$post); |
||
| 211 | } |
||
| 212 | $this->parameters['mainNavClass'] = 'sitemap'; |
||
| 213 | $this->parameters['sitemap'] = $this->storage->getSitemap(); |
||
| 214 | } elseif ($relativeCmsUri == '/sitemap/new') { |
||
| 215 | $this->subTemplate = 'cms/sitemap/form'; |
||
| 216 | $this->parameters['mainNavClass'] = 'sitemap'; |
||
| 217 | View Code Duplication | if (isset($request::$post['title'], $request::$post['template'], $request::$post['component'])) { |
|
| 218 | $this->storage->addSitemapItem($request::$post); |
||
| 219 | header('Location: ' . $request::$subfolders . $this->parameters['cmsPrefix'] . '/sitemap'); |
||
| 220 | exit; |
||
| 221 | } |
||
| 222 | } elseif ($relativeCmsUri == '/sitemap/edit' && isset($request::$get['slug'])) { |
||
| 223 | $this->subTemplate = 'cms/sitemap/form'; |
||
| 224 | $this->parameters['mainNavClass'] = 'sitemap'; |
||
| 225 | $sitemapItem = $this->storage->getSitemapItemBySlug($request::$get['slug']); |
||
| 226 | View Code Duplication | if (isset($request::$post['title'], $request::$post['template'], $request::$post['component'])) { |
|
| 227 | $this->storage->saveSitemapItem($request::$get['slug'], $request::$post); |
||
| 228 | header('Location: ' . $request::$subfolders . $this->parameters['cmsPrefix'] . '/sitemap'); |
||
| 229 | exit; |
||
| 230 | } |
||
| 231 | $this->parameters['sitemapItem'] = $sitemapItem; |
||
| 232 | } elseif ($relativeCmsUri == '/sitemap/delete' && isset($request::$get['slug'])) { |
||
| 233 | $this->storage->deleteSitemapItemBySlug($request::$get['slug']); |
||
| 234 | header('Location: ' . $request::$subfolders . $this->parameters['cmsPrefix'] . '/sitemap'); |
||
| 235 | exit; |
||
| 236 | } |
||
| 237 | } |
||
| 238 | |||
| 239 | /** |
||
| 240 | * @param $request |
||
| 241 | * @param $relativeCmsUri |
||
| 242 | */ |
||
| 243 | private function imagesRouting($request, $relativeCmsUri) |
||
| 271 | |||
| 272 | /** |
||
| 273 | * @param $relativeCmsUri |
||
| 274 | */ |
||
| 275 | private function apiRouting($relativeCmsUri) |
||
| 288 | |||
| 289 | /** |
||
| 290 | * @param $request |
||
| 291 | * @param $relativeCmsUri |
||
| 292 | */ |
||
| 293 | private function filesRouting($request, $relativeCmsUri) |
||
| 315 | |||
| 316 | /** |
||
| 317 | * @param $slug |
||
| 318 | */ |
||
| 319 | private function downloadFile($slug) |
||
| 339 | |||
| 340 | /** |
||
| 341 | * @param $request |
||
| 342 | * @param $relativeCmsUri |
||
| 343 | */ |
||
| 344 | private function configurationRouting($request, $relativeCmsUri) |
||
| 357 | |||
| 358 | /** |
||
| 359 | * @param $request |
||
| 360 | * @param $relativeCmsUri |
||
| 361 | * @throws \Exception |
||
| 362 | */ |
||
| 363 | private function documentRouting($request, $relativeCmsUri) |
||
| 413 | |||
| 414 | /** |
||
| 415 | * @param $request |
||
| 416 | * @param $relativeCmsUri |
||
| 417 | */ |
||
| 418 | private function folderRouting($request, $relativeCmsUri) |
||
| 454 | |||
| 455 | /** |
||
| 456 | * @param $request |
||
| 457 | * @param $relativeCmsUri |
||
| 458 | */ |
||
| 459 | View Code Duplication | private function usersRouting($request, $relativeCmsUri) |
|
| 460 | { |
||
| 461 | if ($relativeCmsUri == '/configuration/users') { |
||
| 462 | $this->subTemplate = 'cms/configuration/users'; |
||
| 463 | $this->parameters['mainNavClass'] = 'configuration'; |
||
| 464 | $this->parameters['users'] = $this->storage->getUsers(); |
||
| 465 | } elseif ($relativeCmsUri == '/configuration/users/new') { |
||
| 466 | $this->subTemplate = 'cms/configuration/users-form'; |
||
| 467 | $this->parameters['mainNavClass'] = 'configuration'; |
||
| 468 | if (isset($_POST['username'])) { |
||
| 469 | $this->storage->addUser($request::$post); |
||
| 470 | header('Location: ' . $request::$subfolders . $this->parameters['cmsPrefix'] . '/configuration/users'); |
||
| 471 | exit; |
||
| 472 | } |
||
| 473 | } elseif ($relativeCmsUri == '/configuration/users/delete' && isset($request::$get['slug'])) { |
||
| 474 | $this->storage->deleteUserBySlug($request::$get['slug']); |
||
| 475 | header('Location: ' . $request::$subfolders . $this->parameters['cmsPrefix'] . '/configuration/users'); |
||
| 476 | exit; |
||
| 477 | } elseif ($relativeCmsUri == '/configuration/users/edit' && isset($request::$get['slug'])) { |
||
| 478 | $this->subTemplate = 'cms/configuration/users-form'; |
||
| 479 | $this->parameters['mainNavClass'] = 'configuration'; |
||
| 480 | $this->parameters['user'] = $this->storage->getUserBySlug($request::$get['slug']); |
||
| 481 | if (isset($_POST['username'])) { |
||
| 482 | $this->storage->saveUser($request::$get['slug'], $request::$post); |
||
| 483 | header('Location: ' . $request::$subfolders . $this->parameters['cmsPrefix'] . '/configuration/users'); |
||
| 484 | exit; |
||
| 485 | } |
||
| 486 | } |
||
| 487 | } |
||
| 488 | |||
| 489 | /** |
||
| 490 | * @param $request |
||
| 491 | * @param $relativeCmsUri |
||
| 492 | */ |
||
| 493 | private function documentTypesRouting($request, $relativeCmsUri) |
||
| 527 | |||
| 528 | /** |
||
| 529 | * @param $request |
||
| 530 | * @param $relativeCmsUri |
||
| 531 | */ |
||
| 532 | private function bricksRouting($request, $relativeCmsUri) |
||
| 566 | |||
| 567 | /** |
||
| 568 | * @param $request |
||
| 569 | * @param $relativeCmsUri |
||
| 570 | */ |
||
| 571 | View Code Duplication | private function imageSetRouting($request, $relativeCmsUri) |
|
| 572 | { |
||
| 573 | if ($relativeCmsUri == '/configuration/image-set') { |
||
| 574 | $this->subTemplate = 'cms/configuration/image-set'; |
||
| 575 | $this->parameters['mainNavClass'] = 'configuration'; |
||
| 576 | $this->parameters['imageSet'] = $this->storage->getImageSet(); |
||
| 577 | } elseif ($relativeCmsUri == '/configuration/image-set/edit' && isset($request::$get['slug'])) { |
||
| 578 | $this->subTemplate = 'cms/configuration/image-set-form'; |
||
| 579 | $this->parameters['mainNavClass'] = 'configuration'; |
||
| 580 | $imageSet = $this->storage->getImageSetBySlug($request::$get['slug']); |
||
| 581 | if (isset($request::$post['title'])) { |
||
| 582 | $this->storage->saveImageSet($request::$get['slug'], $request::$post); |
||
| 583 | header('Location: ' . $request::$subfolders . $this->parameters['cmsPrefix'] . '/configuration/image-set'); |
||
| 584 | exit; |
||
| 585 | } |
||
| 586 | $this->parameters['imageSet'] = $imageSet; |
||
| 587 | } elseif ($relativeCmsUri == '/configuration/image-set/new') { |
||
| 588 | $this->subTemplate = 'cms/configuration/image-set-form'; |
||
| 589 | $this->parameters['mainNavClass'] = 'configuration'; |
||
| 590 | if (isset($request::$post['title'])) { |
||
| 591 | $this->storage->addImageSet($request::$post); |
||
| 592 | header('Location: ' . $request::$subfolders . $this->parameters['cmsPrefix'] . '/configuration/image-set'); |
||
| 593 | exit; |
||
| 594 | } |
||
| 595 | } elseif ($relativeCmsUri == '/configuration/image-set/delete' && isset($request::$get['slug'])) { |
||
| 596 | $this->storage->deleteImageSetBySlug($request::$get['slug']); |
||
| 597 | header('Location: ' . $request::$subfolders . $this->parameters['cmsPrefix'] . '/configuration/image-set'); |
||
| 598 | exit; |
||
| 599 | } |
||
| 600 | } |
||
| 601 | |||
| 602 | /** |
||
| 603 | * @param $request |
||
| 604 | * @param $relativeCmsUri |
||
| 605 | */ |
||
| 606 | View Code Duplication | private function applicationComponentRouting($request, $relativeCmsUri) |
|
| 607 | { |
||
| 608 | if ($relativeCmsUri == '/configuration/application-components') { |
||
| 609 | $this->subTemplate = 'cms/configuration/application-components'; |
||
| 610 | $this->parameters['mainNavClass'] = 'configuration'; |
||
| 611 | $this->parameters['applicationComponents'] = $this->storage->getApplicationComponents(); |
||
| 612 | } elseif ($relativeCmsUri == '/configuration/application-components/new') { |
||
| 613 | $this->subTemplate = 'cms/configuration/application-components-form'; |
||
| 614 | $this->parameters['mainNavClass'] = 'configuration'; |
||
| 615 | if (isset($request::$post['title'])) { |
||
| 616 | $this->storage->addApplicationComponent($request::$post); |
||
| 617 | header('Location: ' . $request::$subfolders . $this->parameters['cmsPrefix'] . '/configuration/application-components'); |
||
| 618 | exit; |
||
| 619 | } |
||
| 620 | } elseif ($relativeCmsUri == '/configuration/application-components/edit' && isset($request::$get['slug'])) { |
||
| 621 | $this->subTemplate = 'cms/configuration/application-components-form'; |
||
| 622 | $this->parameters['mainNavClass'] = 'configuration'; |
||
| 623 | $applicationComponent = $this->storage->getApplicationComponentBySlug($request::$get['slug']); |
||
| 624 | if (isset($request::$post['title'])) { |
||
| 625 | $this->storage->saveApplicationComponent($request::$get['slug'], $request::$post); |
||
| 626 | header('Location: ' . $request::$subfolders . $this->parameters['cmsPrefix'] . '/configuration/application-components'); |
||
| 627 | exit; |
||
| 628 | } |
||
| 629 | $this->parameters['applicationComponent'] = $applicationComponent; |
||
| 630 | } elseif ($relativeCmsUri == '/configuration/application-components/delete' && isset($request::$get['slug'])) { |
||
| 631 | $this->storage->deleteApplicationComponentBySlug($request::$get['slug']); |
||
| 632 | header('Location: ' . $request::$subfolders . $this->parameters['cmsPrefix'] . '/configuration/application-components'); |
||
| 633 | exit; |
||
| 634 | } |
||
| 635 | } |
||
| 636 | |||
| 637 | private function logOffRouting($request, $relativeCmsUri) |
||
| 646 | } |
||
| 647 | } |
Loading history...
Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.
You can also find more detailed suggestions in the “Code” section of your repository.