App\Controller\TimetableController

Complexity

Total Complexity

51

Size/Duplication

Total Lines	307
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	3
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getWeeksToDisplay()	0	15	4
A	ics()	0	7	1
A	getMessageScope()	0	2	1
C	supervisions()	0	88	11
A	__construct()	0	4	1
A	export()	0	19	3
F	index()	0	142	30

<?php

namespace App\Controller;

use App\Security\Voter\TimetableVoter;
use Symfony\Component\HttpFoundation\Response;
use App\Date\WeekOfYear;
use App\Entity\IcsAccessToken;
use App\Entity\IcsAccessTokenType;
use App\Entity\MessageScope;
use App\Entity\StudyGroupMembership;
use App\Entity\Subject;
use App\Entity\TimetableLesson;
use App\Entity\TimetableSupervision;
use App\Entity\User;
use App\Export\TimetableIcsExporter;
use App\Form\IcsAccessTokenType as DeviceTokenTypeForm;
use App\Grouping\Grouper;
use App\Message\DismissedMessagesHelper;
use App\Repository\ImportDateTypeRepositoryInterface;
use App\Repository\MessageRepositoryInterface;
use App\Repository\SubjectRepositoryInterface;
use App\Repository\TimetableLessonRepositoryInterface;
use App\Repository\TimetableSupervisionRepositoryInterface;
use App\Repository\UserRepositoryInterface;
use App\Security\IcsAccessToken\IcsAccessTokenManager;
use App\Settings\TimetableSettings;
use App\Sorting\Sorter;
use App\Timetable\TimetableFilter;
use App\Timetable\TimetableHelper;
use App\Utils\ArrayUtils;
use App\View\Filter\GradeFilter;
use App\View\Filter\RoomFilter;
use App\View\Filter\SectionFilter;
use App\View\Filter\StudentFilter;
use App\View\Filter\SubjectsFilter;
use App\View\Filter\TeachersFilter;
use DateTime;
use SchulIT\CommonBundle\Helper\DateHelper;
use SchulIT\CommonBundle\Utils\RefererHelper;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Routing\Annotation\Route;

#[Route(path: '/timetable')]
class TimetableController extends AbstractControllerWithMessages {

    private const OnlyOneWeek = 'timetable.only_one_week';

    use RequestTrait;
    use CalendarWeeksTrait;

The trait App\Controller\CalendarWeeksTrait requires the property $query which is not provided by App\Controller\TimetableController.

    public function __construct(MessageRepositoryInterface $messageRepository, DismissedMessagesHelper $dismissedMessagesHelper,
                                DateHelper $dateHelper, private TimetableHelper $timetableHelper, private TimetableSettings $timetableSettings,
                                RefererHelper $refererHelper) {
        parent::__construct($messageRepository, $dismissedMessagesHelper, $dateHelper, $refererHelper);
    }

