Builder::dataMenu() - Code Metrics - Inspection of "Fixes order of absent suggestions" - SchulIT/icc - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 748ac9...30f06f )

by Marcel
created 2023-01-19 17:01 UTC
Builder::dataMenu() D

↳ Parent: Builder
Complexity

Conditions	10
Paths	512
Size

Total Lines	88
Code Lines	51
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	20
CRAP Score	34.1338
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
eloc	51
c	1
b	0
f	0
dl	0
loc	88
rs	4.4113
ccs	20
cts	53
cp	0.3774
cc	10
nc	512
nop	1
crap	34.1338
How to fix Long Method Complexity

<?php

namespace App\Menu;

use App\Entity\User;
use App\Repository\TimetableLessonRepositoryInterface;
use App\Repository\WikiArticleRepositoryInterface;
use App\Section\SectionResolverInterface;
use App\Security\Voter\ExamVoter;
use App\Security\Voter\ListsVoter;
use App\Security\Voter\ResourceReservationVoter;
use App\Security\Voter\StudentAbsenceVoter;
use App\Security\Voter\WikiVoter;
use App\Settings\StudentAbsenceSettings;
use EasyCorp\Bundle\EasyAdminBundle\Contracts\Menu\MenuItemInterface;
use Knp\Menu\FactoryInterface;
use Knp\Menu\ItemInterface;
use LightSaml\SpBundle\Security\Http\Authenticator\SamlToken;
use SchulIT\CommonBundle\DarkMode\DarkModeManagerInterface;
use SchulIT\CommonBundle\Helper\DateHelper;
use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;
use Symfony\Contracts\Translation\TranslatorInterface;

class Builder {
    public function __construct(private FactoryInterface $factory, private AuthorizationCheckerInterface $authorizationChecker, private WikiArticleRepositoryInterface $wikiRepository, private TimetableLessonRepositoryInterface $lessonRepository, private TokenStorageInterface $tokenStorage, private DateHelper $dateHelper, private TranslatorInterface $translator, private DarkModeManagerInterface $darkModeManager, private StudentAbsenceSettings $studentAbsenceSettings, private SectionResolverInterface $sectionResolver, private string $idpProfileUrl)
    {
    }

    private function plansMenu(ItemInterface $menu): ItemInterface {
        $plans = $menu->addChild('plans.label')
            ->setExtra('menu', 'plans')
            ->setExtra('menu-container', '#submenu')
            ->setExtra('icon', 'fa fa-school');

        $plans->addChild('plans.timetable.label', [
            'route' => 'timetable'
        ])
            ->setExtra('icon', 'fa fa-clock');


        $plans->addChild('plans.substitutions.label', [
            'route' => 'substitutions'
        ])
            ->setExtra('icon', 'fas fa-random');

        $plans->addChild('plans.exams.label', [
            'route' => 'exams'
        ])
            ->setExtra('icon', 'fas fa-edit');

        $plans->addChild('plans.appointments.label', [
            'route' => 'appointments'
        ])
            ->setExtra('icon', 'far fa-calendar');

        if($this->authorizationChecker->isGranted(ResourceReservationVoter::View)) {
            $plans->addChild('resources.reservations.label', [
                'route' => 'resource_reservations'
            ])
                ->setExtra('icon', 'fas fa-laptop-house');
        }

        return $plans;
    }

    private function listsMenu(ItemInterface $menu): ItemInterface {
        $lists = $menu->addChild('lists.label')
            ->setExtra('menu', 'lists')
            ->setExtra('menu-container', '#submenu')
            ->setExtra('icon', 'fas fa-list');

        if($this->authorizationChecker->isGranted(ListsVoter::Tuitions)) {
            $lists->addChild('lists.tuitions.label', [
                'route' => 'list_tuitions'
            ])
                ->setExtra('icon', 'fas fa-chalkboard-teacher');
        }


        if($this->authorizationChecker->isGranted(ListsVoter::StudyGroups)) {
            $lists->addChild('lists.study_groups.label', [
                'route' => 'list_studygroups'
            ])
                ->setExtra('icon', 'fas fa-users');
        }

        if($this->authorizationChecker->isGranted(ListsVoter::Teachers)) {
            $lists->addChild('lists.teachers.label', [
                'route' => 'list_teachers'
            ])
                ->setExtra('icon', 'fas fa-user-tie');
        }

        if($this->authorizationChecker->isGranted(ListsVoter::Privacy)) {
            $lists->addChild('lists.privacy.label', [
                'route' => 'list_privacy'
            ])
                ->setExtra('icon', 'fas fa-user-shield');
        }

        return $lists;
    }

