aboutsummaryrefslogtreecommitdiff
path: root/lib/classes/JsonApi/Schemas/FeedbackElement.php
blob: 7b9e8cb372d5f388f2ed24817f4fd9e01fe6642d (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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
<?php

namespace JsonApi\Schemas;

use JsonApi\Errors\InternalServerError;
use Neomerx\JsonApi\Contracts\Schema\ContextInterface;
use Neomerx\JsonApi\Schema\Link;

class FeedbackElement extends SchemaProvider
{
    public const TYPE = 'feedback-elements';
    public const REL_AUTHOR = 'author';
    public const REL_COURSE = 'course';
    public const REL_ENTRIES = 'entries';
    public const REL_RANGE = 'range';



    public function getId($resource): ?string
    {
        return (string) $resource->id;
    }

    /**
     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
     */
    public function getAttributes($resource, ContextInterface $context): iterable
    {
        $attributes = [
            'question' => (string) $resource['question'],
            'description' => (string) $resource['description'],
            'mode' => (int) $resource['mode'],
            'results-visible' => (bool) $resource['results_visible'],
            'is-commentable' => (bool) $resource['commentable'],
            'anonymous-entries' => (bool) $resource['anonymous_entries'],
            'average-rating' => $resource->getAverageRating(),
            'has-entries' => $resource->hasEntries(),

            'mkdate' => date('c', $resource['mkdate']),
            'chdate' => date('c', $resource['chdate'])
        ];

        return $attributes;
    }

    /**
     * @inheritdoc
     */
    public function hasResourceMeta($resource): bool
    {
        return true;
    }

    /**
     * @inheritdoc
     */
    public function getResourceMeta($resource)
    {
        return $resource['mode'] === 0
            ? null
            : [
                'ratings' => [
                    'count' => \FeedbackEntry::countBySql('feedback_id = ?', [$resource->id]),
                    'mean' => (float) $resource->getMeanOfRating()
                ]
            ];
    }

    /**
     * In dieser Methode können Relationships zu anderen Objekten
     * spezifiziert werden.
     * {@inheritdoc}
     */
    public function getRelationships($resource, ContextInterface $context): iterable
    {
        $relationships = [];

        $relationships = $this->getAuthorRelationship($relationships, $resource, $this->shouldInclude($context, self::REL_AUTHOR));
        $relationships = $this->getCourseRelationship($relationships, $resource, $this->shouldInclude($context, self::REL_COURSE));
        $relationships = $this->getEntriesRelationship($relationships, $resource, $this->shouldInclude($context, self::REL_ENTRIES));
        $relationships = $this->getRangeRelationship($relationships, $resource, $this->shouldInclude($context, self::REL_RANGE));

        return $relationships;
    }

    private function getAuthorRelationship(array $relationships, \FeedbackElement $resource, bool $includeData): array
    {
        $userId = $resource['user_id'];
        $related = $includeData ? \User::find($userId) : \User::build(['id' => $userId], false);
        $relationships[self::REL_AUTHOR] = [
            self::RELATIONSHIP_LINKS => [
                Link::RELATED => $this->createLinkToResource($related)
            ],
            self::RELATIONSHIP_DATA => $related
        ];

        return $relationships;
    }

    private function getCourseRelationship(array $relationships, \FeedbackElement $resource, bool $includeData): array
    {
        if ($courseId = $resource['course_id']) {
            $related = $includeData ? \Course::find($courseId) : \Course::build(['id' => $courseId], false);
            $relationships[self::REL_COURSE] = [
                self::RELATIONSHIP_LINKS => [
                    Link::RELATED => $this->createLinkToResource($related)
                ],
                self::RELATIONSHIP_DATA => $related
            ];
        }

        return $relationships;
    }

    private function getEntriesRelationship(array $relationships, \FeedbackElement $resource, bool $includeData): array
    {
        $relationships[self::REL_ENTRIES] = [
            self::RELATIONSHIP_LINKS => [
                Link::RELATED => $this->getRelationshipRelatedLink($resource, self::REL_ENTRIES)
            ],
            self::RELATIONSHIP_DATA => $resource->entries
        ];

        return $relationships;
    }

    private function getRangeRelationship(array $relationships, \FeedbackElement $resource, bool $includeData): array
    {
        $range = $resource->getRange();
        try {
            $link = $this->createLinkToResource($range);
            $relationships[self::REL_RANGE] = [
                self::RELATIONSHIP_LINKS => [Link::RELATED => $link],
                self::RELATIONSHIP_DATA => $range
            ];
        } catch (\InvalidArgumentException $e) {
            // don't show this relation
        } catch (InternalServerError $ise) {
            // don't show this relation
        }

        return $relationships;
    }
}