18018574401

Committed 25 Sep 2025 07:30PM UTC coverage: 21.847% (-0.04%) from 21.883%

Build # 18018574401

Build Type

push

github

Committed by

soyuka

Commit Message

Merge 4.1

Run Details

0 of 8 new or added lines in 1 file covered. (0.0%)

3 existing lines in 1 file now uncovered.

11880 of 54379 relevant lines covered (21.85%)

25.41 hits per line

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

88.24

/src/Symfony/Validator/State/ParameterValidatorProvider.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\Symfony\Validator\State;

use ApiPlatform\Metadata\HttpOperation;
use ApiPlatform\Metadata\Operation;
use ApiPlatform\Metadata\Parameter;
use ApiPlatform\Metadata\Parameters;
use ApiPlatform\State\ParameterNotFound;
use ApiPlatform\State\ProviderInterface;
use ApiPlatform\State\Util\ParameterParserTrait;
use ApiPlatform\Validator\Exception\ValidationException;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Validator\ConstraintViolation;
use Symfony\Component\Validator\ConstraintViolationInterface;
use Symfony\Component\Validator\ConstraintViolationList;
use Symfony\Component\Validator\Validator\ValidatorInterface;

/**
 * Validates parameters using the Symfony validator.
 */
final class ParameterValidatorProvider implements ProviderInterface
{
    use ParameterParserTrait;

    public function __construct(
        private readonly ValidatorInterface $validator,
        private readonly ProviderInterface $decorated,
    ) {
    }

    public function provide(Operation $operation, array $uriVariables = [], array $context = []): object|array|null
    {
        if (!($request = $context['request'] ?? null) instanceof Request) {
            return $this->decorated->provide($operation, $uriVariables, $context);
        }

        $operation = $request->attributes->get('_api_operation') ?? $operation;
        if (!($operation->getQueryParameterValidationEnabled() ?? true)) {
            return $this->decorated->provide($operation, $uriVariables, $context);
        }

        $constraintViolationList = new ConstraintViolationList();
        $parameters = $operation->getParameters() ?? new Parameters();

        if ($operation instanceof HttpOperation) {
            foreach ($operation->getUriVariables() ?? [] as $key => $uriVariable) {
                if ($uriVariable->getValue() instanceof ParameterNotFound) {
                    $uriVariable->setValue($uriVariables[$key] ?? new ParameterNotFound());
                }

                $parameters->add($key, $uriVariable->withKey($key));
            }
        }

        foreach ($parameters as $parameter) {
            if (!$constraints = $parameter->getConstraints()) {
                continue;
            }

            $value = $parameter->getValue();

            if ($value instanceof ParameterNotFound) {
                $value = null;
            }

            $violations = $this->validator->validate($value, $constraints);

            foreach ($violations as $violation) {
                $constraintViolationList->add(new ConstraintViolation(
                    $violation->getMessage(),
                    $violation->getMessageTemplate(),
                    $violation->getParameters(),
                    $violation->getRoot(),
                    $this->getProperty($parameter, $violation),
                    $violation->getInvalidValue(),
                    $violation->getPlural(),
                    $violation->getCode(),
                    $violation->getConstraint(),
                    $violation->getCause()
                ));
            }
        }

        if (0 !== \count($constraintViolationList)) {
            throw new ValidationException($constraintViolationList);
        }

        return $this->decorated->provide($operation, $uriVariables, $context);
    }

