aboutsummaryrefslogtreecommitdiff
path: root/lib/classes/JsonApi/Routes/Courseware/TasksUpdate.php
blob: dd9f648f295146f4a03c01d36899cd1fefef065f (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
<?php

namespace JsonApi\Routes\Courseware;

use Courseware\Task;
use JsonApi\Errors\AuthorizationFailedException;
use JsonApi\Errors\RecordNotFoundException;
use JsonApi\JsonApiController;
use JsonApi\Routes\TimestampTrait;
use JsonApi\Routes\ValidationTrait;
use Psr\Http\Message\ResponseInterface as Response;
use Psr\Http\Message\ServerRequestInterface as Request;

/**
 * Update one Task.
 *
 * @SuppressWarnings(PHPMD.StaticAccess)
 */
class TasksUpdate extends JsonApiController
{
    use TimestampTrait;
    use ValidationTrait;

    /**
     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
     * @param array $args
     * @return Response
     */
    public function __invoke(Request $request, Response $response, $args)
    {
        /** @var ?\Courseware\Task $resource */
        $resource = Task::find($args['id']);
        if (!$resource) {
            throw new RecordNotFoundException();
        }
        $json = $this->validate($request, $resource);
        $user = $this->getUser($request);
        if (!Authority::canUpdateTask($user, $resource)) {
            throw new AuthorizationFailedException();
        }
        $resource = $this->updateTask($user, $resource, $json);

        return $this->getContentResponse($resource);
    }

    /**
     * @SuppressWarnings(PHPMD.UnusedFormalParameters)
     * @param array $json
     * @param mixed $data
     * @return string|void
     */
    protected function validateResourceDocument($json, $data)
    {
        if (!self::arrayHas($json, 'data')) {
            return 'Missing `data` member at document“s top level.';
        }

        if (!self::arrayHas($json, 'data.id')) {
            return 'Document must have an `id`.';
        }

        if (self::arrayHas($json, 'data.attributes.renewal-date')) {
            $renewalDate = self::arrayGet($json, 'data.attributes.renewal-date');
            if (!self::isValidTimestamp($renewalDate)) {
                return '`renewal-date` is not an ISO 8601 timestamp.';
            }
        }
    }

    private function updateTask(\User $user, Task $resource, array $json): Task
    {
        if (Authority::canRenewTask($user, $resource)) {
            return $this->renewTask($resource, $json);
        }

        if (self::arrayGet($json, 'data.attributes.submitted') === true && $resource->canSubmit()) {
            $resource->submitTask();
        }

        if (self::arrayGet($json, 'data.attributes.renewal') === 'pending') {
            $resource->requestRenewal();
        }

        if (self::arrayHas($json, 'data.attributes.visible')) {
            $resource->setVisibility(self::arrayGet($json, 'data.attributes.visible'));
        }

        return $resource;
    }

    private function renewTask(Task $resource, array $json): Task
    {
        switch (self::arrayGet($json, 'data.attributes.renewal')) {
            case 'declined':
                $resource->declineRenewalRequest();
                break;

            case 'granted':
                $resource->grantRenewalRequest(
                    self::fromISO8601(self::arrayGet($json, 'data.attributes.renewal-date'))
                );
                break;
        }

        return $resource;
    }
}