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
|
<?php
namespace JsonApi\Routes\Courseware;
use Courseware\StructuralElementComment;
use JsonApi\Errors\AuthorizationFailedException;
use JsonApi\Errors\RecordNotFoundException;
use JsonApi\JsonApiController;
use JsonApi\Routes\ValidationTrait;
use JsonApi\Schemas\Courseware\StructuralElement as StructuralElementSchema;
use JsonApi\Schemas\Courseware\StructuralElementComment as StructuralElementCommentSchema;
use JsonApi\Schemas\User as UserSchema;
use Psr\Http\Message\ResponseInterface as Response;
use Psr\Http\Message\ServerRequestInterface as Request;
/**
* Update a comment on a structural element
*/
class StructuralElementCommentsUpdate extends JsonApiController
{
use ValidationTrait, UserProgressesHelper;
/**
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function __invoke(Request $request, Response $response, $args)
{
if (!($resource = StructuralElementComment::find($args['id']))) {
throw new RecordNotFoundException();
}
$json = $this->validate($request, $resource);
if (!Authority::canUpdateStructuralElementComment($this->getUser($request), $resource)) {
throw new AuthorizationFailedException();
}
$structuralElementComment = $this->updateStructuralElementComment($json, $resource);
return $this->getContentResponse($structuralElementComment);
}
/**
* @SuppressWarnings(PHPMD.UnusedFormalParameters)
* @SuppressWarnings(CyclomaticComplexity)
* @SuppressWarnings(NPathComplexity)
*/
protected function validateResourceDocument($json, $data)
{
if (!self::arrayHas($json, 'data')) {
return 'Missing `data` member at document´s top level.';
}
if (StructuralElementCommentSchema::TYPE !== self::arrayGet($json, 'data.type')) {
return 'Wrong `type` member of document´s `data`.';
}
if (self::arrayGet($json, 'data.id') !== $data->id) {
return 'Mismatch in document `id`.';
}
if (!($comment = self::arrayGet($json, 'data.attributes.comment'))) {
return 'Missing `comment` attribute.';
}
if (!is_string($comment)) {
return 'Attribute `comment` must be a string.';
}
if ($comment == '') {
return 'Attribute `comment` must not be empty.';
}
if (self::arrayHas($json, 'data.relationships.user')) {
if (!($user = $this->getUserFromJson($json))) {
return 'Invalid `user` relationship.';
}
if ($user->id !== $data['user_id']) {
return 'Cannot update `user` relationship.';
}
}
if (self::arrayHas($json, 'data.relationships.structural-element')) {
if (!($structural_element = $this->getStructuralElementFromJson($json))) {
return 'Invalid `structural-element` relationship.';
}
if ($structural_element->id !== $data['structural_element_id']) {
return 'Cannot update `structural-element` relationship.';
}
}
}
private function getStructuralElementFromJson($json)
{
if (!$this->validateResourceObject($json, 'data.relationships.structural-element', StructuralElementSchema::TYPE)) {
return null;
}
$structuralElementId = self::arrayGet($json, 'data.relationships.structural-element.data.id');
return \Courseware\StructuralElement::find($structuralElementId);
}
private function getUserFromJson($json)
{
if (!$this->validateResourceObject($json, 'data.relationships.user', UserSchema::TYPE)) {
return null;
}
$userId = self::arrayGet($json, 'data.relationships.user.data.id');
return \User::find($userId);
}
private function updateStructuralElementComment(array $json, \Courseware\StructuralElementComment $resource)
{
$resource->comment = self::arrayGet($json, 'data.attributes.comment', '');
$resource->store();
return $resource;
}
}
|
