aboutsummaryrefslogtreecommitdiff
path: root/lib/classes/JsonApi/Routes/Files/Rel/TermsOfFileRef.php
blob: b71f322ab441363cc0e808a5517066c3f2adf43b (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
<?php

namespace JsonApi\Routes\Files\Rel;

use Psr\Http\Message\ServerRequestInterface as Request;
use JsonApi\Errors\BadRequestException;
use JsonApi\Errors\RecordNotFoundException;
use JsonApi\Routes\Files\Authority;
use JsonApi\Routes\RelationshipsController;

class TermsOfFileRef extends RelationshipsController
{
    /**
     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
     */
    protected function fetchRelationship(Request $request, $related)
    {
        return $this->getIdentifiersResponse($related->content_terms_of_use_id ? $related->terms_of_use : null);
    }

    protected function replaceRelationship(Request $request, $related)
    {
        $json = $this->validate($request);

        $data = self::arrayGet($json, 'data');

        if ($data === null) {
            $termsId = null;
        } else {
            $termsId = self::arrayGet($json, 'data.id');
            if (!\ContentTermsOfUse::find($termsId)) {
                throw new BadRequestException('Invalid terms of use specified.');
            }
        }

        $related->content_terms_of_use_id = $termsId;
        $related->store();

        return $this->getIdentifiersResponse($related->content_terms_of_use_id ? $related->terms_of_use : null);
    }

    protected function findRelated(array $args)
    {
        if (!$related = \FileRef::find($args['id'])) {
            throw new RecordNotFoundException();
        }

        return $related;
    }

    protected function authorize(Request $request, $resource)
    {
        switch ($request->getMethod()) {
            case 'GET':
                return Authority::canShowFileRef($this->getUser($request), $resource);

            case 'PATCH':
                return Authority::canUpdateFileRef($this->getUser($request), $resource);

            default:
                return false;
        }
    }

    /**
     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
     */
    protected function getRelationshipSelfLink($resource, $schema, $userData)
    {
        return $schema->getRelationshipSelfLink($resource, \JsonApi\Schemas\FileRef::REL_TERMS);
    }

    /**
     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
     */
    protected function getRelationshipRelatedLink($resource, $schema, $userData)
    {
        return null;
    }

    protected function validateResourceDocument($json, $data)
    {
        if (!self::arrayHas($json, 'data')) {
            return 'Missing `data` member at file´s top level.';
        }

        $data = self::arrayGet($json, 'data');

        if ($data === null) {
            return;
        }

        if (count($data) !== 2 || !isset($data['id']) || !isset($data['type'])) {
            return 'File´s ´data´ must be null or a resource identifier.';
        }

        if ($data['type'] !== \JsonApi\Schemas\ContentTermsOfUse::TYPE) {
            return 'Wrong `data.type`.';
        }
    }
}