bedita /
manager
| Total Complexity | 70 |
| Total Lines | 700 |
| Duplicated Lines | 0 % |
| Changes | 5 | ||
| Bugs | 2 | Features | 0 |
Complex classes like ModulesController 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 ModulesController, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 45 | class ModulesController extends AppController |
||
| 46 | { |
||
| 47 | use ApiConfigTrait; |
||
| 48 | use PermissionsTrait; |
||
| 49 | |||
| 50 | /** |
||
| 51 | * Object type currently used |
||
| 52 | * |
||
| 53 | * @var string |
||
| 54 | */ |
||
| 55 | protected $objectType = null; |
||
| 56 | |||
| 57 | /** |
||
| 58 | * @inheritDoc |
||
| 59 | */ |
||
| 60 | public function initialize(): void |
||
| 61 | { |
||
| 62 | parent::initialize(); |
||
| 63 | |||
| 64 | $this->loadComponent('Children'); |
||
| 65 | $this->loadComponent('History'); |
||
| 66 | $this->loadComponent('ObjectsEditors'); |
||
| 67 | $this->loadComponent('Parents'); |
||
| 68 | $this->loadComponent('Properties'); |
||
| 69 | $this->loadComponent('ProjectConfiguration'); |
||
| 70 | $this->loadComponent('Query'); |
||
| 71 | $this->loadComponent('Thumbs', Configure::read('Thumbs', [])); |
||
| 72 | $this->loadComponent('BEdita/WebTools.ApiFormatter'); |
||
| 73 | if ($this->getRequest()->getParam('object_type')) { |
||
| 74 | $this->objectType = $this->getRequest()->getParam('object_type'); |
||
| 75 | $this->Modules->setConfig('currentModuleName', $this->objectType); |
||
| 76 | $this->Schema->setConfig('type', $this->objectType); |
||
| 77 | } |
||
| 78 | $this->Security->setConfig('unlockedActions', ['save', 'setup']); |
||
| 79 | } |
||
| 80 | |||
| 81 | /** |
||
| 82 | * {@inheritDoc} |
||
| 83 | * |
||
| 84 | * @codeCoverageIgnore |
||
| 85 | */ |
||
| 86 | public function beforeRender(EventInterface $event): ?Response |
||
| 91 | } |
||
| 92 | |||
| 93 | /** |
||
| 94 | * Display resources list. |
||
| 95 | * |
||
| 96 | * @return \Cake\Http\Response|null |
||
| 97 | */ |
||
| 98 | public function index(): ?Response |
||
| 150 | } |
||
| 151 | |||
| 152 | /** |
||
| 153 | * View single resource. |
||
| 154 | * |
||
| 155 | * @param string|int $id Resource ID. |
||
| 156 | * @return \Cake\Http\Response|null |
||
| 157 | */ |
||
| 158 | public function view($id): ?Response |
||
| 208 | } |
||
| 209 | |||
| 210 | /** |
||
| 211 | * View single resource by id, doing a proper redirect (302) to resource module view by type. |
||
| 212 | * If no resource found by ID, redirect to referer. |
||
| 213 | * |
||
| 214 | * @param string|int $id Resource ID. |
||
| 215 | * @return \Cake\Http\Response|null |
||
| 216 | */ |
||
| 217 | public function uname($id): ?Response |
||
| 218 | { |
||
| 219 | try { |
||
| 220 | $response = $this->apiClient->get(sprintf('/objects/%s', $id)); |
||
| 221 | } catch (BEditaClientException $e) { |
||
| 222 | $msg = $e->getMessage(); |
||
| 223 | $msgNotFound = sprintf(__('Resource "%s" not found', true), $id); |
||
| 224 | $msgNotAvailable = sprintf(__('Resource "%s" not available. Error: %s', true), $id, $msg); |
||
| 225 | $error = $e->getCode() === 404 ? $msgNotFound : $msgNotAvailable; |
||
| 226 | $this->Flash->error($error); |
||
| 227 | |||
| 228 | return $this->redirect($this->referer()); |
||
| 229 | } |
||
| 230 | $_name = 'modules:view'; |
||
| 231 | $object_type = $response['data']['type']; |
||
| 232 | $id = $response['data']['id']; |
||
| 233 | |||
| 234 | return $this->redirect(compact('_name', 'object_type', 'id')); |
||
| 235 | } |
||
| 236 | |||
| 237 | /** |
||
| 238 | * Display new resource form. |
||
| 239 | * |
||
| 240 | * @return \Cake\Http\Response|null |
||
| 241 | */ |
||
| 242 | public function create(): ?Response |
||
| 276 | } |
||
| 277 | |||
| 278 | /** |
||
| 279 | * Create new object from ajax request. |
||
| 280 | * |
||
| 281 | * @return void |
||
| 282 | */ |
||
| 283 | public function save(): void |
||
| 284 | { |
||
| 285 | $this->viewBuilder()->setClassName('Json'); // force json response |
||
| 286 | $this->getRequest()->allowMethod(['post']); |
||
| 287 | $requestData = $this->prepareRequest($this->objectType); |
||
| 288 | unset($requestData['_csrfToken']); |
||
| 289 | // extract related objects data |
||
| 290 | $relatedData = (array)Hash::get($requestData, '_api'); |
||
| 291 | unset($requestData['_api']); |
||
| 292 | |||
| 293 | try { |
||
| 294 | $uname = Hash::get($requestData, 'uname'); |
||
| 295 | if (!empty($uname) && is_numeric($uname)) { |
||
| 296 | $this->set(['error' => __('Invalid numeric uname. Change it to a valid string')]); |
||
| 297 | $this->setSerialize(['error']); |
||
| 298 | |||
| 299 | return; |
||
| 300 | } |
||
| 301 | $id = (string)Hash::get($requestData, 'id'); |
||
| 302 | // skip save if no data changed |
||
| 303 | $schema = (array)$this->Schema->getSchema($this->objectType); |
||
| 304 | $permissions = (array)Hash::get($requestData, 'permissions'); |
||
| 305 | $skipSaveObject = $this->Modules->skipSaveObject($id, $requestData); |
||
| 306 | $skipSaveRelated = $this->Modules->skipSaveRelated($id, $relatedData); |
||
| 307 | $skipSavePermissions = $this->Modules->skipSavePermissions($id, $permissions, $schema); |
||
| 308 | if ($skipSaveObject && $skipSaveRelated && $skipSavePermissions) { |
||
| 309 | $response = $this->apiClient->getObject($id, $this->objectType, ['count' => 'all']); |
||
| 310 | $this->Thumbs->urls($response); |
||
| 311 | $this->set((array)$response); |
||
| 312 | $this->setSerialize(array_keys($response)); |
||
| 313 | |||
| 314 | return; |
||
| 315 | } |
||
| 316 | |||
| 317 | // upload file (if available) |
||
| 318 | $this->Modules->upload($requestData); |
||
| 319 | |||
| 320 | // save data |
||
| 321 | $lang = I18n::getLocale(); |
||
| 322 | $headers = ['Accept-Language' => $lang]; |
||
| 323 | if (!$skipSaveObject) { |
||
| 324 | $response = $this->apiClient->save($this->objectType, $requestData, $headers); |
||
| 325 | } else { |
||
| 326 | $response = $this->apiClient->getObject($id, $this->objectType); |
||
| 327 | } |
||
| 328 | if (!$skipSavePermissions) { |
||
| 329 | try { |
||
| 330 | $this->savePermissions( |
||
| 331 | (array)$response, |
||
| 332 | $schema, |
||
| 333 | $permissions |
||
| 334 | ); |
||
| 335 | } catch (BEditaClientException $error) { |
||
| 336 | $this->handleError($error); |
||
| 337 | } |
||
| 338 | } |
||
| 339 | $id = (string)Hash::get($response, 'data.id'); |
||
| 340 | if (!$skipSaveRelated) { |
||
| 341 | try { |
||
| 342 | $this->Modules->saveRelated($id, $this->objectType, $relatedData); |
||
| 343 | } catch (BEditaClientException $error) { |
||
| 344 | $this->handleError($error); |
||
| 345 | } |
||
| 346 | } |
||
| 347 | $options = [ |
||
| 348 | 'id' => Hash::get($response, 'data.id'), |
||
| 349 | 'type' => $this->objectType, |
||
| 350 | 'data' => $requestData, |
||
| 351 | ]; |
||
| 352 | $event = new Event('Controller.afterSave', $this, $options); |
||
| 353 | $this->getEventManager()->dispatch($event); |
||
| 354 | } catch (BEditaClientException $error) { |
||
| 355 | $this->handleError($error); |
||
| 356 | |||
| 357 | return; |
||
| 358 | } |
||
| 359 | if ($response['data']) { |
||
| 360 | $response['data'] = [ $response['data'] ]; |
||
| 361 | } |
||
| 362 | |||
| 363 | $this->Thumbs->urls($response); |
||
| 364 | |||
| 365 | $this->set((array)$response); |
||
| 366 | $this->setSerialize(array_keys($response)); |
||
| 367 | } |
||
| 368 | |||
| 369 | /** |
||
| 370 | * Handle exception error: log, flash and set. |
||
| 371 | * |
||
| 372 | * @param \BEdita\SDK\BEditaClientException $exception The exception |
||
| 373 | * @return void |
||
| 374 | */ |
||
| 375 | protected function handleError(BEditaClientException $exception): void |
||
| 376 | { |
||
| 377 | $message = new Message($exception); |
||
| 378 | $this->log($message->get(), LogLevel::ERROR); |
||
| 379 | $this->Flash->error($message->get(), ['params' => $exception]); |
||
| 380 | $error = $this->viewBuilder()->getVar('error') ?? []; |
||
| 381 | $error = is_array($error) ? array_merge($error, [$message->get()]) : [$error, $message->get()]; |
||
| 382 | $this->set(['error' => $error]); |
||
| 383 | $this->setSerialize(['error']); |
||
| 384 | } |
||
| 385 | |||
| 386 | /** |
||
| 387 | * Clone single object. |
||
| 388 | * |
||
| 389 | * @param string|int $id Object ID. |
||
| 390 | * @return \Cake\Http\Response|null |
||
| 391 | */ |
||
| 392 | public function clone($id): ?Response |
||
| 393 | { |
||
| 394 | $this->viewBuilder()->setTemplate('view'); |
||
| 395 | $schema = $this->Schema->getSchema(); |
||
| 396 | if (!is_array($schema)) { |
||
| 397 | $this->Flash->error(__('Cannot create abstract objects or objects without schema')); |
||
| 398 | |||
| 399 | return $this->redirect(['_name' => 'modules:list', 'object_type' => $this->objectType]); |
||
| 400 | } |
||
| 401 | try { |
||
| 402 | $modified = [ |
||
| 403 | 'title' => $this->getRequest()->getQuery('title'), |
||
| 404 | 'status' => 'draft', |
||
| 405 | ]; |
||
| 406 | $reset = (array)Configure::read(sprintf('Clone.%s.reset', $this->objectType)); |
||
| 407 | foreach ($reset as $field) { |
||
| 408 | $modified[$field] = null; |
||
| 409 | } |
||
| 410 | $included = []; |
||
| 411 | foreach (['relationships', 'translations'] as $attribute) { |
||
| 412 | if ($this->getRequest()->getQuery($attribute) === 'true') { |
||
| 413 | $included[] = $attribute; |
||
| 414 | } |
||
| 415 | } |
||
| 416 | $clone = $this->apiClient->clone($this->objectType, $id, $modified, $included); |
||
| 417 | $id = (string)Hash::get($clone, 'data.id'); |
||
| 418 | } catch (BEditaClientException $e) { |
||
| 419 | $this->log($e->getMessage(), LogLevel::ERROR); |
||
| 420 | $this->Flash->error($e->getMessage(), ['params' => $e]); |
||
| 421 | } |
||
| 422 | |||
| 423 | return $this->redirect(['_name' => 'modules:view', 'object_type' => $this->objectType, 'id' => $id]); |
||
| 424 | } |
||
| 425 | |||
| 426 | /** |
||
| 427 | * Delete single resource. |
||
| 428 | * |
||
| 429 | * @return \Cake\Http\Response|null |
||
| 430 | */ |
||
| 431 | public function delete(): ?Response |
||
| 432 | { |
||
| 433 | $this->getRequest()->allowMethod(['post']); |
||
| 434 | $id = $this->getRequest()->getData('id'); |
||
| 435 | $ids = $this->getRequest()->getData('ids'); |
||
| 436 | $ids = is_string($ids) ? explode(',', $ids) : $ids; |
||
| 437 | $ids = empty($ids) ? [$id] : $ids; |
||
| 438 | try { |
||
| 439 | $this->apiClient->deleteObjects($ids, $this->objectType); |
||
| 440 | $eventManager = $this->getEventManager(); |
||
| 441 | foreach ($ids as $id) { |
||
| 442 | $event = new Event('Controller.afterDelete', $this, ['id' => $id, 'type' => $this->objectType]); |
||
| 443 | $eventManager->dispatch($event); |
||
| 444 | } |
||
| 445 | } catch (BEditaClientException $e) { |
||
| 446 | $this->log($e->getMessage(), LogLevel::ERROR); |
||
| 447 | $this->Flash->error($e->getMessage(), ['params' => $e]); |
||
| 448 | $id = $this->getRequest()->getData('id'); |
||
| 449 | $options = empty($id) ? $this->referer() : ['_name' => 'modules:view', 'object_type' => $this->objectType, 'id' => $id]; |
||
| 450 | |||
| 451 | return $this->redirect($options); |
||
| 452 | } |
||
| 453 | $this->Flash->success(__('Object(s) deleted')); |
||
| 454 | |||
| 455 | return $this->redirect([ |
||
| 456 | '_name' => 'modules:list', |
||
| 457 | 'object_type' => $this->objectType, |
||
| 458 | ]); |
||
| 459 | } |
||
| 460 | |||
| 461 | /** |
||
| 462 | * Relation data load via API => `GET /:object_type/:id/related/:relation` |
||
| 463 | * |
||
| 464 | * @param string|int $id The object ID. |
||
| 465 | * @param string $relation The relation name. |
||
| 466 | * @return void |
||
| 467 | */ |
||
| 468 | public function related($id, string $relation): void |
||
| 469 | { |
||
| 470 | if ($id === 'new') { |
||
| 471 | $this->set('data', []); |
||
| 472 | $this->setSerialize(['data']); |
||
| 473 | |||
| 474 | return; |
||
| 475 | } |
||
| 476 | |||
| 477 | $this->getRequest()->allowMethod(['get']); |
||
| 478 | $query = $this->Query->prepare($this->getRequest()->getQueryParams()); |
||
| 479 | try { |
||
| 480 | $response = $this->apiClient->getRelated($id, $this->objectType, $relation, $query); |
||
| 481 | $response = $this->ApiFormatter->embedIncluded((array)$response); |
||
| 482 | } catch (BEditaClientException $error) { |
||
| 483 | $this->handleError($error); |
||
| 484 | |||
| 485 | return; |
||
| 486 | } |
||
| 487 | |||
| 488 | $this->Thumbs->urls($response); |
||
| 489 | |||
| 490 | $this->set((array)$response); |
||
| 491 | $this->setSerialize(array_keys($response)); |
||
| 492 | } |
||
| 493 | |||
| 494 | /** |
||
| 495 | * Load resources of $type callig api `GET /:type/` |
||
| 496 | * Json response |
||
| 497 | * |
||
| 498 | * @param string|int $id the object identifier. |
||
| 499 | * @param string $type the resource type name. |
||
| 500 | * @return void |
||
| 501 | */ |
||
| 502 | public function resources($id, string $type): void |
||
| 503 | { |
||
| 504 | $this->getRequest()->allowMethod(['get']); |
||
| 505 | $query = $this->Query->prepare($this->getRequest()->getQueryParams()); |
||
| 506 | try { |
||
| 507 | $response = $this->apiClient->get($type, $query); |
||
| 508 | } catch (BEditaClientException $error) { |
||
| 509 | $this->handleError($error); |
||
| 510 | |||
| 511 | return; |
||
| 512 | } |
||
| 513 | |||
| 514 | $this->set((array)$response); |
||
| 515 | $this->setSerialize(array_keys($response)); |
||
| 516 | } |
||
| 517 | |||
| 518 | /** |
||
| 519 | * Relation data load calling api `GET /:object_type/:id/relationships/:relation` |
||
| 520 | * Json response |
||
| 521 | * |
||
| 522 | * @param string|int $id The object ID. |
||
| 523 | * @param string $relation The relation name. |
||
| 524 | * @return void |
||
| 525 | */ |
||
| 526 | public function relationships($id, string $relation): void |
||
| 527 | { |
||
| 528 | $this->getRequest()->allowMethod(['get']); |
||
| 529 | $available = $this->availableRelationshipsUrl($relation); |
||
| 530 | |||
| 531 | try { |
||
| 532 | $query = $this->Query->prepare($this->getRequest()->getQueryParams()); |
||
| 533 | $response = $this->apiClient->get($available, $query); |
||
| 534 | |||
| 535 | $this->Thumbs->urls($response); |
||
| 536 | } catch (BEditaClientException $ex) { |
||
| 537 | $this->log($ex->getMessage(), LogLevel::ERROR); |
||
| 538 | |||
| 539 | $this->set('error', $ex->getMessage()); |
||
| 540 | $this->setSerialize(['error']); |
||
| 541 | |||
| 542 | return; |
||
| 543 | } |
||
| 544 | |||
| 545 | $this->set((array)$response); |
||
| 546 | $this->setSerialize(array_keys($response)); |
||
| 547 | } |
||
| 548 | |||
| 549 | /** |
||
| 550 | * Retrieve URL to get objects available for a relation |
||
| 551 | * |
||
| 552 | * @param string $relation The relation name. |
||
| 553 | * @return string |
||
| 554 | */ |
||
| 555 | protected function availableRelationshipsUrl(string $relation): string |
||
| 556 | { |
||
| 557 | $defaults = [ |
||
| 558 | 'children' => '/objects', |
||
| 559 | 'parent' => '/folders', |
||
| 560 | 'parents' => '/folders', |
||
| 561 | ]; |
||
| 562 | $defaultUrl = (string)Hash::get($defaults, $relation); |
||
| 563 | if (!empty($defaultUrl)) { |
||
| 564 | return $defaultUrl; |
||
| 565 | } |
||
| 566 | |||
| 567 | $relationsSchema = $this->Schema->getRelationsSchema(); |
||
| 568 | $types = $this->Modules->relatedTypes($relationsSchema, $relation); |
||
| 569 | |||
| 570 | return count($types) === 1 ? sprintf('/%s', $types[0]) : '/objects?filter[type][]=' . implode('&filter[type][]=', $types); |
||
| 571 | } |
||
| 572 | |||
| 573 | /** |
||
| 574 | * get object properties and format them for index |
||
| 575 | * |
||
| 576 | * @param string $objectType objecte type name |
||
| 577 | * @return array $schema |
||
| 578 | */ |
||
| 579 | public function getSchemaForIndex($objectType): array |
||
| 580 | { |
||
| 581 | $schema = (array)$this->Schema->getSchema($objectType); |
||
| 582 | |||
| 583 | // if prop is an enum then prepend an empty string for select element |
||
| 584 | if (!empty($schema['properties'])) { |
||
| 585 | foreach ($schema['properties'] as &$property) { |
||
| 586 | if (isset($property['enum'])) { |
||
| 587 | array_unshift($property['enum'], ''); |
||
| 588 | } |
||
| 589 | } |
||
| 590 | } |
||
| 591 | |||
| 592 | return $schema; |
||
| 593 | } |
||
| 594 | |||
| 595 | /** |
||
| 596 | * Get objectType |
||
| 597 | * |
||
| 598 | * @return string|null |
||
| 599 | */ |
||
| 600 | public function getObjectType(): ?string |
||
| 601 | { |
||
| 602 | return $this->objectType; |
||
| 603 | } |
||
| 604 | |||
| 605 | /** |
||
| 606 | * Set objectType |
||
| 607 | * |
||
| 608 | * @param string|null $objectType The object type |
||
| 609 | * @return void |
||
| 610 | */ |
||
| 611 | public function setObjectType(?string $objectType): void |
||
| 612 | { |
||
| 613 | $this->objectType = $objectType; |
||
| 614 | } |
||
| 615 | |||
| 616 | /** |
||
| 617 | * Set schemasByType and filtersByType, considering relations and schemas. |
||
| 618 | * |
||
| 619 | * @param array $relations The relations |
||
| 620 | * @return void |
||
| 621 | */ |
||
| 622 | private function setupViewRelations(array $relations): void |
||
| 623 | { |
||
| 624 | // setup relations schema |
||
| 625 | $relationsSchema = $this->Schema->getRelationsSchema(); |
||
| 626 | $this->set('relationsSchema', $relationsSchema); |
||
| 627 | |||
| 628 | // setup relations metadata |
||
| 629 | $this->Modules->setupRelationsMeta( |
||
| 630 | $relationsSchema, |
||
| 631 | $relations, |
||
| 632 | $this->Properties->relationsList($this->objectType), |
||
| 633 | $this->Properties->hiddenRelationsList($this->objectType), |
||
| 634 | $this->Properties->readonlyRelationsList($this->objectType) |
||
| 635 | ); |
||
| 636 | |||
| 637 | // set right types, considering the object type relations |
||
| 638 | $rel = (array)$this->viewBuilder()->getVar('relationsSchema'); |
||
| 639 | $rightTypes = \App\Utility\Schema::rightTypes($rel); |
||
| 640 | $this->set('rightTypes', $rightTypes); |
||
| 641 | |||
| 642 | // set schemas for relations right types |
||
| 643 | $schemasByType = $this->Schema->getSchemasByType($rightTypes); |
||
| 644 | $this->set('schemasByType', $schemasByType); |
||
| 645 | $this->set('filtersByType', $this->Properties->filtersByType($rightTypes)); |
||
| 646 | } |
||
| 647 | |||
| 648 | /** |
||
| 649 | * Get list of users / no email, no relationships, no links, no schema, no included. |
||
| 650 | * |
||
| 651 | * @return void |
||
| 652 | */ |
||
| 653 | public function users(): void |
||
| 667 | } |
||
| 668 | |||
| 669 | /** |
||
| 670 | * Get single resource, minimal data / no relationships, no links, no schema, no included. |
||
| 671 | * |
||
| 672 | * @param string $id The object ID |
||
| 673 | * @return void |
||
| 674 | */ |
||
| 675 | public function get(string $id): void |
||
| 708 | } |
||
| 709 | |||
| 710 | /** |
||
| 711 | * Setup module. |
||
| 712 | * |
||
| 713 | * @return \Cake\Http\Response|null |
||
| 714 | */ |
||
| 715 | public function setup(): ?Response |
||
| 745 | } |
||
| 746 | } |
||
| 747 |
