Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
100.00% covered (success)
100.00%
12 / 12
100.00% covered (success)
100.00%
2 / 2
CRAP
100.00% covered (success)
100.00%
1 / 1
DeliverySearchRequestValidator
100.00% covered (success)
100.00%
12 / 12
100.00% covered (success)
100.00%
2 / 2
3
100.00% covered (success)
100.00%
1 / 1
 validate
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 validateRequired
100.00% covered (success)
100.00%
11 / 11
100.00% covered (success)
100.00%
1 / 1
2
1<?php
2
3/**
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License
6 * as published by the Free Software Foundation; under version 2
7 * of the License (non-upgradable).
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
17 *
18 * Copyright (c) 2022 (original work) Open Assessment Technologies SA;
19 *
20 * @author Sergei Mikhailov <sergei.mikhailov@taotesting.com>
21 */
22
23declare(strict_types=1);
24
25namespace oat\taoDeliveryRdf\model\Delivery\Presentation\Web\RequestValidator;
26
27use common_exception_RestApi as BadRequestException;
28use oat\taoDeliveryRdf\model\Delivery\Presentation\Web\RequestHandler\DeliverySearchRequestHandler;
29use Psr\Http\Message\ServerRequestInterface;
30
31class DeliverySearchRequestValidator
32{
33    private const REQUIRED_QUERY_PARAMETERS = [
34        DeliverySearchRequestHandler::ID,
35    ];
36
37    /**
38     * @param ServerRequestInterface $request
39     *
40     * @throws BadRequestException
41     */
42    public function validate(ServerRequestInterface $request): void
43    {
44        $this->validateRequired($request);
45    }
46
47    /**
48     * @param ServerRequestInterface $request
49     *
50     * @throws BadRequestException
51     */
52    private function validateRequired(ServerRequestInterface $request): void
53    {
54        $missingQueryParameters = array_diff_key(
55            array_flip(self::REQUIRED_QUERY_PARAMETERS),
56            $request->getQueryParams()
57        );
58
59        if ($missingQueryParameters) {
60            throw new BadRequestException(
61                sprintf(
62                    'The following query parameters must be provided: "%s".',
63                    implode('", "', array_keys($missingQueryParameters))
64                )
65            );
66        }
67    }
68}