    private function wikiMenu(ItemInterface $menu): ItemInterface {
        $wiki = $menu->addChild('wiki.label', [
            'route' => 'wiki'
        ])
            ->setExtra('menu', 'wiki')
            ->setExtra('icon', 'fab fa-wikipedia-w')
            ->setExtra('menu-container', '#submenu');

        foreach($this->wikiRepository->findAll() as $article) {
            if($article->isOnline() && $this->authorizationChecker->isGranted(WikiVoter::View, $article)) {
                $item = $wiki->addChild(sprintf('wiki.%s', $article->getUuid()), [

                    'label' => $article->getTitle(),
                    'route' => 'show_wiki_article',
                    'routeParameters' => [
                        'uuid' => (string)$article->getUuid(),
                    ]
                ])
                    ->setExtra('icon', !empty($article->getIcon()) ? $article->getIcon() : 'far fa-file');
            }
        }

        return $wiki;
    }

    private function bookMenu(ItemInterface $menu): ItemInterface {
        $book = $menu->addChild('book.label', [
            'route' => 'book'
        ])
            ->setExtra('menu', 'book')
            ->setExtra('icon', 'fas fa-book-open')
            ->setExtra('menu-container', '#submenu');

        $book->addChild('book.label', [
            'route' => 'book'
        ])
            ->setExtra('icon', 'fas fa-book-open');

        $missing = $book->addChild('book.missing.label', [
            'route' => 'missing_book_entries'
        ])
            ->setExtra('icon', 'fas fa-times');

        if($this->tokenStorage->getToken() === null) {
            return $book;
        }

        $user = $this->tokenStorage->getToken()->getUser();
        $currentSection = $this->sectionResolver->getCurrentSection();

        if($user instanceof User && $user->getTeacher() !== null && $currentSection !== null) {
            $count = $this->lessonRepository->countMissingByTeacher($user->getTeacher(), $currentSection->getStart(), $this->dateHelper->getToday());
            $count = $this->lessonRepository->countMissingByTeacher($user->getTeacher(), /** @scrutinizer ignore-type */ $currentSection->getStart(), $this->dateHelper->getToday());
            $missing->setExtra('count', $count);
        }

        $book->addChild('book.students.label', [
            'route' => 'book_students'
        ])
            ->setExtra('icon', 'fas fa-users');

        $book->addChild('book.excuse_note.label', [
            'route' => 'excuse_notes'
        ])
            ->setExtra('icon', 'fas fa-pen-alt');

        $book->addChild('book.export.label', [
            'route' => 'book_export'
        ])
            ->setExtra('icon', 'fas fa-download');

        return $book;
    }

