aboutsummaryrefslogtreecommitdiff
path: root/lib/classes/JsonApi/Routes/Courses/CoursesByUserIndex.php
blob: ae293fdadfb68f134fb4a985703866d1bda2cb63 (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
122
<?php

namespace JsonApi\Routes\Courses;

use Course;
use JsonApi\Errors\AuthorizationFailedException;
use JsonApi\Errors\BadRequestException;
use JsonApi\Errors\RecordNotFoundException;
use JsonApi\JsonApiController;
use Psr\Http\Message\ResponseInterface as Response;
use Psr\Http\Message\ServerRequestInterface as Request;
use Semester;
use User;

class CoursesByUserIndex extends JsonApiController
{
    protected $allowedIncludePaths = [
        'blubber-threads',
        'end-semester',
        'events',
        'feedback-elements',
        'file-refs',
        'folders',
        'forum-categories',
        'institute',
        'memberships',
        'news',
        'participating-institutes',
        'sem-class',
        'sem-type',
        'start-semester',
        'status-groups',
        'wiki-pages',
    ];

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

    protected $allowedFilteringParameters = ['semester'];

    /**
     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
     */
    public function __invoke(Request $request, Response $response, array $args): Response
    {
        $user = User::find($args['id']);
        if (!$user) {
            throw new RecordNotFoundException();
        }

        if (!Authority::canIndexMembershipsOfUser($this->getUser($request), $user)) {
            throw new AuthorizationFailedException();
        }

        $error = $this->validateFilters();
        if ($error) {
            throw new BadRequestException($error);
        }

        $courses = $this->findCoursesByUser(
            $user,
            $this->getSemesterFilter()
        );
        [$offset, $limit] = $this->getOffsetAndLimit();

        return $this->getPaginatedContentResponse(
            array_slice($courses, $offset, $limit),
            count($courses)
        );
    }

    private function validateFilters()
    {
        $filtering = $this->getQueryParameters()->getFilteringParameters() ?: [];

        // semester
        if (
            !empty($filtering['semester'])
            && !Semester::exists($filtering['semester'])
        ) {
            return 'Invalid "semester".';
        }
    }

    private function getSemesterFilter(): ?Semester
    {
        $filtering = $this->getQueryParameters()->getFilteringParameters();

        if (!isset($filtering['semester'])) {
            return null;
        }

        return Semester::find($filtering['semester']);
    }


    /**
     * @param User $user
     * @param Semester|null $semester
     *
     * @return Course[]
     */
    private function findCoursesByUser(User $user, ?Semester $semester): array
    {
        $courses = Course::findBySQL(
            'LEFT JOIN `semester_courses`
            ON `seminare`.`seminar_id` = `semester_courses`.`course_id`
            LEFT JOIN `semester_data` USING (`semester_id`)
            WHERE
            `seminare`.`seminar_id` IN ( :course_ids )
            ORDER BY `semester_data`.`beginn`, `seminare`.`name`',
            ['course_ids' => $user->course_memberships->pluck('seminar_id')]
        );

        if ($semester) {
            $courses = array_filter($courses, function (Course $course) use ($semester): bool {
                return $course->isInSemester($semester);
            });
        }

        return $courses;
    }
}