JuKu /
JuKuCMS
| Total Complexity | 83 |
| Total Lines | 497 |
| Duplicated Lines | 0 % |
| Changes | 15 | ||
| Bugs | 7 | Features | 5 |
Complex classes like Page 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.
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 Page, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 19 | class Page { |
||
| 20 | |||
| 21 | protected $pageID = -1; |
||
| 22 | protected $alias = null; |
||
| 23 | protected $row = null; |
||
| 24 | protected $pagetype = ""; |
||
| 25 | |||
| 26 | protected $author = null; |
||
| 27 | |||
| 28 | //changed columns to save with save() |
||
| 29 | protected $changes = array(); |
||
| 30 | |||
| 31 | public function __construct() { |
||
| 32 | // |
||
| 33 | } |
||
| 34 | |||
| 35 | public function load ($alias = null) { |
||
| 36 | if ($alias == null) { |
||
| 37 | if (isset($_REQUEST['page']) && !empty($_REQUEST['page'])) { |
||
| 38 | $alias = Validator_String::get($_REQUEST['page']); |
||
| 39 | } else { |
||
| 40 | $alias = $this->getDomain()->getHomePage(); |
||
| 41 | } |
||
| 42 | } else { |
||
| 43 | //$alias = Database::getInstance()->escape($alias); |
||
| 44 | } |
||
| 45 | |||
| 46 | Events::throwEvent("get_alias", array( |
||
| 47 | 'alias' => &$alias, |
||
| 48 | 'page' => &$this, |
||
| 49 | 'domain' => $this->getDomain() |
||
| 50 | )); |
||
| 51 | |||
| 52 | $this->alias = $alias; |
||
| 53 | |||
| 54 | if (Cache::contains("pages", "page_" . $alias)) { |
||
| 55 | $this->row = Cache::get("pages", "page_" . $alias); |
||
| 56 | } else { |
||
| 57 | $row = Database::getInstance()->getRow("SELECT * FROM `{praefix}pages` WHERE `alias` = :alias AND `activated` = '1'; ", array('alias' => $alias)); |
||
| 58 | |||
| 59 | if (!$row) { |
||
| 60 | if (PHPUtils::strEqs("error404", $alias)) { |
||
| 61 | throw new IllegalStateException("No page with alias 'error404' exists (requested alias: " . $alias . ")."); |
||
| 62 | } |
||
| 63 | |||
| 64 | //page not found |
||
| 65 | $new_alias = "error404"; |
||
| 66 | |||
| 67 | Events::throwEvent("load_page_error404", array( |
||
| 68 | 'alias' => &$new_alias, |
||
| 69 | 'original_alias' => $alias, |
||
| 70 | 'page' => &$this, |
||
| 71 | 'domain' => $this->getDomain() |
||
| 72 | )); |
||
| 73 | |||
| 74 | $this->load($new_alias); |
||
| 75 | return null; |
||
| 76 | } |
||
| 77 | |||
| 78 | $this->row = $row; |
||
| 79 | |||
| 80 | //cache result |
||
| 81 | Cache::put("pages", "page_" . $alias, $row); |
||
| 82 | } |
||
| 83 | |||
| 84 | //get pageID |
||
| 85 | $this->pageID = $this->row['id']; |
||
| 86 | |||
| 87 | //get name of page type (class name) |
||
| 88 | $this->pagetype = $this->row['page_type']; |
||
| 89 | } |
||
| 90 | |||
| 91 | public function loadByID (int $pageID, bool $use_cache = true) { |
||
| 92 | if ($use_cache && Cache::contains("pages", "pageID_" . $pageID)) { |
||
| 93 | $this->row = Cache::get("pages", "pageID_" . $pageID); |
||
| 94 | } else { |
||
| 95 | $row = Database::getInstance()->getRow("SELECT * FROM `{praefix}pages` WHERE `id` = :pageID; ", array('pageID' => $pageID)); |
||
| 96 | |||
| 97 | if (!$row) { |
||
| 98 | throw new IllegalStateException("Page with pageID " . $pageID . " doesnt exists!"); |
||
| 99 | } |
||
| 100 | |||
| 101 | $this->row = $row; |
||
| 102 | |||
| 103 | //cache result |
||
| 104 | Cache::put("pages", "pageID_" . $pageID, $row); |
||
| 105 | } |
||
| 106 | |||
| 107 | $this->pageID = $this->row['id']; |
||
| 108 | $this->alias = $this->row['alias']; |
||
| 109 | |||
| 110 | //get name of page type (class name) |
||
| 111 | $this->pagetype = $this->row['page_type']; |
||
| 112 | } |
||
| 113 | |||
| 114 | protected function getDomain () : Domain { |
||
| 115 | return Registry::singleton()->getObject("domain"); |
||
| 116 | } |
||
| 117 | |||
| 118 | public function reloadCache () { |
||
| 119 | Cache::clear("pages"); |
||
| 120 | } |
||
| 121 | |||
| 122 | public function getPageID () : int { |
||
| 123 | return $this->row['id']; |
||
| 124 | } |
||
| 125 | |||
| 126 | public function getAlias () : string { |
||
| 127 | return $this->alias; |
||
| 128 | } |
||
| 129 | |||
| 130 | public function getPageType () : string { |
||
| 131 | return $this->pagetype; |
||
| 132 | } |
||
| 133 | |||
| 134 | public function getTitle () : string { |
||
| 135 | return $this->row['title']; |
||
| 136 | } |
||
| 137 | |||
| 138 | public function setTitle (string $title) { |
||
| 139 | $this->row['title'] = $title; |
||
| 140 | $this->changes[] = "title"; |
||
| 141 | } |
||
| 142 | |||
| 143 | public function getContent () : string { |
||
| 144 | return $this->row['content']; |
||
| 145 | } |
||
| 146 | |||
| 147 | public function setContent (string $content) { |
||
| 148 | $this->row['content'] = $content; |
||
| 149 | $this->changes[] = "content"; |
||
| 150 | $this->changes[] = "content"; |
||
| 151 | } |
||
| 152 | |||
| 153 | public function getGlobalMenuID () : int { |
||
| 155 | } |
||
| 156 | |||
| 157 | public function getLocalMenuID () : int { |
||
| 158 | return $this->row['local_menu']; |
||
| 159 | } |
||
| 160 | |||
| 161 | public function getStyle () : string { |
||
| 162 | return $this->row['design']; |
||
| 163 | } |
||
| 164 | |||
| 165 | public function getFolder () : string { |
||
| 166 | return $this->row['folder']; |
||
| 167 | } |
||
| 168 | |||
| 169 | public function getLastEdit () { |
||
| 170 | return $this->row['lastUpdate']; |
||
| 171 | } |
||
| 172 | |||
| 173 | public function hasCustomTemplate () : bool { |
||
| 174 | return $this->row['template'] !== "none"; |
||
| 175 | } |
||
| 176 | |||
| 177 | public function getCustomTemplate () : string { |
||
| 178 | return $this->row['template']; |
||
| 179 | } |
||
| 180 | |||
| 181 | public function hasCustomPermissions () : bool { |
||
| 183 | } |
||
| 184 | |||
| 185 | public function listCustomPermissions () : array { |
||
| 186 | return explode("|", $this->row['can_see_permissions']); |
||
| 187 | } |
||
| 188 | |||
| 189 | public function isPublished () : bool { |
||
| 190 | return $this->row['published'] == 1; |
||
| 191 | } |
||
| 192 | |||
| 193 | public function publish () { |
||
| 194 | $this->row['published'] = 1; |
||
| 195 | $this->changes[] = "published"; |
||
| 196 | } |
||
| 197 | |||
| 198 | public function getContentType () : string { |
||
| 199 | return $this->row['content_type']; |
||
| 200 | } |
||
| 201 | |||
| 202 | public function getParentID () : int { |
||
| 203 | return $this->row['parent']; |
||
| 204 | } |
||
| 205 | |||
| 206 | public function getLeftSidebarID () : int { |
||
| 207 | return $this->row['sidebar_left']; |
||
| 208 | } |
||
| 209 | |||
| 210 | public function getRightSidebarID () : int { |
||
| 211 | return $this->row['sidebar_right']; |
||
| 212 | } |
||
| 213 | |||
| 214 | public function getMetaDescription () : string { |
||
| 215 | return $this->row['meta_description']; |
||
| 216 | } |
||
| 217 | |||
| 218 | public function getMetaKeywords () : string { |
||
| 219 | return $this->row['meta_keywords']; |
||
| 220 | } |
||
| 221 | |||
| 222 | public function getMetaRobotsOptions () : string { |
||
| 223 | return $this->row['meta_robots']; |
||
| 224 | } |
||
| 225 | |||
| 226 | public function getMetaCanonicals () : string { |
||
| 227 | return $this->row['meta_canonicals']; |
||
| 228 | } |
||
| 229 | |||
| 230 | public function getOgType () : string { |
||
| 231 | return $this->row['og_type']; |
||
| 232 | } |
||
| 233 | |||
| 234 | public function getOgTitle () : string { |
||
| 235 | return !empty($this->row['og_title']) ? $this->row['og_title'] : $this->getTitle(); |
||
| 236 | } |
||
| 237 | |||
| 238 | public function getOgDescription () : string { |
||
| 239 | return !empty($this->row['og_description']) ? $this->row['og_description'] : $this->getMetaDescription(); |
||
| 240 | } |
||
| 241 | |||
| 242 | public function getOgImages () : array { |
||
| 248 | } |
||
| 249 | |||
| 250 | public function getAuthorID () : int { |
||
| 251 | return $this->row['author']; |
||
| 252 | } |
||
| 253 | |||
| 254 | public function getAuthor () : User { |
||
| 267 | } |
||
| 268 | |||
| 269 | public function isSitemapEnabled () : bool { |
||
| 270 | return $this->row['sitemap'] == 1; |
||
| 271 | } |
||
| 272 | |||
| 273 | public function activate (bool $bool = true) { |
||
| 274 | $this->row['activated'] = ($bool ? 1 : 0); |
||
| 275 | } |
||
| 276 | |||
| 277 | public function isTrash () : bool { |
||
| 278 | return $this->row['activated'] == 2; |
||
| 279 | } |
||
| 280 | |||
| 281 | public function isEditable () : bool { |
||
| 282 | return $this->row['editable'] == 1; |
||
| 283 | } |
||
| 284 | |||
| 285 | public function isDeletable () : bool { |
||
| 286 | return $this->row['deletable'] == 1; |
||
| 287 | } |
||
| 288 | |||
| 289 | public function isActivated () : bool { |
||
| 290 | return $this->row['activated'] == 1; |
||
| 291 | } |
||
| 292 | |||
| 293 | public function moveToTrash () { |
||
| 294 | self::movePageToTrash($this->pageID); |
||
| 295 | |||
| 296 | //clear cache |
||
| 297 | $this->clearCache(); |
||
| 298 | } |
||
| 299 | |||
| 300 | /** |
||
| 301 | * restore page from trash |
||
| 302 | */ |
||
| 303 | public function restore () { |
||
| 304 | self::restorePage($this->pageID); |
||
| 305 | |||
| 306 | //clear cache |
||
| 307 | $this->clearCache(); |
||
| 308 | } |
||
| 309 | |||
| 310 | /** |
||
| 311 | * save changes into database |
||
| 312 | */ |
||
| 313 | public function save () { |
||
| 314 | //TODO: add code here |
||
| 315 | } |
||
| 316 | |||
| 317 | public function clearCache () { |
||
| 318 | if (!is_int($this->getPageID())) { |
||
|
introduced
by
|
|||
| 319 | throw new IllegalStateException("pageID isn't set."); |
||
| 320 | } |
||
| 321 | |||
| 322 | //clear cache |
||
| 323 | Cache::clear("pages", "pageID_" . $this->getPageID()); |
||
| 324 | Cache::clear("pages", "page_" . $this->getAlias()); |
||
| 325 | } |
||
| 326 | |||
| 327 | public static function createIfAbsent (string $alias, string $title, string $page_type, string $content = "", string $folder = "/", int $globalMenu = -1, int $localMenu = -1, int $parentID = -1, bool $sitemap = true, bool $published = true, bool $editable = true, bool $deletable = true, string $author = "system") : int { |
||
| 395 | } |
||
| 396 | |||
| 397 | public static function delete (string $alias) { |
||
| 398 | $delete = true; |
||
| 399 | |||
| 400 | //plugins can avoid deletion or change alias |
||
| 401 | Events::throwEvent("delete_page_alias", array( |
||
| 402 | 'alias' => &$alias, |
||
| 403 | 'delete' => &$delete |
||
| 404 | )); |
||
| 405 | |||
| 406 | if ($delete) { |
||
| 407 | //remove page from database |
||
| 408 | Database::getInstance()->execute("DELETE FROM `{praefix}pages` WHERE `alias` = :alias; ", array('alias' => $alias)); |
||
| 409 | |||
| 410 | Cache::clear("pages"); |
||
| 411 | } |
||
| 412 | } |
||
| 413 | |||
| 414 | public static function deleteByID (int $id) { |
||
| 415 | $delete = true; |
||
| 416 | |||
| 417 | //plugins can avoid deletion or change alias |
||
| 418 | Events::throwEvent("delete_page_id", array( |
||
| 419 | 'alias' => &$id, |
||
| 420 | 'delete' => &$delete |
||
| 421 | )); |
||
| 422 | |||
| 423 | if ($delete) { |
||
| 424 | //remove page from database |
||
| 425 | Database::getInstance()->execute("DELETE FROM `{praefix}pages` WHERE `id` = :id; ", array('id' => $id)); |
||
| 426 | |||
| 427 | Cache::clear("pages"); |
||
| 428 | } |
||
| 429 | } |
||
| 430 | |||
| 431 | public static function get (string $alias) : Page { |
||
| 432 | $page = new Page(); |
||
| 433 | $page->load($alias); |
||
| 434 | |||
| 435 | return $page; |
||
| 436 | } |
||
| 437 | |||
| 438 | public static function setPageType (string $alias, string $page_type) { |
||
| 439 | Events::throwEvent("set_pagetype", array( |
||
| 440 | 'alias' => &$alias, |
||
| 441 | 'page_type' => &$page_type |
||
| 442 | )); |
||
| 443 | |||
| 444 | Database::getInstance()->execute("UPDATE `{praefix}pages` SET `page_type` = :page_type WHERE `alias` = :alias; ", array( |
||
| 445 | 'alias' => $alias, |
||
| 446 | 'page_type' => $page_type |
||
| 447 | )); |
||
| 448 | |||
| 449 | Cache::clear("pages"); |
||
| 450 | } |
||
| 451 | |||
| 452 | /** |
||
| 453 | * get id of page by alias |
||
| 454 | * |
||
| 455 | * only use this method for database upgrade, because their is no caching for this method! |
||
| 456 | * |
||
| 457 | * @param string $alias alias of page |
||
| 458 | * |
||
| 459 | * @throws IllegalStateException if alias doesnt exists |
||
| 460 | * |
||
| 461 | * @return int pageID |
||
| 462 | */ |
||
| 463 | public static function getPageIDByAlias (string $alias) : int { |
||
| 464 | $row = Database::getInstance()->getRow("SELECT * FROM `{praefix}pages` WHERE `alias` = :alias; ", array('alias' => $alias)); |
||
| 465 | |||
| 466 | if (!$row) { |
||
| 467 | throw new IllegalStateException("page with alias '" . $alias . "' doesnt exists."); |
||
| 468 | } |
||
| 469 | |||
| 470 | return $row['id']; |
||
| 471 | } |
||
| 472 | |||
| 473 | public static function lockPage (int $pageID, int $userID) { |
||
| 474 | Database::getInstance()->execute("UPDATE `{praefix}pages` SET `locked_by` = :userID, `locked_timestamp` = CURRENT_TIMESTAMP WHERE `id` = :pageID; ", array( |
||
| 475 | 'userID' => $userID, |
||
| 476 | 'pageID' => $pageID |
||
| 477 | )); |
||
| 478 | |||
| 479 | //clear cache |
||
| 480 | Cache::clear("pages", "pageID_" . $pageID); |
||
| 481 | } |
||
| 482 | |||
| 483 | public static function unlockPage (int $pageID) { |
||
| 484 | Database::getInstance()->execute("UPDATE `{praefix}pages` SET `locked_by` = '-1' WHERE `id` = :pageID; ", array( |
||
| 485 | 'pageID' => $pageID |
||
| 486 | )); |
||
| 487 | |||
| 488 | //clear cache |
||
| 489 | Cache::clear("pages", "pageID_" . $pageID); |
||
| 490 | } |
||
| 491 | |||
| 492 | protected static function movePageToTrash (int $pageID) { |
||
| 493 | Database::getInstance()->execute("UPDATE `{praefix}pages` SET `activated` = 2 WHERE `id` = :pageID; ", array( |
||
| 494 | 'pageID' => $pageID |
||
| 495 | )); |
||
| 496 | |||
| 497 | //clear cache |
||
| 498 | Cache::clear("pages", "pageID_" . $pageID); |
||
| 499 | } |
||
| 500 | |||
| 501 | protected static function restorePage (int $pageID) { |
||
| 502 | Database::getInstance()->execute("UPDATE `{praefix}pages` SET `activated` = 1 WHERE `id` = :pageID; ", array( |
||
| 503 | 'pageID' => $pageID |
||
| 504 | )); |
||
| 505 | |||
| 506 | //clear cache |
||
| 507 | Cache::clear("pages", "pageID_" . $pageID); |
||
| 508 | } |
||
| 509 | |||
| 510 | public static function exists (string $alias) : bool { |
||
| 516 | } |
||
| 517 | |||
| 518 | } |
||
| 519 | |||
| 520 | ?> |
||
| 521 |
Loading history...