Total Complexity | 40 |
Total Lines | 783 |
Duplicated Lines | 0 % |
Changes | 0 |
Complex classes like IndexBlocksController 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 IndexBlocksController, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
21 | #[Security("is_granted('ROLE_ADMIN') or is_granted('ROLE_SESSION_MANAGER')")] |
||
22 | #[Route('/admin/index', name: 'admin_index_blocks')] |
||
23 | class IndexBlocksController extends BaseController |
||
24 | { |
||
25 | private bool $isAdmin = false; |
||
26 | private bool $isSessionAdmin = false; |
||
27 | private array $extAuthSource = []; |
||
28 | |||
29 | public function __construct( |
||
30 | private readonly TranslatorInterface $translator, |
||
31 | private readonly SettingsManager $settingsManager, |
||
32 | private readonly PageRepository $pageRepository, |
||
33 | private readonly PageCategoryRepository $pageCategoryRepository, |
||
34 | private readonly SerializerInterface $serializer |
||
35 | ) { |
||
36 | $this->extAuthSource = [ |
||
37 | 'extldap' => [], |
||
38 | 'ldap' => [], |
||
39 | ]; |
||
40 | } |
||
41 | |||
42 | public function __invoke(): JsonResponse |
||
129 | } |
||
130 | |||
131 | private function getItemsUsers(): array |
||
132 | { |
||
133 | $items = []; |
||
134 | $items[] = [ |
||
135 | 'class' => 'item-user-list', |
||
136 | 'url' => $this->generateUrl('legacy_main', ['name' => 'admin/user_list.php']), |
||
137 | 'label' => $this->translator->trans('User list'), |
||
138 | ]; |
||
139 | $items[] = [ |
||
140 | 'class' => 'item-user-add', |
||
141 | 'url' => $this->generateUrl('legacy_main', ['name' => 'admin/user_add.php']), |
||
142 | 'label' => $this->translator->trans('Add a user'), |
||
143 | ]; |
||
144 | |||
145 | if ($this->isAdmin) { |
||
146 | $items[] = [ |
||
147 | 'class' => 'item-user-export', |
||
148 | 'url' => $this->generateUrl('legacy_main', ['name' => 'admin/user_export.php']), |
||
149 | 'label' => $this->translator->trans('Export users list'), |
||
150 | ]; |
||
151 | $items[] = [ |
||
152 | 'class' => 'item-user-import', |
||
153 | 'url' => $this->generateUrl('legacy_main', ['name' => 'admin/user_import.php']), |
||
154 | 'label' => $this->translator->trans('Import users list'), |
||
155 | ]; |
||
156 | $items[] = [ |
||
157 | 'class' => 'item-user-import-update', |
||
158 | 'url' => $this->generateUrl('legacy_main', ['name' => 'admin/user_update_import.php']), |
||
159 | 'label' => $this->translator->trans('Edit users list'), |
||
160 | ]; |
||
161 | $items[] = [ |
||
162 | 'class' => 'item-user-import-anonymize', |
||
163 | 'url' => $this->generateUrl('legacy_main', ['name' => 'admin/user_anonymize_import.php']), |
||
164 | 'label' => $this->translator->trans('Anonymise users list'), |
||
165 | ]; |
||
166 | |||
167 | if (\count($this->extAuthSource['extldap']) > 0) { |
||
168 | $items[] = [ |
||
169 | 'class' => 'item-user-ldap-list', |
||
170 | 'url' => $this->generateUrl('legacy_main', ['name' => 'admin/ldap_users_list.php']), |
||
171 | 'label' => $this->translator->trans('Import LDAP users into the platform'), |
||
172 | ]; |
||
173 | } |
||
174 | |||
175 | $items[] = [ |
||
176 | 'class' => 'item-user-field', |
||
177 | 'url' => $this->generateUrl('legacy_main', ['name' => 'admin/extra_fields.php', 'type' => 'user']), |
||
178 | 'label' => $this->translator->trans('Profiling'), |
||
179 | ]; |
||
180 | $items[] = [ |
||
181 | 'class' => 'item-user-groups', |
||
182 | 'url' => $this->generateUrl('legacy_main', ['name' => 'admin/usergroups.php']), |
||
183 | 'label' => $this->translator->trans('Classes'), |
||
184 | ]; |
||
185 | |||
186 | if ('true' === $this->settingsManager->getSetting('admin.show_link_request_hrm_user')) { |
||
187 | $items[] = [ |
||
188 | 'class' => 'item-user-linking-requests', |
||
189 | 'url' => $this->generateUrl('legacy_main', ['name' => 'admin/user_linking_requests.php']), |
||
190 | 'label' => $this->translator->trans('Student linking requests'), |
||
191 | ]; |
||
192 | } |
||
193 | } else { |
||
194 | $items[] = [ |
||
195 | 'class' => 'item-user-import', |
||
196 | 'url' => $this->generateUrl('legacy_main', ['name' => 'admin/user_import.php']), |
||
197 | 'label' => $this->translator->trans('Import users list'), |
||
198 | ]; |
||
199 | $items[] = [ |
||
200 | 'class' => 'item-user-groups', |
||
201 | 'url' => $this->generateUrl('legacy_main', ['name' => 'admin/usergroups.php']), |
||
202 | 'label' => $this->translator->trans('Classes'), |
||
203 | ]; |
||
204 | |||
205 | if ('true' === $this->settingsManager->getSetting('session.limit_session_admin_role')) { |
||
206 | $items = array_filter($items, function (array $item) { |
||
207 | $urls = [ |
||
208 | $this->generateUrl('legacy_main', ['name' => 'admin/user_list.php']), |
||
209 | $this->generateUrl('legacy_main', ['name' => 'admin/user_add.php']), |
||
210 | ]; |
||
211 | |||
212 | return \in_array($item['url'], $urls, true); |
||
213 | }); |
||
214 | } |
||
215 | |||
216 | if ('true' === $this->settingsManager->getSetting('session.limit_session_admin_list_users')) { |
||
217 | $items = array_filter($items, function (array $item): bool { |
||
218 | $urls = [ |
||
219 | $this->generateUrl('legacy_main', ['name' => 'admin/user_list.php']), |
||
220 | ]; |
||
221 | |||
222 | return !\in_array($item['url'], $urls, true); |
||
223 | }); |
||
224 | } |
||
225 | |||
226 | if ('true' === $this->settingsManager->getSetting('session.allow_session_admin_extra_access')) { |
||
227 | $items[] = [ |
||
228 | 'class' => 'item-user-import-update', |
||
229 | 'url' => $this->generateUrl('legacy_main', ['name' => 'admin/user_update_import.php']), |
||
230 | 'label' => $this->translator->trans('Edit users list'), |
||
231 | ]; |
||
232 | $items[] = [ |
||
233 | 'class' => 'item-user-export', |
||
234 | 'url' => $this->generateUrl('legacy_main', ['name' => 'admin/user_export.php']), |
||
235 | 'label' => $this->translator->trans('Export users list'), |
||
236 | ]; |
||
237 | } |
||
238 | } |
||
239 | |||
240 | return array_values($items); |
||
241 | } |
||
242 | |||
243 | private function getExtraContent(string $title): ?array |
||
244 | { |
||
245 | /** @var Page|null $page */ |
||
246 | $page = $this->pageRepository->findOneBy(['title' => $title]); |
||
247 | |||
248 | $pageJsonld = $this->serializer->serialize($page, 'jsonld', ['groups' => ['adminblock:read']]); |
||
249 | $pageArray = json_decode($pageJsonld, true); |
||
250 | |||
251 | if ($page) { |
||
252 | return $pageArray; |
||
253 | } |
||
254 | |||
255 | /** @var PageCategory $category */ |
||
256 | $category = $this->pageCategoryRepository->findOneBy(['title' => $title]); |
||
257 | $categoryJsonld = $this->serializer->serialize($category, 'jsonld', ['groups' => ['page:read']]); |
||
258 | $categoryArray = json_decode($categoryJsonld, true); |
||
259 | |||
260 | if (empty($categoryArray)) { |
||
261 | return []; |
||
262 | } |
||
263 | |||
264 | return [ |
||
265 | 'category' => $categoryArray['@id'], |
||
266 | ]; |
||
267 | } |
||
268 | |||
269 | private function getItemsCourses(): array |
||
359 | } |
||
360 | |||
361 | private function getItemsPlatform(): array |
||
362 | { |
||
363 | $items = []; |
||
364 | $items[] = [ |
||
365 | 'class' => 'item-setting-list', |
||
366 | 'url' => $this->generateUrl('admin_settings'), |
||
367 | 'label' => $this->translator->trans('Configuration settings'), |
||
368 | ]; |
||
369 | $items[] = [ |
||
370 | 'class' => 'item-language-list', |
||
371 | 'url' => $this->generateUrl('legacy_main', ['name' => 'admin/languages.php']), |
||
372 | 'label' => $this->translator->trans('Languages'), |
||
373 | ]; |
||
374 | $items[] = [ |
||
375 | 'class' => 'item-plugin-list', |
||
376 | 'url' => $this->generateUrl( |
||
377 | 'legacy_main', |
||
378 | ['name' => 'admin/settings.php', 'category' => 'Plugins'] |
||
379 | ), |
||
380 | 'label' => $this->translator->trans('Plugins'), |
||
381 | ]; |
||
382 | $items[] = [ |
||
383 | 'class' => 'item-region-list', |
||
384 | 'url' => $this->generateUrl('legacy_main', ['name' => 'admin/settings.php', 'category' => 'Regions']), |
||
385 | 'label' => $this->translator->trans('Regions'), |
||
386 | ]; |
||
387 | $items[] = [ |
||
388 | 'class' => 'item-global-announcement', |
||
389 | 'url' => $this->generateUrl('legacy_main', ['name' => 'admin/system_announcements.php']), |
||
390 | 'label' => $this->translator->trans('Portal news'), |
||
391 | ]; |
||
392 | $items[] = [ |
||
393 | 'class' => 'item-global-agenda', |
||
394 | 'route' => ['name' => 'CCalendarEventList', 'query' => ['type' => 'global']], |
||
395 | 'label' => $this->translator->trans('Global agenda'), |
||
396 | ]; |
||
397 | $items[] = [ |
||
398 | 'class' => 'item-agenda-reminders', |
||
399 | 'url' => $this->generateUrl('legacy_main', ['name' => 'admin/import_course_agenda_reminders.php']), |
||
400 | 'label' => $this->translator->trans('Import course events'), |
||
401 | ]; |
||
402 | $items[] = [ |
||
403 | 'class' => 'item-pages-list', |
||
404 | 'route' => ['name' => 'PageList'], |
||
405 | 'label' => $this->translator->trans('Pages'), |
||
406 | ]; |
||
407 | $items[] = [ |
||
408 | 'class' => 'item-registration-page', |
||
409 | 'url' => $this->generateUrl('legacy_main', ['name' => 'admin/configure_inscription.php']), |
||
410 | 'label' => $this->translator->trans('Setting the registration page'), |
||
411 | ]; |
||
412 | $items[] = [ |
||
413 | 'class' => 'item-stats', |
||
414 | 'url' => $this->generateUrl('legacy_main', ['name' => 'admin/statistics/index.php']), |
||
415 | 'label' => $this->translator->trans('Statistics'), |
||
416 | ]; |
||
417 | $items[] = [ |
||
418 | 'class' => 'item-stats-report', |
||
419 | 'url' => $this->generateUrl('legacy_main', ['name' => 'mySpace/company_reports.php']), |
||
420 | 'label' => $this->translator->trans('Reports'), |
||
421 | ]; |
||
422 | $items[] = [ |
||
423 | 'class' => 'item-teacher-time-report', |
||
424 | 'url' => $this->generateUrl('legacy_main', ['name' => 'admin/teacher_time_report.php']), |
||
425 | 'label' => $this->translator->trans('Teachers time report'), |
||
426 | ]; |
||
427 | |||
428 | if (api_get_configuration_value('chamilo_cms')) { |
||
429 | $items[] = [ |
||
430 | 'class' => 'item-cms', |
||
431 | 'url' => api_get_path(WEB_PATH).'web/app_dev.php/administration/dashboard', |
||
432 | 'label' => $this->translator->trans('CMS'), |
||
433 | ]; |
||
434 | } |
||
435 | |||
436 | /* Event settings */ |
||
437 | |||
438 | $items[] = [ |
||
439 | 'class' => 'item-field', |
||
440 | 'url' => $this->generateUrl('legacy_main', ['name' => 'admin/extra_field_list.php']), |
||
441 | 'label' => $this->translator->trans('Extra fields'), |
||
442 | ]; |
||
443 | |||
444 | if (api_is_global_platform_admin()) { |
||
445 | $items[] = [ |
||
446 | 'class' => 'item-access-url', |
||
447 | 'url' => $this->generateUrl('legacy_main', ['name' => 'admin/access_urls.php']), |
||
448 | 'label' => $this->translator->trans('Configure multiple access URL'), |
||
449 | ]; |
||
450 | } |
||
451 | |||
452 | if ('true' === api_get_plugin_setting('dictionary', 'enable_plugin_dictionary')) { |
||
453 | $items[] = [ |
||
454 | 'class' => 'item-dictionary', |
||
455 | 'url' => api_get_path(WEB_PLUGIN_PATH).'dictionary/terms.php', |
||
456 | 'label' => $this->translator->trans('Dictionary'), |
||
457 | ]; |
||
458 | } |
||
459 | |||
460 | if ('true' === $this->settingsManager->getSetting('registration.allow_terms_conditions')) { |
||
461 | $items[] = [ |
||
462 | 'class' => 'item-terms-and-conditions', |
||
463 | 'route' => ['name' => 'TermsConditions'], |
||
464 | 'label' => $this->translator->trans('Terms and Conditions'), |
||
465 | ]; |
||
466 | } |
||
467 | |||
468 | $items[] = [ |
||
469 | 'class' => 'item-mail-template', |
||
470 | 'url' => $this->generateUrl('legacy_main', ['name' => 'mail_template/list.php']), |
||
471 | 'label' => $this->translator->trans('Mail templates'), |
||
472 | ]; |
||
473 | |||
474 | if ('true' === api_get_setting('platform.notification_event')) { |
||
475 | $items[] = [ |
||
476 | 'class' => 'item-notification-list', |
||
477 | 'url' => $this->generateUrl('legacy_main', ['name' => 'notification_event/list.php']), |
||
478 | 'label' => $this->translator->trans('Notifications'), |
||
479 | ]; |
||
480 | } |
||
481 | |||
482 | $allowJustification = 'true' === api_get_plugin_setting('justification', 'tool_enable'); |
||
483 | |||
484 | if ($allowJustification) { |
||
485 | $items[] = [ |
||
486 | 'class' => 'item-justification-list', |
||
487 | 'url' => api_get_path(WEB_PLUGIN_PATH).'justification/list.php', |
||
488 | 'label' => $this->translator->trans('Justification'), |
||
489 | ]; |
||
490 | } |
||
491 | |||
492 | $items[] = [ |
||
493 | 'class' => 'item-lti-admin', |
||
494 | 'url' => $this->generateUrl('chamilo_lti_admin'), |
||
495 | 'label' => $this->translator->trans('External tools (LTI)'), |
||
496 | ]; |
||
497 | |||
498 | $items[] = [ |
||
499 | 'class' => 'item-contact-category-admin', |
||
500 | 'url' => $this->generateUrl('chamilo_contact_category_index'), |
||
501 | 'label' => $this->translator->trans('Contact form categories'), |
||
502 | ]; |
||
503 | |||
504 | $items[] = [ |
||
505 | 'class' => 'item-system-template-admin', |
||
506 | 'url' => $this->generateUrl('legacy_main', ['name' => 'admin/settings.php', 'category' => 'Templates']), |
||
507 | 'label' => $this->translator->trans('System templates'), |
||
508 | ]; |
||
509 | |||
510 | return $items; |
||
511 | } |
||
512 | |||
513 | private function getItemsSettings(): array |
||
514 | { |
||
515 | $items = []; |
||
516 | $items[] = [ |
||
517 | 'class' => 'item-clean-cache', |
||
518 | 'url' => $this->generateUrl('legacy_main', ['name' => 'admin/archive_cleanup.php']), |
||
519 | 'label' => $this->translator->trans('Cleanup of cache and temporary files'), |
||
520 | ]; |
||
521 | |||
522 | $items[] = [ |
||
523 | 'class' => 'item-special-export', |
||
524 | 'url' => $this->generateUrl('legacy_main', ['name' => 'admin/special_exports.php']), |
||
525 | 'label' => $this->translator->trans('Special exports'), |
||
526 | ]; |
||
527 | /*$items[] = [ |
||
528 | 'url' => $this->>$this->generateUrl('legacy_main), ['name' => 'admin/periodic_export.php', |
||
529 | 'label' => $this->translator->$this->trans('Periodic export'), |
||
530 | ];*/ |
||
531 | $items[] = [ |
||
532 | 'class' => 'item-system-status', |
||
533 | 'url' => $this->generateUrl('legacy_main', ['name' => 'admin/system_status.php']), |
||
534 | 'label' => $this->translator->trans('System status'), |
||
535 | ]; |
||
536 | if (is_dir(api_get_path(SYS_TEST_PATH).'datafiller/')) { |
||
537 | $items[] = [ |
||
538 | 'class' => 'item-data-filler', |
||
539 | 'url' => $this->generateUrl('legacy_main', ['name' => 'admin/filler.php']), |
||
540 | 'label' => $this->translator->trans('Data filler'), |
||
541 | ]; |
||
542 | } |
||
543 | |||
544 | if (is_dir(api_get_path(SYS_TEST_PATH))) { |
||
545 | $items[] = [ |
||
546 | 'class' => 'item-email-tester', |
||
547 | 'url' => $this->generateUrl('legacy_main', ['name' => 'admin/email_tester.php']), |
||
548 | 'label' => $this->translator->trans('E-mail tester'), |
||
549 | ]; |
||
550 | } |
||
551 | |||
552 | $items[] = [ |
||
553 | 'class' => 'item-ticket-system', |
||
554 | 'url' => $this->generateUrl('legacy_main', ['name' => 'ticket/tickets.php']), |
||
555 | 'label' => $this->translator->trans('Tickets'), |
||
556 | ]; |
||
557 | |||
558 | $items[] = [ |
||
559 | 'url' => $this->generateUrl('legacy_main', ['name' => 'session/cron_status.php']), |
||
560 | 'label' => $this->translator->trans('Update session status'), |
||
561 | ]; |
||
562 | |||
563 | $items[] = [ |
||
564 | 'class' => 'item-colors', |
||
565 | 'route' => ['name' => 'AdminConfigurationColors'], |
||
566 | 'label' => $this->translator->trans('Colors'), |
||
567 | ]; |
||
568 | |||
569 | return $items; |
||
570 | } |
||
571 | |||
572 | private function getItemsSkills(): array |
||
573 | { |
||
574 | $items = []; |
||
575 | $items[] = [ |
||
576 | 'class' => 'item-skill-wheel', |
||
577 | 'url' => $this->generateUrl('legacy_main', ['name' => 'skills/skills_wheel.php']), |
||
578 | 'label' => $this->translator->trans('Skills wheel'), |
||
579 | ]; |
||
580 | $items[] = [ |
||
581 | 'class' => 'item-skill-import', |
||
582 | 'url' => $this->generateUrl('legacy_main', ['name' => 'skills/skills_import.php']), |
||
583 | 'label' => $this->translator->trans('Skills import'), |
||
584 | ]; |
||
585 | $items[] = [ |
||
586 | 'class' => 'item-skill-list', |
||
587 | 'url' => $this->generateUrl('legacy_main', ['name' => 'skills/skill_list.php']), |
||
588 | 'label' => $this->translator->trans('Manage skills'), |
||
589 | ]; |
||
590 | $items[] = [ |
||
591 | 'class' => 'item-skill-level', |
||
592 | 'url' => $this->generateUrl('legacy_main', ['name' => 'skills/skill.php']), |
||
593 | 'label' => $this->translator->trans('Manage skills levels'), |
||
594 | ]; |
||
595 | |||
596 | $items[] = [ |
||
597 | 'class' => 'item-skill-ranking', |
||
598 | 'url' => $this->generateUrl('legacy_main', ['name' => 'social/skills_ranking.php']), |
||
599 | 'label' => $this->translator->trans('Skills ranking'), |
||
600 | ]; |
||
601 | $items[] = [ |
||
602 | 'class' => 'item-skill-gradebook', |
||
603 | 'url' => $this->generateUrl('legacy_main', ['name' => 'skills/skills_gradebook.php']), |
||
604 | 'label' => $this->translator->trans('Skills and assessments'), |
||
605 | ]; |
||
606 | |||
607 | /*$items[] = [ |
||
608 | 'url' => $this->$this->generateUrl('legacy_main', ['name' => 'admin/skill_badge.php'), |
||
609 | 'label' => $this->translator->trans('Badges'), |
||
610 | ];*/ |
||
611 | |||
612 | return $items; |
||
613 | } |
||
614 | |||
615 | private function getItemsGradebook(): array |
||
616 | { |
||
617 | $items = []; |
||
618 | $items[] = [ |
||
619 | 'class' => 'item-gradebook-list', |
||
620 | 'url' => $this->generateUrl('legacy_main', ['name' => 'gradebook_list.php']), |
||
621 | 'label' => $this->translator->trans('List'), |
||
622 | ]; |
||
623 | |||
624 | return $items; |
||
625 | } |
||
626 | |||
627 | private function getItemsPrivacy(): array |
||
628 | { |
||
629 | $items = []; |
||
630 | $items[] = [ |
||
631 | 'class' => 'item-privacy-consent', |
||
632 | 'url' => $this->generateUrl('legacy_main', ['name' => 'admin/user_list_consent.php']), |
||
633 | 'label' => $this->translator->trans('User list'), |
||
634 | ]; |
||
635 | |||
636 | return $items; |
||
637 | } |
||
638 | |||
639 | private function getItemsChamilo(): array |
||
711 | } |
||
712 | |||
713 | private function getItemsSessions(): array |
||
714 | { |
||
804 | } |
||
805 | } |
||
806 |