aboutsummaryrefslogtreecommitdiff
path: root/lib/classes/JsonApi/Schemas/BlubberThread.php
blob: 2a7f6605587b1c9512ab7b0cd0e551a43730f169 (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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
<?php

namespace JsonApi\Schemas;

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

class BlubberThread extends SchemaProvider
{
    const TYPE = 'blubber-threads';
    const REL_AUTHOR = 'author';
    const REL_COMMENTS = 'comments';
    const REL_CONTEXT = 'context';
    const REL_MENTIONS = 'mentions';



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

    public function getAttributes($resource, ContextInterface $context): iterable
    {
        $userId = $this->currentUser->id;

        $attributes = [
            'context-type' => $resource['context_type'],
            'content' => $resource['content'],
            'content-html' => formatReady($resource['content']),

            'is-commentable' => (bool) $resource->isCommentable($userId),
            'is-readable' => (bool) $resource->isReadable($userId),
            'is-writable' => (bool) $resource->isWritable($userId),

            'is-visible-in-stream' => (bool) $resource->isVisibleInStream(),

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

        return $attributes;
    }

    /**
     * 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));

        $isPrimary = $context->getPosition()->getLevel() === 0;
        if (!$isPrimary) {
            return $relationships;
        }

        $relationships = $this->getCommentsRelationship($relationships, $resource, $this->shouldInclude($context, self::REL_COMMENTS));
        $relationships = $this->getContextRelationship($relationships, $resource, $this->shouldInclude($context, self::REL_CONTEXT));
        $relationships = $this->getMentionsRelationship($relationships, $resource, $this->shouldInclude($context, self::REL_MENTIONS));

        return $relationships;
    }

    // #### PRIVATE HELPERS ####

    private function getAuthorRelationship($relationships, $resource, $includeData)
    {
        if (!$resource['external_contact'] && $resource['user_id']) {
            $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;
    }

    // TODO #10245
    private function getMentionsRelationship(array $relationships, \BlubberThread $resource, $includeData)
    {
        if ($includeData) {
            $relatedUsers = $resource->mentions->pluck('user');
        } else {
            $relatedUsers = array_map(function ($mention) {
                return \User::build(['user_id' => $mention->user_id], false);
            }, \BlubberMention::findBySQL('thread_id = ?', [$resource->id]));
        }

        $relationships[self::REL_MENTIONS] = [
            self::RELATIONSHIP_LINKS_SELF => true,
            self::RELATIONSHIP_LINKS => [],
            self::RELATIONSHIP_DATA => $relatedUsers,
        ];

        return $relationships;
    }

    private function getCommentsRelationship(array $relationships, \BlubberThread $resource, $includeData)
    {
        $relationship = [
            self::RELATIONSHIP_LINKS => [
                Link::RELATED => $this->getRelationshipRelatedLink($resource, self::REL_COMMENTS),
            ],
        ];

        if ($includeData) {
            $relationship[self::RELATIONSHIP_DATA] = $resource->comments;
        }

        $relationships[self::REL_COMMENTS] = $relationship;

        return $relationships;
    }

    /**
     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
     */
    private function getContextRelationship(array $relationships, \BlubberThread $resource, $includeData)
    {
        $related = $data = null;

        if ('course' === $resource['context_type']) {
            if (!$course = \Course::find($resource['context_id'])) {
                throw new InternalServerError('Inconsistent data in BlubberThread.');
            }

            $related = $this->createLinkToResource($course);
            $data = $course;
        }

        if ('institute' === $resource['context_type']) {
            if (!$institute = \Institute::find($resource['context_id'])) {
                throw new InternalServerError('Inconsistent data in BlubberThread.');
            }

            $related = $this->createLinkToResource($institute);
            $data = $institute;
        }

        if ($related && $data) {
            $relationships[self::REL_CONTEXT] = [
                self::RELATIONSHIP_LINKS_SELF => true,
                self::RELATIONSHIP_LINKS => [
                    Link::RELATED => $related,
                ],
                self::RELATIONSHIP_DATA => $data,
            ];
        }

        return $relationships;
    }
}