aboutsummaryrefslogtreecommitdiff
path: root/lib/classes/JsonApi/Schemas/Forum/Subscription.php
blob: a41e8bddebe555a87ae875995d5fa5bf435b47c6 (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
<?php

namespace JsonApi\Schemas\Forum;

use JsonApi\Schemas\SchemaProvider;
use Neomerx\JsonApi\Contracts\Schema\ContextInterface;
use Neomerx\JsonApi\Schema\Link;

class Subscription extends SchemaProvider
{
    const TYPE = 'forum-subscriptions';
    const REL_USER = 'user';
    const REL_RANGE = 'range';
    const REL_SUBJECT = 'subject';

    /**
     * @param \Forum\Subscription $resource
     */
    public function getId($resource): ?string
    {
        return $resource->id;
    }

    public function getAttributes($resource, ContextInterface $context): iterable
    {
        return [
            'notification-type' => $resource->notification_type,
            'mkdate' => date('c', $resource->mkdate),
            'chdate' => date('c', $resource->chdate)
        ];
    }

    /**
     * @param \Forum\Subscription $resource
     */
    public function getRelationships($resource, ContextInterface $context): iterable
    {
        $relationships = [];

        $relationships = $this->addUserRelationship($relationships, $resource, $this->shouldInclude($context, self::REL_USER));
        $relationships = $this->addSubjectRelationship($relationships, $resource, $this->shouldInclude($context, self::REL_SUBJECT));
        $relationships = $this->addRangeRelationship($relationships, $resource, $this->shouldInclude($context, self::REL_RANGE));

        return $relationships;
    }

    private function addUserRelationship(array $relationships, \Forum\Subscription $subscription, bool $withUser = false)
    {
        $user = $subscription->user;

        if ($withUser && $user) {
            $relationships[self::REL_USER] = [
                self::RELATIONSHIP_LINKS => [
                    Link::RELATED => $this->createLinkToResource($user)
                ],
                self::RELATIONSHIP_DATA => $user
            ];
        }

        return $relationships;
    }

    private function addSubjectRelationship(array $relationships, $subscription, bool $withSubject = false)
    {
        $subject = $subscription->subject_object;

        if ($withSubject && $subject) {
            $relationships[self::REL_SUBJECT] = [
                self::RELATIONSHIP_LINKS => [
                    Link::RELATED => $this->createLinkToResource($subject)
                ],
                self::RELATIONSHIP_DATA => $subject
            ];
        }

        return $relationships;
    }

    private function addRangeRelationship(array $relationships, $subscription, bool $withRange = false)
    {
        if ($withRange) {
            $relationships[self::REL_RANGE] = [
                self::RELATIONSHIP_LINKS => [
                    Link::RELATED => $this->createLinkToResource($subscription->range),
                ],
                self::RELATIONSHIP_DATA => $subscription->range,
            ];
        }

        return $relationships;
    }
}