    #[Route(path: '', name: 'timetable')]
    public function index(StudentFilter $studentFilter, TeachersFilter $teachersFilter, GradeFilter $gradeFilter, RoomFilter $roomFilter, SubjectsFilter $subjectFilter,
                          TimetableLessonRepositoryInterface $lessonRepository, TimetableSupervisionRepositoryInterface $supervisionRepository, TimetableFilter $timetableFilter, ImportDateTypeRepositoryInterface $importDateTypeRepository,
                          SubjectRepositoryInterface $subjectRepository, SectionFilter $sectionFilter, Request $request, UserRepositoryInterface $userRepository): Response {
        /** @var User $user */
        $user = $this->getUser();

        if($request->isMethod('POST')) {
            $onlyOneWeek = $request->request->getBoolean('only_one_week');
            $user->setData(self::OnlyOneWeek, $onlyOneWeek);

            $userRepository->persist($user);
            return $this->redirectToRoute('timetable', $request->query->all());
        }

        $sectionFilterView = $sectionFilter->handle($request->query->get('section', null));
        $gradeFilterView = $gradeFilter->handle($request->query->get('grade', null), $sectionFilterView->getCurrentSection(), $user);
        $roomFilterView = $roomFilter->handle($request->query->get('room', null), $user);
        $subjectFilterView = $subjectFilter->handle($this->getArrayOrNull($request->query->all('subjects')), $user);
        $studentFilterView = $studentFilter->handle($request->query->get('student', null), $sectionFilterView->getCurrentSection(), $user, $gradeFilterView->getCurrentGrade() === null && $roomFilterView->getCurrentRoom() === null && (is_countable($subjectFilterView->getCurrentSubjects()) ? count($subjectFilterView->getCurrentSubjects()) : 0) === 0);
        $teachersFilterView = $teachersFilter->handle($this->getArrayOrNull($request->query->all('teachers')), $sectionFilterView->getCurrentSection(), $user, $studentFilterView->getCurrentStudent() === null && $gradeFilterView->getCurrentGrade() === null && $roomFilterView->getCurrentRoom() === null && (is_countable($subjectFilterView->getCurrentSubjects()) ? count($subjectFilterView->getCurrentSubjects()) : 0) === 0);

        $selectedDate = $this->resolveSelectedDate($request, $sectionFilterView->getCurrentSection(), $this->dateHelper);

        $start = max(
            $selectedDate,
            $startDate = $this->timetableSettings->getStartDate($user->getUserType())
        );
        $end = min(
            (clone $start)->modify('+13 days'),
            $endDate = $this->timetableSettings->getEndDate($user->getUserType())
        );

        $lessons = [ ];
        $supervisions = [ ];
        $membershipsTypes = [ ];

        if($start <= $end) {
            if ($studentFilterView->getCurrentStudent() !== null) {
                $lessons = $lessonRepository->findAllByStudent($start, $end, $studentFilterView->getCurrentStudent());
                $lessons = $timetableFilter->filterStudentLessons($lessons);

                $gradeIdsWithMembershipTypes = $this->timetableSettings->getGradeIdsWithMembershipTypes();

                /** @var StudyGroupMembership $membership */
                foreach($studentFilterView->getCurrentStudent()->getStudyGroupMemberships() as $membership) {
                    foreach($membership->getStudyGroup()->getGrades() as $grade) {
                        if (in_array($grade->getId(), $gradeIdsWithMembershipTypes)) {
                            $membershipsTypes[$membership->getStudyGroup()->getId()] = $membership->getType();
                        }
                    }
                }
            } else if (count($teachersFilterView->getCurrentTeachers()) > 0) {
                $lessons = [ ];
                $supervisions = [ ];

                foreach($teachersFilterView->getCurrentTeachers() as $teacher) {
                    $lessons = array_merge($lessons, $timetableFilter->filterTeacherLessons($lessonRepository->findAllByTeacher($start, $end, $teacher)));
                    $supervisions = array_merge($supervisions, $supervisionRepository->findAllByTeacher($start, $end, $teacher));
                }
            } else if ($gradeFilterView->getCurrentGrade() !== null) {
                $lessons = $lessonRepository->findAllByGrade($start, $end, $gradeFilterView->getCurrentGrade());
                $lessons = $timetableFilter->filterGradeLessons($lessons);
            } else if ($roomFilterView->getCurrentRoom() !== null) {
                $lessons = $lessonRepository->findAllByRoom($start, $end, $roomFilterView->getCurrentRoom());
                $lessons = $timetableFilter->filterRoomLessons($lessons);
            } else if ((is_countable($subjectFilterView->getSubjects()) ? count($subjectFilterView->getSubjects()) : 0) > 0) {
                $lessons = $lessonRepository->findAllBySubjects($start, $end, $subjectFilterView->getCurrentSubjects());
                $lessons = $timetableFilter->filterSubjectsLessons($lessons);
            }
        }

        if((is_countable($lessons) ? count($lessons) : 0) === 0 && count($supervisions) === 0) {
            $timetable = null;
        } else {
            $weeks = $this->getWeeksToDisplay($start, $end, $user->getData(self::OnlyOneWeek, false));
            $timetable = $this->timetableHelper->makeTimetable($weeks, $lessons, $supervisions);
        }

        $startTimes = [ ];
        $endTimes = [ ];

        for($lesson = 1; $lesson <= $this->timetableSettings->getMaxLessons(); $lesson++) {
            $startTimes[$lesson] = $this->timetableSettings->getStart($lesson);
            $endTimes[$lesson] = $this->timetableSettings->getEnd($lesson);
        }

        $template = 'timetable/index.html.twig';

        if($request->query->getBoolean('print', false) === true) {
            $template = 'timetable/index_print.html.twig';

            if($timetable === null) {
                $query = $request->query->all();
                unset($query['print']);
                $this->addFlash('info', 'plans.timetable.print.empty');
                return $this->redirectToRoute('timetable', $query);
            }
        }

        $supervisionLabels = [ ];
        for($i = 1; $i <= $this->timetableSettings->getMaxLessons(); $i++) {
            $supervisionLabels[$i] = $this->timetableSettings->getDescriptionBeforeLesson($i);
        }

        $subjects = ArrayUtils::createArrayWithKeys(
            $subjectRepository->findAll(),
            fn(Subject $subject) => $subject->getAbbreviation()
        );

        $weekStarts = [ ];

        if($startDate !== null && $endDate !== null && $sectionFilterView->getCurrentSection() !== null) {
            $weekStarts = $this->listCalendarWeeks(
                max($startDate, $sectionFilterView->getCurrentSection()->getStart()),
                min($endDate, $sectionFilterView->getCurrentSection()->getEnd())
            );
        }

        return $this->renderWithMessages($template, [
            'compact' => count($teachersFilterView->getCurrentTeachers()) > 1,
            'timetable' => $timetable,
            'studentFilter' => $studentFilterView,
            'teachersFilter' => $teachersFilterView,
            'gradeFilter' => $gradeFilterView,
            'roomFilter'=> $roomFilterView,
            'subjectFilter' => $subjectFilterView,
            'sectionFilter' => $sectionFilterView,
            'startTimes' => $startTimes,
            'endTimes' => $endTimes,
            'gradesWithCourseNames' => $this->timetableSettings->getGradeIdsWithCourseNames(),
            'memberships' => $membershipsTypes,
            'query' => $request->query->all(),
            'supervisionLabels' => $supervisionLabels,
            'supervisionSubject' => $this->timetableSettings->getSupervisionLabel(),
            'supervisionColor' => $this->timetableSettings->getSupervisionColor(),
            'last_import_lessons' => $importDateTypeRepository->findOneByEntityClass(TimetableLesson::class),
            'last_import_supervisions' => $importDateTypeRepository->findOneByEntityClass(TimetableSupervision::class),
            'subjects' => $subjects,
            'selectedDate' => $selectedDate,
            'weekStarts' => $weekStarts,
            'onlyOneWeek' => $user->getData(self::OnlyOneWeek, false)
        ]);
    }

