aboutsummaryrefslogtreecommitdiff
path: root/lib/classes/JsonApi/Routes/Courseware/PeerReview/ReviewsIndex.php
blob: 92d77ced5473cc8c1035d64d7b1a3dfdbfeb9230 (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
<?php

namespace JsonApi\Routes\Courseware\PeerReview;

use Course;
use Courseware\PeerReview;
use JsonApi\Errors\AuthorizationFailedException;
use JsonApi\Errors\RecordNotFoundException;
use JsonApi\JsonApiController;
use JsonApi\Routes\Courseware\Authority;
use JsonApi\Schemas\Courseware\PeerReview as PeerReviewSchema;
use JsonApi\Schemas\Courseware\Task as TaskSchema;
use Psr\Http\Message\ResponseInterface as Response;
use Psr\Http\Message\ServerRequestInterface as Request;
use User;

/**
 * Displays all PeerReviews of a course.
 *
 * @SuppressWarnings(PHPMD.LongVariable)
 * @SuppressWarnings(PHPMD.StaticAccess)
 */
class ReviewsIndex extends JsonApiController
{
    protected $allowedIncludePaths = [
        PeerReviewSchema::REL_PROCESS,
        PeerReviewSchema::REL_REVIEWER,
        PeerReviewSchema::REL_SUBMITTER,
        PeerReviewSchema::REL_TASK,
        PeerReviewSchema::REL_TASK . '.' . TaskSchema::REL_STRUCTURAL_ELEMENT,
        PeerReviewSchema::REL_TASK . '.' . TaskSchema::REL_TASK_GROUP,
    ];

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

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

        $user = $this->getUser($request);
        $this->authorize($user);

        $resources = $this->findPeerReviews($course, $user);

        return $this->getPaginatedContentResponse(
            array_slice($resources, ...$this->getOffsetAndLimit()),
            count($resources)
        );
    }

    /**
     * @throws AuthorizationFailedException
     */
    private function authorize(User $user): void
    {
        if (!Authority::canIndexPeerReviews($user)) {
            throw new AuthorizationFailedException();
        }
    }

    private function findPeerReviews(Course $course, User $user): array
    {
        return array_filter(PeerReview::findByCourse($course), function ($peerReview) use ($user) {
            return Authority::canShowPeerReview($user, $peerReview);
        });
    }
}