Total Complexity | 43 |
Total Lines | 276 |
Duplicated Lines | 0 % |
Changes | 5 | ||
Bugs | 1 | Features | 0 |
Complex classes like DocumentRouting 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 DocumentRouting, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
18 | class DocumentRouting implements CmsRouting |
||
19 | { |
||
20 | /** |
||
21 | * DocumentRouting constructor. |
||
22 | * @param $request |
||
23 | * @param $relativeCmsUri |
||
24 | * @param CmsComponent $cmsComponent |
||
25 | * @throws \Exception |
||
26 | */ |
||
27 | public function __construct(Request $request, $relativeCmsUri, CmsComponent $cmsComponent) |
||
34 | } |
||
35 | |||
36 | |||
37 | /** |
||
38 | * @param Request $request |
||
39 | * @param string $relativeCmsUri |
||
40 | * @param CmsComponent $cmsComponent |
||
41 | * @throws \Exception |
||
42 | */ |
||
43 | private function documentRouting($request, $relativeCmsUri, $cmsComponent) |
||
54 | } |
||
55 | } |
||
56 | } |
||
57 | |||
58 | /** |
||
59 | * @param $request |
||
60 | * @param CmsComponent $cmsComponent |
||
61 | * |
||
62 | * @throws \Exception |
||
63 | */ |
||
64 | private function documentNewRoute($request, $cmsComponent) |
||
65 | { |
||
66 | $cmsComponent->subTemplate = 'documents/document-form'; |
||
67 | $cmsComponent->setParameter(CmsConstants::PARAMETER_MAIN_NAV_CLASS, CmsConstants::PARAMETER_DOCUMENTS); |
||
68 | $cmsComponent->setParameter(CmsConstants::PARAMETER_SMALLEST_IMAGE, $cmsComponent->storage->getImageSet()->getSmallestImageSet()->slug); |
||
69 | if (isset($request::$get[CmsConstants::PARAMETER_DOCUMENT_TYPE])) { |
||
70 | if (isset($request::$post[CmsConstants::POST_PARAMETER_TITLE], $request::$get[CmsConstants::PARAMETER_DOCUMENT_TYPE], $request::$get[CmsConstants::GET_PARAMETER_PATH])) { |
||
71 | $this->createNewDocument($request, $cmsComponent); |
||
72 | } |
||
73 | $this->putDocumentTypeOnRequest($request, $cmsComponent); |
||
74 | $cmsComponent->setParameter(CmsConstants::PARAMETER_BRICKS, $cmsComponent->storage->getBricks()->getBricks()); |
||
75 | } else { |
||
76 | $documentTypes = $cmsComponent->storage->getDocumentTypes()->getDocumentTypes(); |
||
77 | $this->checkDocumentType($request, $cmsComponent, $documentTypes); |
||
78 | $cmsComponent->setParameter(CmsConstants::PARAMETER_DOCUMENT_TYPES, $documentTypes); |
||
79 | } |
||
80 | } |
||
81 | |||
82 | /** |
||
83 | * @param $request |
||
84 | * @param CmsComponent $cmsComponent |
||
85 | * @throws \Exception |
||
86 | */ |
||
87 | private function editDocumentRoute($request, $cmsComponent) |
||
120 | } |
||
121 | |||
122 | /** |
||
123 | * @param $request |
||
124 | * @param CmsComponent $cmsComponent |
||
125 | * @throws \Exception |
||
126 | */ |
||
127 | private function getBrickRoute($request, $cmsComponent) |
||
128 | { |
||
129 | $cmsComponent->setParameter(CmsConstants::PARAMETER_SMALLEST_IMAGE, $cmsComponent->storage->getImageSet()->getSmallestImageSet()->slug); |
||
130 | $cmsComponent->subTemplate = 'documents/brick'; |
||
131 | $cmsComponent->setParameter(CmsConstants::PARAMETER_BRICK, $cmsComponent->storage->getBricks()->getBrickBySlug($request::$get[CmsConstants::GET_PARAMETER_SLUG])); |
||
132 | $cmsComponent->setParameter(CmsConstants::PARAMETER_STATIC, $request::$get[CmsConstants::PARAMETER_STATIC] === 'true'); |
||
133 | if (isset($request::$get[CmsConstants::PARAMETER_MY_BRICK_SLUG])) { |
||
134 | $cmsComponent->setParameter(CmsConstants::PARAMETER_MY_BRICK_SLUG, $request::$get[CmsConstants::PARAMETER_MY_BRICK_SLUG]); |
||
135 | } |
||
136 | $result = new \stdClass(); |
||
137 | $result->body = $cmsComponent->renderTemplate('documents/brick'); |
||
138 | $result->rteList = isset($GLOBALS['rteList']) ? $GLOBALS['rteList'] : array(); |
||
139 | ob_clean(); |
||
140 | header(CmsConstants::CONTENT_TYPE_APPLICATION_JSON); |
||
141 | die(json_encode($result)); |
||
142 | } |
||
143 | |||
144 | /** |
||
145 | * @param $request |
||
146 | * @param CmsComponent $cmsComponent |
||
147 | */ |
||
148 | private function deleteDocumentRoute($request, $cmsComponent) |
||
149 | { |
||
150 | $cmsComponent->storage->getDocuments()->deleteDocumentBySlug($request::$get[CmsConstants::GET_PARAMETER_SLUG]); |
||
151 | $cmsComponent->storage->getActivityLog()->add('deleted document /' . $request::$get[CmsConstants::GET_PARAMETER_SLUG], 'trash'); |
||
152 | header('Location: ' . $request::$subfolders . $cmsComponent->getParameter(CmsConstants::PARAMETER_CMS_PREFIX) . '/documents?document-delete'); |
||
153 | exit; |
||
154 | } |
||
155 | |||
156 | /** |
||
157 | * @param $request |
||
158 | * @param CmsComponent $cmsComponent |
||
159 | */ |
||
160 | private function publishDocumentRoute($request, $cmsComponent) |
||
161 | { |
||
162 | $cmsComponent->storage->getDocuments()->publishDocumentBySlug($request::$get[CmsConstants::GET_PARAMETER_SLUG]); |
||
163 | $this->clearCacheAndLogActivity($request, $cmsComponent); |
||
164 | $this->doAfterPublishRedirect($request, $cmsComponent); |
||
165 | } |
||
166 | |||
167 | /** |
||
168 | * @param $request |
||
169 | * @param CmsComponent $cmsComponent |
||
170 | */ |
||
171 | private function unpublishDocumentRoute($request, $cmsComponent) |
||
172 | { |
||
173 | $cmsComponent->storage->getDocuments()->unpublishDocumentBySlug($request::$get[CmsConstants::GET_PARAMETER_SLUG]); |
||
174 | $this->clearCacheAndLogActivity($request, $cmsComponent, 'times-circle-o', 'unpublished'); |
||
175 | $this->doAfterPublishRedirect($request, $cmsComponent, 'unpublished'); |
||
176 | } |
||
177 | |||
178 | /** |
||
179 | * @param CmsComponent $cmsComponent |
||
180 | * @param Request $request |
||
181 | * @throws \Exception |
||
182 | */ |
||
183 | private function overviewRouting($cmsComponent, $request) |
||
184 | { |
||
185 | $cmsComponent->subTemplate = 'documents'; |
||
186 | $cmsComponent->setParameter(CmsConstants::PARAMETER_DOCUMENTS, $cmsComponent->storage->getDocuments()->getDocumentsWithState()); |
||
187 | $cmsComponent->setParameter(CmsConstants::PARAMETER_MAIN_NAV_CLASS, CmsConstants::PARAMETER_DOCUMENTS); |
||
188 | |||
189 | $documentCount = $cmsComponent->storage->getDocuments()->getTotalDocumentCount(); |
||
190 | $indexer = new Search($cmsComponent->storage); |
||
191 | $indexedDocuments = $indexer->getIndexedDocuments(); |
||
192 | $cmsComponent->setParameter(CmsConstants::PARAMETER_SEARCH_NEEDS_UPDATE, $documentCount !== $indexedDocuments); |
||
193 | |||
194 | $this->handleInfoMessages($cmsComponent, $request); |
||
195 | } |
||
196 | |||
197 | /** |
||
198 | * @param CmsComponent $cmsComponent |
||
199 | * @param Request $request |
||
200 | */ |
||
201 | private function handleInfoMessages($cmsComponent, $request) |
||
202 | { |
||
203 | if (isset($_GET['not-found'])) { |
||
204 | $cmsComponent->setParameter('infoMessage', 'Document could not be found. It might have been removed.'); |
||
205 | $cmsComponent->setParameter('infoMessageClass', 'error'); |
||
206 | } elseif (isset($_GET['published'])) { |
||
207 | $cmsComponent->setParameter('infoMessage', '<i class="fa fa-check-circle-o"></i> Document ' . $_GET['published'] . ' published'); |
||
208 | } elseif (isset($_GET['unpublished'])) { |
||
209 | $cmsComponent->setParameter('infoMessage', '<i class="fa fa-times-circle-o"></i> Document ' . $_GET['unpublished'] . ' unpublished'); |
||
210 | } elseif (isset($_GET['folder-delete'])) { |
||
211 | $cmsComponent->setParameter('infoMessage', '<i class="fa fa-trash"></i> Folder deleted'); |
||
212 | } elseif (isset($_GET['document-delete'])) { |
||
213 | $cmsComponent->setParameter('infoMessage', '<i class="fa fa-trash"></i> Document deleted'); |
||
214 | } elseif (isset($_GET['no-document-types'])) { |
||
215 | $documentTypesLink = $request::$subfolders . $cmsComponent->getParameter(CmsConstants::PARAMETER_CMS_PREFIX) . '/configuration/document-types/new'; |
||
216 | $cmsComponent->setParameter('infoMessage', '<i class="fa fa-exclamation-circle"></i> No document types defined yet. Please do so first, <a href="' . $documentTypesLink . '">here</a>.'); |
||
217 | } |
||
218 | } |
||
219 | |||
220 | /** |
||
221 | * @param $request |
||
222 | * @param $cmsComponent |
||
223 | * @param string $param |
||
224 | */ |
||
225 | private function doAfterPublishRedirect($request, $cmsComponent, $param = 'published') |
||
226 | { |
||
227 | if ($cmsComponent->autoUpdateSearchIndex) { |
||
228 | header('Location: ' . $request::$subfolders . $cmsComponent->getParameter(CmsConstants::PARAMETER_CMS_PREFIX) . '/search/update-index?returnUrl=' . urlencode($request::$subfolders . $cmsComponent->getParameter(CmsConstants::PARAMETER_CMS_PREFIX) . '/documents?' . $param . '=' . urlencode($request::$get[CmsConstants::GET_PARAMETER_SLUG]))); |
||
229 | } else { |
||
230 | header('Location: ' . $request::$subfolders . $cmsComponent->getParameter(CmsConstants::PARAMETER_CMS_PREFIX) . '/documents?' . $param . '=' . urlencode($request::$get[CmsConstants::GET_PARAMETER_SLUG])); |
||
231 | } |
||
232 | exit; |
||
233 | } |
||
234 | |||
235 | /** |
||
236 | * @param $request |
||
237 | * @param $cmsComponent |
||
238 | * @param string $icon |
||
239 | * @param string $activity |
||
240 | */ |
||
241 | private function clearCacheAndLogActivity($request, $cmsComponent, $icon = 'check-circle-o', $activity = 'published') |
||
242 | { |
||
243 | Cache::getInstance()->clearCache(); |
||
244 | $path = $request::$get[CmsConstants::GET_PARAMETER_SLUG]; |
||
245 | $docLink = $request::$subfolders . $cmsComponent->getParameter(CmsConstants::PARAMETER_CMS_PREFIX) . '/documents/edit-document?slug=' . $path; |
||
246 | $cmsComponent->storage->getActivityLog()->add($activity. ' document <a href="' . $docLink . '">' . $request::$get[CmsConstants::GET_PARAMETER_SLUG] . '</a>', $icon); |
||
247 | } |
||
248 | |||
249 | /** |
||
250 | * @param $request |
||
251 | * @param $cmsComponent |
||
252 | */ |
||
253 | private function createNewDocument($request, $cmsComponent) |
||
254 | { |
||
255 | $path = substr($cmsComponent->storage->getDocuments()->addDocument($request::$post), 1); |
||
256 | $docLink = $request::$subfolders . $cmsComponent->getParameter(CmsConstants::PARAMETER_CMS_PREFIX) . '/documents/edit-document?slug=' . $path; |
||
257 | $cmsComponent->storage->getActivityLog()->add('created document <a href="' . $docLink . '">' . $request::$post[CmsConstants::POST_PARAMETER_TITLE] . '</a> in path ' . $request::$get[CmsConstants::GET_PARAMETER_PATH], 'plus'); |
||
258 | if (isset($request::$post[CmsConstants::PARAMETER_SAVE_AND_PUBLISH])) { |
||
259 | header('Location: ' . $request::$subfolders . $cmsComponent->getParameter(CmsConstants::PARAMETER_CMS_PREFIX) . '/documents/publish-document?slug=' . $path); |
||
260 | } else { |
||
261 | header('Location: ' . $request::$subfolders . $cmsComponent->getParameter(CmsConstants::PARAMETER_CMS_PREFIX) . '/documents'); |
||
262 | } |
||
263 | exit; |
||
264 | } |
||
265 | |||
266 | /** |
||
267 | * @param $request |
||
268 | * @param $cmsComponent |
||
269 | */ |
||
270 | private function putDocumentTypeOnRequest($request, $cmsComponent) |
||
278 | } |
||
279 | |||
280 | /** |
||
281 | * @param $request |
||
282 | * @param $cmsComponent |
||
283 | * @param $documentTypes |
||
284 | */ |
||
285 | private function checkDocumentType($request, $cmsComponent, $documentTypes) |
||
294 | } |
||
295 | } |
||
296 | } |
According to the PSR-2, the body of a case statement must start on the line immediately following the case statement.
}
To learn more about the PSR-2 coding standard, please refer to the PHP-Fig.