#27053

pending completion

Build # #27053

Build Type

push

github

Committed by

web-flow

Commit Message

<a href="https://github.com/api-platform/core/commit/<a class=hub.com/api-platform/core/commit/682f3ce7c62617a1068f8fc29523a775ca49c67d">682f3ce7c<a href="https://github.com/api-platform/core/commit/682f3ce7c62617a1068f8fc29523a775ca49c67d">">Merge </a><a class="double-link" href="https://github.com/api-platform/core/commit/<a class="double-link" href="https://github.com/api-platform/core/commit/0b65adc80be78023c27c242c5d921f74b038f79f">0b65adc80</a>">0b65adc80</a><a href="https://github.com/api-platform/core/commit/682f3ce7c62617a1068f8fc29523a775ca49c67d"> into 14bd387a2">14bd387a2</a>

Run Details

2 of 2 new or added lines in 1 file covered. (100.0%)

9623 of 11579 relevant lines covered (83.11%)

14.41 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

83.87

/src/Filter/Validator/Required.php

<?php

/*
 * This file is part of the API Platform project.
 *
 * (c) Kévin Dunglas <dunglas@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace ApiPlatform\Core\Filter\Validator;

use ApiPlatform\Core\Util\RequestParser;

final class Required implements ValidatorInterface
{
    /**
     * {@inheritdoc}
     */
    public function validate(string $name, array $filterDescription, array $queryParameters): array
    {
        // filter is not required, the `checkRequired` method can not break
        if (!($filterDescription['required'] ?? false)) {
            return [];
        }

        // if query param is not given, then break
        if (!$this->requestHasQueryParameter($queryParameters, $name)) {
            return [
                sprintf('Query parameter "%s" is required', $name),
            ];
        }

        // if query param is empty and the configuration does not allow it
        if (!($filterDescription['swagger']['allowEmptyValue'] ?? false) && empty($this->requestGetQueryParameter($queryParameters, $name))) {
            return [
                sprintf('Query parameter "%s" does not allow empty value', $name),
            ];
        }

        return [];
    }

    /**
     * Test if request has required parameter.
     */
    private function requestHasQueryParameter(array $queryParameters, string $name): bool
    {
        $matches = RequestParser::parseRequestParams($name);
        if (!$matches) {
            return false;
        }

        $rootName = array_keys($matches)[0] ?? '';
        if (!$rootName) {
            return false;
        }

        if (\is_array($matches[$rootName])) {
            $keyName = array_keys($matches[$rootName])[0];

            $queryParameter = $queryParameters[(string) $rootName] ?? null;

            return \is_array($queryParameter) && isset($queryParameter[$keyName]);
        }

        return \array_key_exists((string) $rootName, $queryParameters);
    }

    /**
     * Test if required filter is valid. It validates array notation too like "required[bar]".
     *
     * @return ?mixed
     */
    private function requestGetQueryParameter(array $queryParameters, string $name)
    {
        $matches = RequestParser::parseRequestParams($name);
        if (empty($matches)) {
            return null;
        }

        $rootName = array_keys($matches)[0] ?? '';
        if (!$rootName) {
            return null;
        }

        if (\is_array($matches[$rootName])) {
            $keyName = array_keys($matches[$rootName])[0];

            $queryParameter = $queryParameters[(string) $rootName] ?? null;

            if (\is_array($queryParameter) && isset($queryParameter[$keyName])) {
                return $queryParameter[$keyName];
            }

            return null;
        }

        return $queryParameters[(string) $rootName];
    }
}

1	<?php
2
3	/*
4	* This file is part of the API Platform project.
5	*
6	* (c) Kévin Dunglas <dunglas@gmail.com>
7	*
8	* For the full copyright and license information, please view the LICENSE
9	* file that was distributed with this source code.
10	*/
11
12	declare(strict_types=1);
13
14	namespace ApiPlatform\Core\Filter\Validator;
15
16	use ApiPlatform\Core\Util\RequestParser;
17
18	final class Required implements ValidatorInterface
19	{
20	/**
21	* {@inheritdoc}
22	*/
23	public function validate(string $name, array $filterDescription, array $queryParameters): array
24	{
25	// filter is not required, the `checkRequired` method can not break
26	if (!($filterDescription['required'] ?? false)) {	12✔
27	return [];	4✔
28	}
29
30	// if query param is not given, then break
31	if (!$this->requestHasQueryParameter($queryParameters, $name)) {	8✔
32	return [
33	sprintf('Query parameter "%s" is required', $name),	2✔
34	];
35	}
36
37	// if query param is empty and the configuration does not allow it
38	if (!($filterDescription['swagger']['allowEmptyValue'] ?? false) && empty($this->requestGetQueryParameter($queryParameters, $name))) {	6✔
39	return [
40	sprintf('Query parameter "%s" does not allow empty value', $name),	1✔
41	];
42	}
43
44	return [];	5✔
45	}
46
47	/**
48	* Test if request has required parameter.
49	*/
50	private function requestHasQueryParameter(array $queryParameters, string $name): bool
51	{
52	$matches = RequestParser::parseRequestParams($name);	8✔
53	if (!$matches) {	8✔
54	return false;	×
55	}
56
57	$rootName = array_keys($matches)[0] ?? '';	8✔
58	if (!$rootName) {	8✔
59	return false;	×
60	}
61
62	if (\is_array($matches[$rootName])) {	8✔
63	$keyName = array_keys($matches[$rootName])[0];	1✔
64
65	$queryParameter = $queryParameters[(string) $rootName] ?? null;	1✔
66
67	return \is_array($queryParameter) && isset($queryParameter[$keyName]);	1✔
68	}
69
70	return \array_key_exists((string) $rootName, $queryParameters);	7✔
71	}
72
73	/**
74	* Test if required filter is valid. It validates array notation too like "required[bar]".
75	*
76	* @return ?mixed
77	*/
78	private function requestGetQueryParameter(array $queryParameters, string $name)
79	{
80	$matches = RequestParser::parseRequestParams($name);	5✔
81	if (empty($matches)) {	5✔
82	return null;	×
83	}
84
85	$rootName = array_keys($matches)[0] ?? '';	5✔
86	if (!$rootName) {	5✔
87	return null;	×
88	}
89
90	if (\is_array($matches[$rootName])) {	5✔
91	$keyName = array_keys($matches[$rootName])[0];	1✔
92
93	$queryParameter = $queryParameters[(string) $rootName] ?? null;	1✔
94
95	if (\is_array($queryParameter) && isset($queryParameter[$keyName])) {	1✔
96	return $queryParameter[$keyName];	1✔
97	}
98
99	return null;	×
100	}
101
102	return $queryParameters[(string) $rootName];	4✔
103	}
104	}

api-platform / core / #27053

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous