aboutsummaryrefslogtreecommitdiff
path: root/lib/classes/JsonApi/Routes/Mvv/CoursesOfStudyIndex.php
blob: 2040153ec01a85d6c600d3ce0e1f01611bc1af9b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
<?php

namespace JsonApi\Routes\Mvv;

use JsonApi\Schemas\CourseOfStudy;
use Psr\Http\Message\ServerRequestInterface as Request;
use Psr\Http\Message\ResponseInterface as Response;
use JsonApi\Errors\AuthorizationFailedException;
use JsonApi\Errors\BadRequestException;
use JsonApi\JsonApiController;

class CoursesOfStudyIndex extends JsonApiController
{
    protected $allowedFilteringParameters = ['q', 'institute', 'semester', 'degree', 'category', 'type'];

    protected $allowedIncludePaths = [
        CourseOfStudy::REL_SECTIONS,
        CourseOfStudy::REL_INSTITUTE,
        CourseOfStudy::REL_COMPONENTS,
        CourseOfStudy::REL_DEGREE,
        CourseOfStudy::REL_END_SEMESTER,
        CourseOfStudy::REL_START_SEMESTER,
    ];

    protected $allowedPagingParameters = ['offset', 'limit'];

    /**
     * @SuppressWarnings(PHPMD.UnusedFormalParameters)
     */
    public function __invoke(Request $request, Response $response, $args)
    {
        if (!Authority::canIndexCoursesOfStudy($user = $this->getUser($request))) {
            throw new AuthorizationFailedException();
        }

        $filtering = $this->getQueryParameters()->getFilteringParameters() ?: [];
        $error = $this->validateFilters($filtering);
        if ($error) {
            throw new BadRequestException($error);
        }

        [$offset, $limit] = $this->getOffsetAndLimit();
        $courses_of_study = $this->getCoursesOfStudy($filtering, $offset, $limit);

        return $this->getPaginatedContentResponse(
            $courses_of_study,
            count($courses_of_study)
        );
    }

    private function validateFilters($filtering)
    {
        // keyword aka q
        if (isset($filtering['q']) && mb_strlen($filtering['q']) < 3) {
            return 'Search term too short.';
        }

        // institute
        if (isset($filtering['institute']) && !\Institute::exists($filtering['institute'])) {
            return 'Filter `institute` must be a valid id.';
        }

        // degree
        if (isset($filtering['degree']) && !\Abschluss::exists($filtering['degree'])) {
            return 'Filter `degree` must be a valid id.';
        }

        // degree category
        if (isset($filtering['category']) && !\AbschlussKategorie::find($filtering['category'])) {
            return 'Filter `category` must be a valid id';
        }

        // semester
        if (isset($filtering['semester']) && !\Semester::exists($filtering['semester'])) {
            return 'Filter `semester` must be a valid id.';
        }
    }

    private function getCoursesOfStudy($filtering, $offset, $limit): array
    {
        $join = '';
        $where = ' 1 ';
        $filtering['offset'] = $offset;
        $filtering['limit'] = $limit;
        if (isset($filtering['institute'])) {
            $where .= ' AND `institut_id` = :institute ';
        }
        if (isset($filtering['type'])) {
            $where .= ' AND `typ` = :type ';
        }
        if (isset($filtering['degree'])) {
            $where .= ' AND `mvv_studiengang`.`abschluss_id` = :degree ';
        }
        if (isset($filtering['category'])) {
            $join .= 'LEFT JOIN `mvv_abschluss_zuord` USING(`abschluss_id`) ';
            $where .= ' AND `mvv_abschluss_zuord`.`kategorie_id` = :category';
        }
        if (isset($filtering['semester'])) {
            $semester = \Semester::find($filtering['semester']);
            unset($filtering['semester']);
            $filtering['semester_start'] = $semester->beginn;
            $filtering['semester_end'] = $semester->ende;
            $join .= 'LEFT JOIN `semester_data` AS `start_sem`
                        ON (`mvv_studiengang`.`start` = `start_sem`.`semester_id`)
                    LEFT JOIN `semester_data` AS `end_sem`
                        ON (`mvv_studiengang`.`end` = `end_sem`.`semester_id`) ';
            $where .= ' AND (`start_sem`.`beginn` <= :semester_end OR ISNULL(`start_sem`.`beginn`))
                        AND (`end_sem`.`ende` >= :semester_start OR ISNULL(`end_sem`.`ende`))';
        }
        if (isset($filtering['q'])) {
            $where .= " AND (`mvv_studiengang`.`name` LIKE CONCAT('%', :q, '%') OR `mvv_studiengang`.`name_kurz` LIKE CONCAT('%', :q, '%')) ";
        }
        $where .= ' ORDER BY `mvv_studiengang`.`name` ASC
                    LIMIT :limit OFFSET :offset';
        return \Studiengang::findBySQL(
            ($join ? $join . ' WHERE ' : '') . $where,
            $filtering
        );
    }

}