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

namespace JsonApi\Routes\Courseware;

use JsonApi\Errors\AuthorizationFailedException;
use JsonApi\Errors\RecordNotFoundException;
use JsonApi\JsonApiController;
use JsonApi\Routes\ValidationTrait;
use JsonApi\Schemas\Courseware\Clipboard as ClipboardSchema;
use Psr\Http\Message\ResponseInterface as Response;
use Psr\Http\Message\ServerRequestInterface as Request;

/**
 * Create a clipboard.
 * 
 * @author  Ron Lucke <lucke@elan-ev.de>
 * @license GPL2 or any later version
 *
 * @since   Stud.IP 5.4
 */
class ClipboardsCreate extends JsonApiController
{
    use ValidationTrait;

    /**
     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
     */
    public function __invoke(Request $request, Response $response, $args)
    {
        $json = $this->validate($request);
        $user = $this->getUser($request);
        $object = $this->getObject($json);
        if (!$object) {
            throw new RecordNotFoundException();
        }
        if (!Authority::canCreateClipboard($user, $object)) {
            throw new AuthorizationFailedException();
        }

        $clipboard = $this->createClipboard($user, $json, $object);

        return $this->getCreatedResponse($clipboard);
    }

    /**
     * @SuppressWarnings(PHPMD.UnusedFormalParameters)
     */
    protected function validateResourceDocument($json, $data)
    {
        if (!self::arrayHas($json, 'data')) {
            return 'Missing `data` member at document“s top level.';
        }
        if (!self::arrayHas($json, 'data.attributes.name')) {
            return 'Missing `name` value.';
        }
        if (!self::arrayHas($json, 'data.attributes.object-type')) {
            return 'Missing `object-type` value.';
        }
        if (
            !(
                self::arrayHas($json, 'data.attributes.block-id')
                || self::arrayHas($json, 'data.attributes.container-id')
                || self::arrayHas($json, 'data.attributes.structural-element-id')
            )
        ) {
            return 'Missing `block-id`, `container-id` or `structural-element-id` value.';
        }
        if (!self::arrayHas($json, 'data.attributes.object-kind')) {
            return 'Missing `object-kind` value.';
        }
        if (!$this->validateObjectType($json)) {
            return 'Invalid `object-type` value.';
        }
    }

    private function createClipboard(\User $user, array $json, $object)
    {
        $clipboard = \Courseware\Clipboard::create([
            'user_id' => $user->id,
            'name' => self::arrayGet($json, 'data.attributes.name'),
            'block_id' => self::arrayGet($json, 'data.attributes.block-id'),
            'container_id' => self::arrayGet($json, 'data.attributes.container-id'),
            'structural_element_id' => self::arrayGet($json, 'data.attributes.structural-element-id'),
            'object_type' => self::arrayGet($json, 'data.attributes.object-type'),
            'object_kind' => self::arrayGet($json, 'data.attributes.object-kind'),
            'backup' => $this->createBackup($object)
        ]);

        return $clipboard;
    }

    private function createBackup($object): string
    {
        return $object->getClipboardBackup();
    }

    private function validateObjectType($json): bool
    {
        $type = self::arrayGet($json, 'data.attributes.object-type');

        return in_array($type, ['courseware-structural-elements', 'courseware-containers', 'courseware-blocks']);
    }

    private function getObject($json): ?object
    {
        $object = null;
        $type = self::arrayGet($json, 'data.attributes.object-type');

        switch ($type) {
            case 'courseware-structural-elements':
                $object = \Courseware\StructuralElement::find(self::arrayGet($json, 'data.attributes.structural-element-id'));
                break;
            case 'courseware-containers':
                $object = \Courseware\Container::find(self::arrayGet($json, 'data.attributes.container-id'));
                break;
            case 'courseware-blocks':
                $object = \Courseware\Block::find(self::arrayGet($json, 'data.attributes.block-id'));
                break;
        }

        return $object;
    }
}