    // There's a `property` inside Parameter but it's used for hydra:search only as here we want the parameter name instead
    private function getProperty(Parameter $parameter, ConstraintViolationInterface $violation): string
    {
        $key = $parameter->getKey();

        if (str_contains($key, '[:property]')) {
            return str_replace('[:property]', $violation->getPropertyPath(), $key);
        }

        if (str_contains($key, ':property')) {
            return str_replace(':property', $violation->getPropertyPath(), $key);
        }

        $openApi = $parameter->getOpenApi();
        if (false === $openApi) {
            $openApi = null;
        }

        if (\is_array($openApi)) {
            foreach ($openApi as $oa) {
                if ('deepObject' === $oa->getStyle() && ($oa->getName() === $key || str_starts_with($oa->getName(), $key.'['))) {
                    return $key.$violation->getPropertyPath();
                }
            }
        } elseif ('deepObject' === $openApi?->getStyle() && $p = $violation->getPropertyPath()) {
            return $key.$p;
        }

        return $key;
    }
}

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\Symfony\Validator\State;
15
16	use ApiPlatform\Metadata\HttpOperation;
17	use ApiPlatform\Metadata\Operation;
18	use ApiPlatform\Metadata\Parameter;
19	use ApiPlatform\Metadata\Parameters;
20	use ApiPlatform\State\ParameterNotFound;
21	use ApiPlatform\State\ProviderInterface;
22	use ApiPlatform\State\Util\ParameterParserTrait;
23	use ApiPlatform\Validator\Exception\ValidationException;
24	use Symfony\Component\HttpFoundation\Request;
25	use Symfony\Component\Validator\ConstraintViolation;
26	use Symfony\Component\Validator\ConstraintViolationInterface;
27	use Symfony\Component\Validator\ConstraintViolationList;
28	use Symfony\Component\Validator\Validator\ValidatorInterface;
29
30	/**
31	* Validates parameters using the Symfony validator.
32	*/
33	final class ParameterValidatorProvider implements ProviderInterface
34	{
35	use ParameterParserTrait;
36
37	public function __construct(
38	private readonly ValidatorInterface $validator,
39	private readonly ProviderInterface $decorated,
40	) {
41	}	631✔
42
43	public function provide(Operation $operation, array $uriVariables = [], array $context = []): object\|array\|null
44	{
45	if (!($request = $context['request'] ?? null) instanceof Request) {	603✔
46	return $this->decorated->provide($operation, $uriVariables, $context);	×
47	}
48
49	$operation = $request->attributes->get('_api_operation') ?? $operation;	603✔
50	if (!($operation->getQueryParameterValidationEnabled() ?? true)) {	603✔
51	return $this->decorated->provide($operation, $uriVariables, $context);	2✔
52	}
53
54	$constraintViolationList = new ConstraintViolationList();	601✔
55	$parameters = $operation->getParameters() ?? new Parameters();	601✔
56
57	if ($operation instanceof HttpOperation) {	601✔
58	foreach ($operation->getUriVariables() ?? [] as $key => $uriVariable) {	601✔
59	if ($uriVariable->getValue() instanceof ParameterNotFound) {	222✔
60	$uriVariable->setValue($uriVariables[$key] ?? new ParameterNotFound());	218✔
61	}
62
63	$parameters->add($key, $uriVariable->withKey($key));	222✔
64	}
65	}
66
67	foreach ($parameters as $parameter) {	601✔
68	if (!$constraints = $parameter->getConstraints()) {	532✔
69	continue;	502✔
70	}
71
72	$value = $parameter->getValue();	188✔
73
74	if ($value instanceof ParameterNotFound) {	188✔
75	$value = null;	78✔
76	}
77
78	$violations = $this->validator->validate($value, $constraints);	188✔
79
80	foreach ($violations as $violation) {	188✔
81	$constraintViolationList->add(new ConstraintViolation(	64✔
82	$violation->getMessage(),	64✔
83	$violation->getMessageTemplate(),	64✔
84	$violation->getParameters(),	64✔
85	$violation->getRoot(),	64✔
86	$this->getProperty($parameter, $violation),	64✔
87	$violation->getInvalidValue(),	64✔
88	$violation->getPlural(),	64✔
89	$violation->getCode(),	64✔
90	$violation->getConstraint(),	64✔
91	$violation->getCause()	64✔
92	));	64✔
93	}
94	}
95
96	if (0 !== \count($constraintViolationList)) {	601✔
97	throw new ValidationException($constraintViolationList);	64✔
98	}
99
100	return $this->decorated->provide($operation, $uriVariables, $context);	601✔
101	}
102
103	// There's a `property` inside Parameter but it's used for hydra:search only as here we want the parameter name instead
104	private function getProperty(Parameter $parameter, ConstraintViolationInterface $violation): string
105	{
106	$key = $parameter->getKey();	64✔
107
108	if (str_contains($key, '[:property]')) {	64✔
109	return str_replace('[:property]', $violation->getPropertyPath(), $key);	6✔
110	}
111
112	if (str_contains($key, ':property')) {	60✔
113	return str_replace(':property', $violation->getPropertyPath(), $key);	×
114	}
115
116	$openApi = $parameter->getOpenApi();	60✔
117	if (false === $openApi) {	60✔
118	$openApi = null;	×
119	}
120
121	if (\is_array($openApi)) {	60✔
UNCOV 122	foreach ($openApi as $oa) {	×
UNCOV 123	if ('deepObject' === $oa->getStyle() && ($oa->getName() === $key \|\| str_starts_with($oa->getName(), $key.'['))) {	×
UNCOV 124	return $key.$violation->getPropertyPath();	×
125	}
126	}
127	} elseif ('deepObject' === $openApi?->getStyle() && $p = $violation->getPropertyPath()) {	60✔
128	return $key.$p;	2✔
129	}
130
131	return $key;	60✔
132	}
133	}

api-platform / core / 18018574401

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