    /**
     * @param DateTime $start
     * @param DateTime $end
     * @param bool $onlyOneWeek
     * @return WeekOfYear[]
     */
    private function getWeeksToDisplay(DateTime $start, DateTime $end, bool $onlyOneWeek): array {
        $weeks = [
            (new WeekOfYear((int)$start->format('Y'), (int)$start->format('W'))),
            (new WeekOfYear((int)$end->format('Y'), (int)$end->format('W')))
        ];

        if($weeks[0]->getWeekNumber() === $weeks[1]->getWeekNumber() && $weeks[0]->getYear() === $weeks[1]->getYear()) {
            $weeks = [ $weeks[0] ];
        }

        if($onlyOneWeek === true) {
            $weeks = [ $weeks[0] ];
        }

        return $weeks;
    }

    #[Route(path: '/supervisions', name: 'timetable_supervisions')]
    public function supervisions(TimetableSupervisionRepositoryInterface $supervisionRepository, TimetableFilter $timetableFilter, ImportDateTypeRepositoryInterface $importDateTypeRepository,

The parameter $timetableFilter is not used and could be removed.

                                 SectionFilter $sectionFilter, Request $request, UserRepositoryInterface $userRepository) {
        $this->denyAccessUnlessGranted(TimetableVoter::Supervisions);

        /** @var User $user */
        $user = $this->getUser();

        if($request->isMethod('POST')) {
            $onlyOneWeek = $request->request->getBoolean('only_one_week');
            $user->setData(self::OnlyOneWeek, $onlyOneWeek);

            $userRepository->persist($user);
            return $this->redirectToRoute('timetable_supervisions', $request->query->all());
        }

        $sectionFilterView = $sectionFilter->handle($request->query->get('section', null));
        $selectedDate = $this->resolveSelectedDate($request, $sectionFilterView->getCurrentSection(), $this->dateHelper);

        $start = max(
            $selectedDate,
            $startDate = $this->timetableSettings->getStartDate($user->getUserType())
        );
        $end = min(
            (clone $start)->modify('+13 days'),
            $endDate = $this->timetableSettings->getEndDate($user->getUserType())
        );

        $timetable = null;

        if($start <= $end) {
            $supervisions = $supervisionRepository->findAllByRange($start, $end);
            $weeks = $this->getWeeksToDisplay($start, $end, $user->getData(self::OnlyOneWeek, false));

            if(count($supervisions) > 0) {
                $timetable = $this->timetableHelper->makeTimetable($weeks, [], $supervisions);
            }
        }

        $startTimes = [ ];
        $endTimes = [ ];

        for($lesson = 1; $lesson <= $this->timetableSettings->getMaxLessons(); $lesson++) {
            $startTimes[$lesson] = $this->timetableSettings->getStart($lesson);
            $endTimes[$lesson] = $this->timetableSettings->getEnd($lesson);
        }

        $template = 'timetable/index.html.twig';

The assignment to $template is dead and can be removed.

        if($request->query->getBoolean('print', false) === true) {
            $template = 'timetable/index_print.html.twig';

            if($timetable === null) {
                $query = $request->query->all();
                unset($query['print']);
                $this->addFlash('info', 'plans.timetable.print.empty');
                return $this->redirectToRoute('timetable', $query);
            }
        }

        $supervisionLabels = [ ];
        for($i = 1; $i <= $this->timetableSettings->getMaxLessons(); $i++) {
            $supervisionLabels[$i] = $this->timetableSettings->getDescriptionBeforeLesson($i);
        }

        $weekStarts = [ ];

        if($startDate !== null && $endDate !== null && $sectionFilterView->getCurrentSection() !== null) {
            $weekStarts = $this->listCalendarWeeks(
                max($startDate, $sectionFilterView->getCurrentSection()->getStart()),
                min($endDate, $sectionFilterView->getCurrentSection()->getEnd())
            );
        }

        return $this->renderWithMessages('timetable/supervisions.html.twig', [
            'timetable' => $timetable,
            'sectionFilter' => $sectionFilterView,
            'startTimes' => $startTimes,
            'endTimes' => $endTimes,
            'query' => $request->query->all(),
            'supervisionLabels' => $supervisionLabels,
            'supervisionSubject' => $this->timetableSettings->getSupervisionLabel(),
            'supervisionColor' => $this->timetableSettings->getSupervisionColor(),
            'last_import_lessons' => $importDateTypeRepository->findOneByEntityClass(TimetableLesson::class),
            'last_import_supervisions' => $importDateTypeRepository->findOneByEntityClass(TimetableSupervision::class),
            'selectedDate' => $selectedDate,
            'weekStarts' => $weekStarts,
            'onlyOneWeek' => $user->getData(self::OnlyOneWeek, false)
        ]);

    }

    #[Route(path: '/export', name: 'timetable_export')]
    public function export(Request $request, IcsAccessTokenManager $manager): Response {
        /** @var User $user */
        $user = $this->getUser();

        $deviceToken = (new IcsAccessToken())
            ->setType(IcsAccessTokenType::Timetable)
            ->setUser($user);

        $form = $this->createForm(DeviceTokenTypeForm::class, $deviceToken);
        $form->handleRequest($request);

        if($form->isSubmitted() && $form->isValid()) {
            $deviceToken = $manager->persistToken($deviceToken);
        }

        return $this->renderWithMessages('timetable/export.html.twig', [
            'form' => $form->createView(),
            'token' => $deviceToken
        ]);
    }

    #[Route(path: '/ics/download', name: 'timetable_ics')]
    #[Route(path: '/ics/downloads/{token}', name: 'timetable_ics_token')]
    public function ics(TimetableIcsExporter $icsExporter): Response {
        /** @var User $user */
        $user = $this->getUser();

        return $icsExporter->getIcsResponse($user);
    }

    protected function getMessageScope(): MessageScope {
        return MessageScope::Timetable;
    }
}