Builder::listsMenu() - Code Metrics - Inspection of "Block adding absence messages for non-existing sec..." - SchulIT/icc - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 20f36e...862b31 )

by Marcel
created 2023-05-24 16:43 UTC
Builder::listsMenu() B

↳ Parent: Builder
Complexity

Conditions	6
Paths	32
Size

Total Lines	43
Code Lines	25
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	21
CRAP Score	6.256
Importance

Changes
Metric	Value
cc	6
eloc	25
nc	32
nop	1
dl	0
loc	43
rs	8.8977
c	0
b	0
f	0
ccs	21
cts	26
cp	0.8077
crap	6.256
<?php

namespace App\Menu;

use App\Entity\User;
use App\Repository\TimetableLessonRepositoryInterface;
use App\Repository\WikiArticleRepositoryInterface;
use App\Section\SectionResolverInterface;
use App\Security\Voter\ListsVoter;
use App\Security\Voter\ResourceReservationVoter;
use App\Security\Voter\StudentAbsenceVoter;
use App\Security\Voter\TeacherAbsenceVoter;
use App\Security\Voter\WikiVoter;
use App\Settings\StudentAbsenceSettings;
use App\Settings\TeacherAbsenceSettings;
use Knp\Menu\FactoryInterface;
use Knp\Menu\ItemInterface;
use SchulIT\CommonBundle\Helper\DateHelper;
use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;

class Builder {
    public function __construct(private readonly FactoryInterface $factory,
                                private readonly AuthorizationCheckerInterface $authorizationChecker,
                                private readonly WikiArticleRepositoryInterface $wikiRepository,
                                private readonly TimetableLessonRepositoryInterface $lessonRepository,
                                private readonly TokenStorageInterface $tokenStorage,
                                private readonly DateHelper $dateHelper,
                                private readonly SectionResolverInterface $sectionResolver)
    {
    }

    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->authorizationChecker->isGranted('ROLE_SICK_NOTE_VIEWER')
            || $this->authorizationChecker->isGranted('ROLE_SICK_NOTE_CREATOR')
            || $this->authorizationChecker->isGranted(StudentAbsenceVoter::New)
            || $this->authorizationChecker->isGranted(TeacherAbsenceVoter::NewAbsence)
            || $this->authorizationChecker->isGranted(TeacherAbsenceVoter::CanViewAny)) {
            $absenceMenu = $this->absencesMenu($menu);
            $this->setFirstChildAsUri($absenceMenu);
        }

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

        return $menu;
    }

    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');
        }

        if($this->authorizationChecker->isGranted(ListsVoter::LearningManagementSystems)) {
            $lists->addChild('lists.lms.label', [
                'route' => 'list_lms'
            ])
                ->setExtra('icon', 'fas fa-mail-bulk');
        }

        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.grades.label', [
            'route' => 'gradebook'
        ])
            ->setExtra('icon', 'fas fa-user-graduate');

        $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;
    }

    private function absencesMenu(ItemInterface $menu): ItemInterface {
        $plans = $menu->addChild('absences.label')
            ->setExtra('menu', 'absences')
            ->setExtra('menu-container', '#submenu')
            ->setExtra('icon', 'fas fa-user-times');

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

        if($this->authorizationChecker->isGranted('ROLE_ADMIN')) {
            $plans->addChild('absences.students.export.label', [
                'route' => 'export_student_absences'
            ])
                ->setExtra('icon', 'fas fa-download');
        }

        if($this->authorizationChecker->isGranted(TeacherAbsenceVoter::NewAbsence) || $this->authorizationChecker->isGranted(TeacherAbsenceVoter::CanViewAny)) {
            $plans->addChild('absences.teachers.label', [
                'route' => 'teacher_absences'
            ])
                ->setExtra('icon', 'fas fa-chalkboard-teacher');
        }

        return $plans;
    }

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

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

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

    }
}

SchulIT / icc

Push — master ( 20f36e...862b31 )

Builder::listsMenu() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
