Total Complexity | 41 |
Total Lines | 310 |
Duplicated Lines | 0 % |
Changes | 33 | ||
Bugs | 4 | Features | 12 |
Complex classes like PageEditPage 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 PageEditPage, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
28 | class PageEditPage extends PageType { |
||
29 | |||
30 | public function getContent(): string { |
||
31 | $template = new DwooTemplate("pages/editpage"); |
||
32 | |||
33 | //check, if pageID is set |
||
34 | if (!isset($_REQUEST['edit']) || empty($_REQUEST['edit'])) { |
||
35 | //show error |
||
36 | return $this->showError("No pageID was set!"); |
||
37 | } |
||
38 | |||
39 | $pageID = (int) $_REQUEST['edit']; |
||
40 | |||
41 | $page = new Page(); |
||
42 | $page->loadByID($pageID); |
||
43 | |||
44 | //first check permissions |
||
45 | if (!PermissionChecker::current()->hasRight("can_edit_all_pages") && !(PermissionChecker::current()->hasRight("can_edit_own_pages") && $page->getAuthorID() == User::current()->getID())) { |
||
46 | //user doesn't have permissions to edit this page |
||
47 | return $this->showError("You don't have permissions to edit this page!"); |
||
48 | } |
||
49 | |||
50 | //first, lock page |
||
51 | Page::lockPage($page->getPageID(), User::current()->getID()); |
||
52 | |||
53 | $success_messages = array(); |
||
54 | $error_messages = array(); |
||
55 | |||
56 | //save page |
||
57 | if (isset($_REQUEST['submit'])) { |
||
58 | if ($_REQUEST['submit'] === "Save") { |
||
59 | //save page |
||
60 | $res = $this->save($page); |
||
61 | |||
62 | if ($res === true) { |
||
63 | $success_messages[] = "Saved page successfully!"; |
||
64 | } else { |
||
65 | $error_messages[] = $res; |
||
66 | } |
||
67 | } else if ($_REQUEST['submit'] === "SaveUnlock") { |
||
68 | //save page |
||
69 | $res = $this->save($page); |
||
70 | |||
71 | if ($res === true) { |
||
72 | //unlock page |
||
73 | Page::unlockPage($page->getPageID()); |
||
74 | |||
75 | //redirect to admin/pages |
||
76 | header("Location: " . DomainUtils::generateURL("admin/pages")); |
||
77 | |||
78 | ob_flush(); |
||
79 | ob_end_flush(); |
||
80 | |||
81 | exit; |
||
82 | } else { |
||
83 | $error_messages[] = $res; |
||
84 | } |
||
85 | } else if ($_REQUEST['submit'] === "Publish") { |
||
86 | //save page |
||
87 | $res = $this->save($page); |
||
88 | |||
89 | if ($res === true) { |
||
90 | $success_messages[] = "Saved page successfully!"; |
||
91 | } else { |
||
92 | $error_messages[] = $res; |
||
93 | } |
||
94 | |||
95 | //publish page |
||
96 | $res = $this->publish($page); |
||
97 | |||
98 | if ($res === true) { |
||
99 | $success_messages[] = "Page published successfully!"; |
||
100 | } else { |
||
101 | $error_messages[] = $res; |
||
102 | } |
||
103 | } |
||
104 | } |
||
105 | |||
106 | $template->assign("action_url", DomainUtils::generateURL($this->getPage()->getAlias(), array("edit" => $pageID))); |
||
107 | |||
108 | $template->assign("page", array( |
||
109 | 'id' => $page->getPageID(), |
||
110 | 'alias' => "/" . $page->getAlias(), |
||
111 | 'title' => $page->getTitle(), |
||
112 | 'content' => $page->getContent(), |
||
113 | 'is_published' => $page->isPublished(), |
||
114 | 'can_publish' => (!$page->isPublished() && (PermissionChecker::current()->hasRight("can_publish_all_pages") || (PermissionChecker::current()->hasRight("can_publish_own_pages") && $page->getAuthorID() == User::current()->getID()))), |
||
115 | 'can_change_owner' => (PermissionChecker::current()->hasRight("can_change_page_owner") || $page->getAuthorID() == User::current()->getID()), |
||
116 | 'folder' => $page->getFolder(), |
||
117 | 'preview_url' => DomainUtils::generateURL($page->getAlias(), array("preview" => "true")), |
||
118 | 'current_style' => $page->getStyle(), |
||
119 | 'template' => $page->getCustomTemplate(), |
||
120 | 'has_custom_template' => $page->hasCustomTemplate(), |
||
121 | 'parent' => $page->getParentID(), |
||
122 | 'meta_description' => $page->getMetaDescription(), |
||
123 | 'meta_keywords' => $page->getMetaKeywords(), |
||
124 | 'meta_robots' => $page->getMetaRobotsOptions(), |
||
125 | 'meta_canonicals' => $page->getMetaCanonicals(), |
||
126 | 'has_canoncials' => !empty($page->getMetaCanonicals()), |
||
127 | 'sitemap' => $page->isSitemapEnabled(), |
||
128 | 'sitemap_changefreq' => $page->getSitemapChangeFreq(), |
||
129 | 'sitemap_priority' => $page->getSitemapPriority() |
||
130 | )); |
||
131 | |||
132 | //set available styles |
||
133 | $template->assign("styles", StyleController::listAllStyles()); |
||
134 | |||
135 | //get all pages from database |
||
136 | $pages = array(); |
||
137 | $rows = Database::getInstance()->listRows("SELECT `id`, `alias` FROM `{praefix}pages` WHERE `editable` = '1' AND `activated` = '1'; "); |
||
138 | |||
139 | foreach ($rows as $row) { |
||
140 | $pages[] = array( |
||
141 | 'id' => $row['id'], |
||
142 | 'alias' => $row['alias'] |
||
143 | ); |
||
144 | } |
||
145 | |||
146 | $template->assign("parent_pages", $pages); |
||
147 | |||
148 | //https://developers.google.com/search/reference/robots_meta_tag?hl=de |
||
149 | $robots_options = array( |
||
150 | "all", |
||
151 | "noindex", |
||
152 | "nofollow", |
||
153 | "none", |
||
154 | "noarchive", |
||
155 | "nosnippet", |
||
156 | "noodp", |
||
157 | "notranslate", |
||
158 | "noimageindex", |
||
159 | "unavailable_after: " |
||
160 | ); |
||
161 | |||
162 | $template->assign("robots_options", $robots_options); |
||
163 | |||
164 | $sitemap_change_frequencies = array( |
||
165 | "AlWAYS", "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY", "NEVER" |
||
166 | ); |
||
167 | |||
168 | $template->assign("sitemap_changefreq", $sitemap_change_frequencies); |
||
169 | |||
170 | //add support to show additional code from plugins |
||
171 | $additional_code_header = ""; |
||
172 | $additional_code_footer = ""; |
||
173 | |||
174 | Events::throwEvent("page_edit_additional_code_header", array( |
||
175 | 'page' => &$page, |
||
176 | 'code' => &$additional_code_header |
||
177 | )); |
||
178 | |||
179 | $template->assign("additional_code_header", $additional_code_footer); |
||
180 | |||
181 | Events::throwEvent("page_edit_additional_code_footer", array( |
||
182 | 'page' => &$page, |
||
183 | 'code' => &$additional_code_footer |
||
184 | )); |
||
185 | |||
186 | $template->assign("additional_code_footer", $additional_code_footer); |
||
187 | |||
188 | $template->assign("errors", $error_messages); |
||
189 | $template->assign("success_messages", $success_messages); |
||
190 | |||
191 | return $template->getCode(); |
||
192 | } |
||
193 | |||
194 | protected function save (Page &$page) { |
||
255 | } |
||
256 | |||
257 | protected function publish (Page &$page) { |
||
258 | //check permissions for publishing |
||
259 | if (PermissionChecker::current()->hasRight("can_publish_all_pages") || (PermissionChecker::current()->hasRight("can_publish_own_pages") && $page->getAuthorID() == User::current()->getID())) { |
||
260 | //update page in database |
||
261 | Database::getInstance()->execute("UPDATE `{praefix}pages` SET `published` = '1' WHERE `id` = :pageID; ", array( |
||
262 | 'pageID' => $page->getPageID() |
||
263 | )); |
||
264 | |||
265 | //clear cache |
||
266 | $page->clearCache(); |
||
267 | |||
268 | //reload page from database |
||
269 | $page->loadByID($page->getPageID(), false); |
||
270 | |||
271 | //TODO: remove this line later |
||
272 | Cache::clear("pages"); |
||
273 | |||
274 | return true; |
||
275 | } else { |
||
276 | return "You don't have the permissions to publish this page!"; |
||
277 | } |
||
278 | } |
||
279 | |||
280 | protected function showError (string $message) : string { |
||
285 | } |
||
286 | |||
287 | public function getFooterScripts(): string { |
||
308 | <script>tinymce.init({ |
||
309 | selector: 'textarea', |
||
310 | height: 500, |
||
311 | theme: 'modern', |
||
312 | removed_menuitems: 'newdocument', |
||
313 | plugins: 'print preview searchreplace autolink directionality visualblocks visualchars fullscreen image link media template codesample table charmap hr pagebreak nonbreaking anchor toc insertdatetime advlist lists textcolor wordcount imagetools contextmenu colorpicker textpattern help', |
||
314 | toolbar1: 'formatselect | bold italic strikethrough forecolor backcolor | link | alignleft aligncenter alignright alignjustify | numlist bullist outdent indent | removeformat', |
||
315 | image_advtab: true |
||
316 | }); |
||
317 | |||
318 | document.getElementById('customTplCheckbox').onchange = function() { |
||
319 | document.getElementById('inputTpl').disabled = !this.checked; |
||
320 | |||
321 | if (!this.checked) { |
||
322 | document.getElementById('inputTpl').value = 'none'; |
||
323 | } |
||
324 | }; |
||
325 | |||
326 | document.getElementById('customCanoncialsCheckbox').onchange = function() { |
||
327 | document.getElementById('inputCanoncials').disabled = !this.checked; |
||
328 | |||
329 | if (!this.checked) { |
||
330 | document.getElementById('inputCanoncials').value = ''; |
||
331 | } |
||
332 | }; |
||
333 | </script>"; |
||
334 | } |
||
335 | |||
336 | public function listRequiredPermissions(): array { |
||
343 |
For hinted functions/methods where all return statements with the correct type are only reachable via conditions, ?null? gets implicitly returned which may be incompatible with the hinted type. Let?s take a look at an example: