-
Notifications
You must be signed in to change notification settings - Fork 2
/
ListLineItemsServiceServerRequestHandler.php
129 lines (110 loc) · 4.43 KB
/
ListLineItemsServiceServerRequestHandler.php
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
125
126
127
128
129
<?php
/**
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; under version 2
* of the License (non-upgradable).
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* Copyright (c) 2021 (original work) Open Assessment Technologies SA;
*/
declare(strict_types=1);
namespace OAT\Library\Lti1p3Ags\Service\LineItem\Server\Handler;
use Nyholm\Psr7\Response;
use OAT\Library\Lti1p3Ags\Model\LineItem\LineItemContainerInterface;
use OAT\Library\Lti1p3Ags\Repository\LineItemRepositoryInterface;
use OAT\Library\Lti1p3Ags\Serializer\LineItem\LineItemCollectionSerializer;
use OAT\Library\Lti1p3Ags\Serializer\LineItem\LineItemCollectionSerializerInterface;
use OAT\Library\Lti1p3Ags\Service\LineItem\LineItemServiceInterface;
use OAT\Library\Lti1p3Ags\Url\Builder\UrlBuilder;
use OAT\Library\Lti1p3Ags\Url\Builder\UrlBuilderInterface;
use OAT\Library\Lti1p3Core\Security\OAuth2\Validator\Result\RequestAccessTokenValidationResultInterface;
use OAT\Library\Lti1p3Core\Service\Server\Handler\LtiServiceServerRequestHandlerInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
/**
* @see https://www.imsglobal.org/spec/lti-ags/v2p0#example-getting-all-line-items-for-a-given-container
*/
class ListLineItemsServiceServerRequestHandler implements LtiServiceServerRequestHandlerInterface, LineItemServiceInterface
{
/** @var LineItemRepositoryInterface */
private $repository;
/** @var LineItemCollectionSerializerInterface */
private $serializer;
/** @var UrlBuilderInterface */
private $builder;
public function __construct(
LineItemRepositoryInterface $repository,
?LineItemCollectionSerializerInterface $serializer = null,
?UrlBuilderInterface $builder = null,
) {
$this->repository = $repository;
$this->serializer = $serializer ?? new LineItemCollectionSerializer();
$this->builder = $builder ?? new UrlBuilder();
}
public function getServiceName(): string
{
return static::NAME;
}
public function getAllowedContentType(): ?string
{
return static::CONTENT_TYPE_LINE_ITEM_CONTAINER;
}
public function getAllowedMethods(): array
{
return [
'GET',
];
}
public function getAllowedScopes(): array
{
return [
static::AUTHORIZATION_SCOPE_LINE_ITEM,
static::AUTHORIZATION_SCOPE_LINE_ITEM_READ_ONLY,
];
}
public function handleValidatedServiceRequest(
RequestAccessTokenValidationResultInterface $validationResult,
ServerRequestInterface $request,
array $options = []
): ResponseInterface {
parse_str($request->getUri()->getQuery(), $parameters);
$limit = array_key_exists('limit', $parameters) ? intval($parameters['limit']) : null;
$offset = array_key_exists('offset', $parameters) ? intval($parameters['offset']) : null;
$lineItemCollection = $this->repository->findCollection(
$parameters['resource_id'] ?? null,
$parameters['resource_link_id'] ?? null,
$parameters['tag'] ?? null,
$limit,
$offset
);
$responseBody = $this->serializer->serialize($lineItemCollection);
$responseHeaders = [
'Content-Type' => static::CONTENT_TYPE_LINE_ITEM_CONTAINER,
'Content-Length' => strlen($responseBody),
];
if ($lineItemCollection->hasNext()) {
$linkUrl = $this->builder->build(
$request->getUri()->__toString(),
null,
[
'offset' => ($limit ?? 0) + $offset
]
);
$responseHeaders[static::HEADER_LINK] = sprintf(
'<%s>; rel="%s"',
$linkUrl,
LineItemContainerInterface::REL_NEXT
);
}
return new Response(200, $responseHeaders, $responseBody);
}
}