    public function userMenu(array $options): ItemInterface {
    public function userMenu(/** @scrutinizer ignore-unused */ array $options): ItemInterface {
        $menu = $this->factory->createItem('root')
            ->setChildrenAttributes([
                'class' => 'navbar-nav float-lg-right'
            ]);

        if($this->tokenStorage->getToken() === null) {
            return $menu;
        }

        $user = $this->tokenStorage->getToken()->getUser();

        if(!$user instanceof User) {
            return $menu;
        }

        $displayName = $user->getUsername();

        $userMenu = $menu->addChild('user', [
                'label' => $displayName
            ])
            ->setExtra('icon', 'fa fa-user')
            ->setExtra('menu', 'user')
            ->setExtra('menu-container', '#submenu')
            ->setExtra('pull-right', true);

        $userMenu->addChild('profile.overview.label', [
            'route' => 'profile'
        ])
            ->setExtra('icon', 'fas fa-user');

        $userMenu->addChild('profile.label', [
            'uri' => $this->idpProfileUrl
        ])
            ->setLinkAttribute('target', '_blank')
            ->setExtra('icon', 'fas fa-address-card');

        $label = 'dark_mode.enable';
        $icon = 'fas fa-moon';

        if($this->darkModeManager->isDarkModeEnabled()) {
            $label = 'dark_mode.disable';
            $icon = 'fas fa-sun';
        }

        $userMenu->addChild($label, [
            'route' => 'toggle_darkmode'
        ])
            ->setExtra('icon', $icon);

        $menu->addChild('label.logout', [
            'route' => 'logout',
            'label' => ''
        ])
            ->setExtra('icon', 'fas fa-sign-out-alt')
            ->setAttribute('title', $this->translator->trans('auth.logout'));

        return $menu;
    }

    public function dataMenu(array $options = []): ItemInterface {
    public function dataMenu(/** @scrutinizer ignore-unused */ array $options = []): ItemInterface {
        $root = $this->factory->createItem('root');

        if($this->authorizationChecker->isGranted('ROLE_ADMIN')) {
            $root->addChild('admin.sections.label', [
                'route' => 'admin_sections'
            ])
                ->setExtra('icon', 'fas fa-sliders-h');
        }

        if($this->authorizationChecker->isGranted('ROLE_DOCUMENTS_ADMIN')) {
            $root->addChild('admin.documents.label', [
                'route' => 'admin_documents'
            ])
                ->setExtra('icon', 'fas fa-file-alt');
        }

        if($this->authorizationChecker->isGranted('ROLE_MESSAGE_CREATOR')) {
            $root->addChild('admin.messages.label', [
                'route' => 'admin_messages'
            ])
                ->setExtra('icon', 'fas fa-envelope-open-text');
        }

        if($this->authorizationChecker->isGranted(ExamVoter::Manage)) {
            $root->addChild('admin.exams.label', [
                'route' => 'admin_exams'
            ])
                ->setExtra('icon', 'fas fa-pen');
        }

        if($this->authorizationChecker->isGranted('ROLE_APPOINTMENT_CREATOR')) {
            $root->addChild('admin.appointments.label', [
                'route' => 'admin_appointments'
            ])
                ->setExtra('icon', 'far fa-calendar');
        }

        if($this->authorizationChecker->isGranted('ROLE_WIKI_ADMIN')) {
            $root->addChild('admin.wiki.label', [
                'route' => 'admin_wiki'
            ])
                ->setExtra('icon', 'fab fa-wikipedia-w');
        }

        if($this->authorizationChecker->isGranted('ROLE_ADMIN')) {
            $root->addChild('admin.timetable.label', [
                'route' => 'admin_timetable'
            ])
                ->setExtra('icon', 'far fa-clock');

            $root->addChild('admin.resources.label', [
                'route' => 'admin_resources'
            ])
                ->setExtra('icon', 'fas fa-laptop-house');

            $root->addChild('admin.teachers.label', [
                'route' => 'admin_teachers'
            ])
                ->setExtra('icon', 'fas fa-sort-alpha-down');

            $root->addChild('admin.absence_types.label', [
                'route' => 'admin_absence_types'
            ])
                ->setExtra('icon', 'fas fa-user-times');
        }

        if($this->authorizationChecker->isGranted('ROLE_ADMIN')) {
            $root->addChild('admin.subjects.label', [
                'route' => 'admin_subjects'
            ])
                ->setExtra('icon', 'fas fa-graduation-cap');

            $root->addChild('admin.displays.label', [
                'route' => 'admin_displays'
            ])
                ->setExtra('icon', 'fas fa-tv');
        }

        if($this->authorizationChecker->isGranted('ROLE_SUPER_ADMIN')) {
            $root->addChild('admin.ea.label', [
                'uri' => '/admin/ea'
            ])
                ->setLinkAttribute('target', '_blank')
                ->setExtra('icon', 'fas fa-tools');
        }

        return $root;
    }

    public function toolsMenu(array $options = [ ]): ItemInterface {
    public function toolsMenu(/** @scrutinizer ignore-unused */ array $options = [ ]): ItemInterface {
        $root = $this->factory->createItem('root');

        if($this->authorizationChecker->isGranted('ROLE_ADMIN')) {
            $root->addChild('tools.grade_teacher_intersection.label', [
                'route' => 'grade_tuition_teachers_intersection'
            ])
                ->setExtra('icon', 'fas fa-random');
        }

        return $root;
    }

    public function adminMenu(array $options): ItemInterface {
    public function adminMenu(/** @scrutinizer ignore-unused */ array $options): ItemInterface {
        $root = $this->factory->createItem('root')
            ->setChildrenAttributes([
                'class' => 'navbar-nav float-lg-right'
            ]);

        $menu = $root->addChild('admin', [
            'label' => ''
        ])
            ->setExtra('icon', 'fa fa-cogs')
            ->setAttribute('title', $this->translator->trans('admin.label'))
            ->setExtra('menu', 'admin')
            ->setExtra('menu-container', '#submenu')
            ->setExtra('pull-right', true);

        $settingsMenu = $this->settingsMenu();

        if($settingsMenu->offsetExists('settings') && count($settingsMenu['settings']->getChildren()) > 0) {
            $menu->addChild('admin.settings.label', [
                'route' => 'admin_settings'
            ])
                ->setExtra('icon', 'fas fa-wrench');
        }

        $dataMenu = $this->dataMenu();

        if($dataMenu->count() > 0) {
            $firstKey = array_key_first($dataMenu->getChildren());
            $first = $dataMenu->getChildren()[$firstKey];

            $menu->addChild('admin.label', [
                'uri' => $first->getUri()
            ])
                ->setExtra('icon', 'fas fa-school');
        }

        $toolsMenu = $this->toolsMenu();
        if($toolsMenu->count() > 0) {
            $firstKey = array_key_first($toolsMenu->getChildren());
            $first = $toolsMenu->getChildren()[$firstKey];

            $menu->addChild('tools.label', [
                'uri' => $first->getUri()
            ])
                ->setExtra('icon', 'fas fa-toolbox');
        }

        if($this->authorizationChecker->isGranted('ROLE_ADMIN')) {
            $menu->addChild('api.doc', [
                'uri' => '/docs/api/import'
            ])
                ->setExtra('icon', 'fas fa-code');
        }

        return $root;
    }

    public function systemMenu(array $options): ItemInterface {
    public function systemMenu(/** @scrutinizer ignore-unused */ array $options): ItemInterface {
        $root = $this->factory->createItem('root')
            ->setChildrenAttributes([
                'class' => 'navbar-nav float-lg-right'
            ]);

        $menu = $root->addChild('system', [
            'label' => ''
        ])
            ->setExtra('icon', 'fa fa-tools')
            ->setExtra('menu', 'system')
            ->setExtra('menu-container', '#submenu')
            ->setExtra('pull-right', true)
            ->setAttribute('title', $this->translator->trans('system.label'));

        if($this->authorizationChecker->isGranted('ROLE_SUPER_ADMIN')) {
            $menu->addChild('cron.label', [
                'route' => 'admin_cronjobs'
            ])
                ->setExtra('icon', 'fas fa-history');

            $menu->addChild('logs.label', [
                'route' => 'admin_logs'
            ])
                ->setExtra('icon', 'fas fa-clipboard-list');

            $menu->addChild('messenger.label', [
                'route' => 'admin_messenger'
            ])
                ->setExtra('icon', 'fas fa-envelope-open-text');
            
            $menu->addChild('audit.label', [
                'uri' => '/admin/audit'
            ])
                ->setLinkAttribute('target', '_blank')
                ->setExtra('icon', 'far fa-eye');
        }

        return $root;
    }

    public function importMenu(array $options = [ ]): ItemInterface {
    public function importMenu(/** @scrutinizer ignore-unused */ array $options = [ ]): ItemInterface {
        $root = $this->factory->createItem('root')
            ->setChildrenAttributes([
                'class' => 'navbar-nav float-lg-right'
            ]);

        $menu = $root->addChild('import', [
            'label' => ''
        ])
            ->setExtra('icon', 'fas fa-upload')
            ->setExtra('menu', 'import')
            ->setExtra('menu-container', '#submenu')
            ->setExtra('pull-right', true)
            ->setAttribute('title', $this->translator->trans('import.label'));

        if($this->authorizationChecker->isGranted('ROLE_IMPORTER')) {
            $menu->addChild('import.settings.label', [
                'route' => 'import_untis_settings'
            ])
                ->setExtra('icon', 'fas fa-cogs');

            $menu->addChild('import.substitutions.gpu.label', [
                'route' => 'import_untis_substitutions_gpu'
            ])
                ->setExtra('icon', 'fas fa-random');

            $menu->addChild('import.substitutions.html.label', [
                'route' => 'import_untis_substitutions_html'
            ])
                ->setExtra('icon', 'fas fa-random');

            $menu->addChild('import.exams.label', [
                'route' => 'import_untis_exams'
            ])
                ->setExtra('icon', 'fas fa-edit');

            $menu->addChild('import.supervisions.label', [
                'route' => 'import_untis_supervisions'
            ])
                ->setExtra('icon', 'fas fa-eye');

            $menu->addChild('import.rooms.label', [
                'route' => 'import_untis_rooms'
            ])
                ->setExtra('icon', 'fas fa-door-open');

            $menu->addChild('import.timetable.html.label', [
                'route' => 'import_untis_timetable_html'
            ])
                ->setExtra('icon', 'far fa-clock');
        }

        return $root;
    }

    public function settingsMenu(array $options = [ ]): ItemInterface {
    public function settingsMenu(/** @scrutinizer ignore-unused */ array $options = [ ]): ItemInterface {
        $root = $this->factory->createItem('root')
            ->setChildrenAttributes([
                'class' => 'navbar-nav float-lg-right'
            ]);

        $menu = $root->addChild('settings', [
            'label' => ''
        ])
            ->setExtra('icon', 'fa fa-wrench')
            ->setExtra('menu', 'settings')
            ->setExtra('menu-container', '#submenu')
            ->setExtra('pull-right', true)
            ->setAttribute('title', $this->translator->trans('admin.settings.label'));

        if($this->authorizationChecker->isGranted('ROLE_ADMIN')) {
            $menu->addChild('admin.settings.general.label', [
                'route' => 'admin_settings_general'
            ]);

            $menu->addChild('admin.settings.dashboard.label', [
                'route' => 'admin_settings_dashboard'
            ]);

            $menu->addChild('admin.settings.notifications.label', [
                'route' => 'admin_settings_notifications'
            ]);

            $menu->addChild('admin.settings.timetable.label', [
                'route' => 'admin_settings_timetable'
            ]);

            $menu->addChild('admin.settings.exams.label', [
                'route' => 'admin_settings_exams'
            ]);

            $menu->addChild('admin.settings.substitutions.label', [
                'route' => 'admin_settings_substitutions'
            ]);

            $menu->addChild('admin.settings.appointments.label', [
                'route' => 'admin_settings_appointments'
            ]);

            $menu->addChild('admin.settings.student_absences.label', [
                'route' => 'admin_settings_absences'
            ]);

            $menu->addChild('admin.settings.book.label', [
                'route' => 'admin_settings_book'
            ]);

            $menu->addChild('admin.settings.import.label', [
                'route' => 'admin_settings_import'
            ]);
        }

        return $root;
    }

    public function mainMenu(array $options) {
    public function mainMenu(/** @scrutinizer ignore-unused */ array $options) {
        $menu = $this->factory->createItem('root')
            ->setChildrenAttribute('class', 'navbar-nav mr-auto');

        $menu->addChild('dashboard.label', [
            'route' => 'dashboard'
        ])
            ->setExtra('icon', 'fa fa-home');

        $menu->addChild('messages.overview.label', [
            'route' => 'messages'
        ])
            ->setExtra('icon', 'fas fa-envelope-open-text');

        $plansMenu = $this->plansMenu($menu);
        $this->setFirstChildAsUri($plansMenu);
        $listsMenu = $this->listsMenu($menu);
        $this->setFirstChildAsUri($listsMenu);


        $menu->addChild('documents.label', [
            'route' => 'documents'
        ])
            ->setExtra('icon', 'fas fa-file-alt');

        $this->wikiMenu($menu);

        if($this->studentAbsenceSettings->isEnabled() === true) {
            if($this->authorizationChecker->isGranted('ROLE_SICK_NOTE_VIEWER')
            || $this->authorizationChecker->isGranted('ROLE_SICK_NOTE_CREATOR')
            || $this->authorizationChecker->isGranted(StudentAbsenceVoter::New)) {
                $menu->addChild('student_absences.label', [
                    'route' => 'absences'
                ])
                    ->setExtra('icon', 'fas fa-user-times');
            }
        }

        if($this->authorizationChecker->isGranted('ROLE_BOOK_VIEWER')) {
            $this->bookMenu($menu);
        }

        return $menu;
    }

    public function servicesMenu(): ItemInterface {
        $root = $this->factory->createItem('root')
            ->setChildrenAttributes([
                'class' => 'navbar-nav float-lg-right'
            ]);

        $token = $this->tokenStorage->getToken();

        if($token instanceof SamlToken) {
            $menu = $root->addChild('services', [
                'label' => ''
            ])
                ->setExtra('icon', 'fa fa-th')
                ->setExtra('menu', 'services')
                ->setExtra('pull-right', true)
                ->setAttribute('title', $this->translator->trans('services.label'));

            foreach($token->getAttribute('services') as $service) {
                $item = $menu->addChild($service->name, [
                    'uri' => $service->url
                ])
                    ->setAttribute('title', $service->description)
                    ->setLinkAttribute('target', '_blank');

                if(isset($service->icon) && !empty($service->icon)) {
                    $item->setExtra('icon', $service->icon);
                }
            }
        }

        return $root;
    }

    private function setFirstChildAsUri(ItemInterface $root): ItemInterface {
        if(count($root->getChildren()) === 0) {
            return $root;
        }

        $firstKey = array_key_first($root->getChildren());
        $firstItem = $root->getChildren()[$firstKey];

        $root->setUri($firstItem->getUri());

        return $root;
    }
}

SchulIT / icc

Push — master ( 748ac9...30f06f )

Builder::dataMenu() D

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like
