16531587208

Committed 25 Jul 2025 09:05PM UTC coverage: 0.0% (-22.1%) from 22.07%

Build # 16531587208

Build Type

Pull #7225

github

Committed by

web-flow

Commit Message

Merge 23f449a58 into 02a764950

Pull Request Pull Request #7225: feat: json streamer

Run Details

0 of 294 new or added lines in 31 files covered. (0.0%)

11514 existing lines in 375 files now uncovered.

0 of 51976 relevant lines covered (0.0%)

0.0 hits per line

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

0.0

/src/State/Provider/ParameterProvider.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\State\Provider;

use ApiPlatform\Metadata\HttpOperation;
use ApiPlatform\Metadata\Operation;
use ApiPlatform\Metadata\Parameter;
use ApiPlatform\State\Exception\ParameterNotSupportedException;
use ApiPlatform\State\Exception\ProviderNotFoundException;
use ApiPlatform\State\ParameterNotFound;
use ApiPlatform\State\ParameterProvider\ReadLinkParameterProvider;
use ApiPlatform\State\ProviderInterface;
use ApiPlatform\State\Util\ParameterParserTrait;
use ApiPlatform\State\Util\RequestParser;
use Psr\Container\ContainerInterface;

/**
 * Loops over parameters to:
 *   - compute its values set as extra properties from the Parameter object (`_api_values`)
 *   - call the Parameter::provider if any and updates the Operation
 *
 * @experimental
 */
final class ParameterProvider implements ProviderInterface
{
    use ParameterParserTrait;

    public function __construct(private readonly ?ProviderInterface $decorated = null, private readonly ?ContainerInterface $locator = null)
    {
    }

    public function provide(Operation $operation, array $uriVariables = [], array $context = []): object|array|null
    {
        $request = $context['request'] ?? null;
        if ($request && null === $request->attributes->get('_api_query_parameters')) {
            $queryString = RequestParser::getQueryString($request);
            $request->attributes->set('_api_query_parameters', $queryString ? RequestParser::parseRequestParams($queryString) : []);
        }

        if ($request && null === $request->attributes->get('_api_header_parameters')) {
            $request->attributes->set('_api_header_parameters', $request->headers->all());
        }

        $parameters = $operation->getParameters();

        if ($operation instanceof HttpOperation && true === $operation->getStrictQueryParameterValidation()) {
            $keys = [];
            foreach ($parameters as $parameter) {
                $keys[] = $parameter->getKey();
            }

            foreach (array_keys($request->attributes->get('_api_query_parameters')) as $key) {
                if (!\in_array($key, $keys, true)) {
                    throw new ParameterNotSupportedException($key);
                }
            }
        }

        $context = ['operation' => $operation] + $context;

        foreach ($parameters ?? [] as $parameter) {
            $values = $this->getParameterValues($parameter, $request, $context);
            $value = $this->extractParameterValues($parameter, $values);
            // we force API Platform's value extraction, use _api_query_parameters or _api_header_parameters if you need to set a value
            if (isset($parameter->getExtraProperties()['_api_values'])) {
                unset($parameter->getExtraProperties()['_api_values']);
            }

            if (($default = $parameter->getSchema()['default'] ?? false) && ($value instanceof ParameterNotFound || !$value)) {
                $value = $default;
            }

            $parameter->setValue($value);
            $context['operation'] = $operation = $this->callParameterProvider($operation, $parameter, $values, $context);
        }

        if ($parameters) {
            $operation = $operation->withParameters($parameters);
        }

        if ($operation instanceof HttpOperation) {
            $operation = $this->handlePathParameters($operation, $uriVariables, $context);
        }

        $request?->attributes->set('_api_operation', $operation);
        $context['operation'] = $operation;

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

    /**
     * TODO: uriVariables could be a Parameters instance, it'd make things easier.
     *
     * @param array<string, mixed> $uriVariables
     * @param array<string, mixed> $context
     */
    private function handlePathParameters(HttpOperation $operation, array $uriVariables, array $context): HttpOperation
    {
        foreach ($operation->getUriVariables() ?? [] as $key => $uriVariable) {
            $uriVariable = $uriVariable->withKey($key);
            if ($uriVariable->getSecurity() && !$uriVariable->getProvider()) {
                $uriVariable = $uriVariable->withProvider(ReadLinkParameterProvider::class);
            }

            $values = $uriVariables;

            if (!\array_key_exists($key, $uriVariables)) {
                continue;
            }

            $value = $uriVariables[$key];
            // we force API Platform's value extraction, use _api_query_parameters or _api_header_parameters if you need to set a value
            if (isset($uriVariable->getExtraProperties()['_api_values'])) {
                unset($uriVariable->getExtraProperties()['_api_values']);
            }

            if (($default = $uriVariable->getSchema()['default'] ?? false) && ($value instanceof ParameterNotFound || !$value)) {
                $value = $default;
            }

            $uriVariable->setValue($value);
            if (($op = $this->callParameterProvider($operation, $uriVariable, $values, $context)) instanceof HttpOperation) {
                $context['operation'] = $operation = $op;
            }
        }

        return $operation;
    }

    /**
     * @param array<string,mixed> $context
     */
    private function callParameterProvider(Operation $operation, Parameter $parameter, mixed $values, array $context): Operation
    {
        if ($parameter->getValue() instanceof ParameterNotFound) {
            return $operation;
        }

        if (null === ($provider = $parameter->getProvider())) {
            return $operation;
        }

        if (\is_callable($provider)) {
            if (($op = $provider($parameter, $values, $context)) instanceof Operation) {
                $operation = $op;
            }

            return $operation;
        }

        if (\is_string($provider)) {
            if (!$this->locator->has($provider)) {
                throw new ProviderNotFoundException(\sprintf('Provider "%s" not found on operation "%s"', $provider, $operation->getName()));
            }

            $provider = $this->locator->get($provider);
        }

        if (($op = $provider->provide($parameter, $values, $context)) instanceof Operation) {
            $operation = $op;
        }

        return $operation;
    }
}

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\State\Provider;
15
16	use ApiPlatform\Metadata\HttpOperation;
17	use ApiPlatform\Metadata\Operation;
18	use ApiPlatform\Metadata\Parameter;
19	use ApiPlatform\State\Exception\ParameterNotSupportedException;
20	use ApiPlatform\State\Exception\ProviderNotFoundException;
21	use ApiPlatform\State\ParameterNotFound;
22	use ApiPlatform\State\ParameterProvider\ReadLinkParameterProvider;
23	use ApiPlatform\State\ProviderInterface;
24	use ApiPlatform\State\Util\ParameterParserTrait;
25	use ApiPlatform\State\Util\RequestParser;
26	use Psr\Container\ContainerInterface;
27
28	/**
29	* Loops over parameters to:
30	* - compute its values set as extra properties from the Parameter object (`_api_values`)
31	* - call the Parameter::provider if any and updates the Operation
32	*
33	* @experimental
34	*/
35	final class ParameterProvider implements ProviderInterface
36	{
37	use ParameterParserTrait;
38
39	public function __construct(private readonly ?ProviderInterface $decorated = null, private readonly ?ContainerInterface $locator = null)
40	{
UNCOV 41	}	×
42
43	public function provide(Operation $operation, array $uriVariables = [], array $context = []): object\|array\|null
44	{
UNCOV 45	$request = $context['request'] ?? null;	×
UNCOV 46	if ($request && null === $request->attributes->get('_api_query_parameters')) {	×
UNCOV 47	$queryString = RequestParser::getQueryString($request);	×
UNCOV 48	$request->attributes->set('_api_query_parameters', $queryString ? RequestParser::parseRequestParams($queryString) : []);	×
49	}
50
UNCOV 51	if ($request && null === $request->attributes->get('_api_header_parameters')) {	×
UNCOV 52	$request->attributes->set('_api_header_parameters', $request->headers->all());	×
53	}
54
UNCOV 55	$parameters = $operation->getParameters();	×
56
UNCOV 57	if ($operation instanceof HttpOperation && true === $operation->getStrictQueryParameterValidation()) {	×
UNCOV 58	$keys = [];	×
UNCOV 59	foreach ($parameters as $parameter) {	×
UNCOV 60	$keys[] = $parameter->getKey();	×
61	}
62
UNCOV 63	foreach (array_keys($request->attributes->get('_api_query_parameters')) as $key) {	×
UNCOV 64	if (!\in_array($key, $keys, true)) {	×
UNCOV 65	throw new ParameterNotSupportedException($key);	×
66	}
67	}
68	}
69
UNCOV 70	$context = ['operation' => $operation] + $context;	×
71
UNCOV 72	foreach ($parameters ?? [] as $parameter) {	×
UNCOV 73	$values = $this->getParameterValues($parameter, $request, $context);	×
UNCOV 74	$value = $this->extractParameterValues($parameter, $values);	×
75	// we force API Platform's value extraction, use _api_query_parameters or _api_header_parameters if you need to set a value
UNCOV 76	if (isset($parameter->getExtraProperties()['_api_values'])) {	×
UNCOV 77	unset($parameter->getExtraProperties()['_api_values']);	×
78	}
79
UNCOV 80	if (($default = $parameter->getSchema()['default'] ?? false) && ($value instanceof ParameterNotFound \|\| !$value)) {	×
UNCOV 81	$value = $default;	×
82	}
83
UNCOV 84	$parameter->setValue($value);	×
UNCOV 85	$context['operation'] = $operation = $this->callParameterProvider($operation, $parameter, $values, $context);	×
86	}
87
UNCOV 88	if ($parameters) {	×
UNCOV 89	$operation = $operation->withParameters($parameters);	×
90	}
91
UNCOV 92	if ($operation instanceof HttpOperation) {	×
UNCOV 93	$operation = $this->handlePathParameters($operation, $uriVariables, $context);	×
94	}
95
UNCOV 96	$request?->attributes->set('_api_operation', $operation);	×
UNCOV 97	$context['operation'] = $operation;	×
98
UNCOV 99	return $this->decorated?->provide($operation, $uriVariables, $context);	×
100	}
101
102	/**
103	* TODO: uriVariables could be a Parameters instance, it'd make things easier.
104	*
105	* @param array<string, mixed> $uriVariables
106	* @param array<string, mixed> $context
107	*/
108	private function handlePathParameters(HttpOperation $operation, array $uriVariables, array $context): HttpOperation
109	{
UNCOV 110	foreach ($operation->getUriVariables() ?? [] as $key => $uriVariable) {	×
UNCOV 111	$uriVariable = $uriVariable->withKey($key);	×
UNCOV 112	if ($uriVariable->getSecurity() && !$uriVariable->getProvider()) {	×
UNCOV 113	$uriVariable = $uriVariable->withProvider(ReadLinkParameterProvider::class);	×
114	}
115
UNCOV 116	$values = $uriVariables;	×
117
UNCOV 118	if (!\array_key_exists($key, $uriVariables)) {	×
UNCOV 119	continue;	×
120	}
121
UNCOV 122	$value = $uriVariables[$key];	×
123	// we force API Platform's value extraction, use _api_query_parameters or _api_header_parameters if you need to set a value
UNCOV 124	if (isset($uriVariable->getExtraProperties()['_api_values'])) {	×
UNCOV 125	unset($uriVariable->getExtraProperties()['_api_values']);	×
126	}
127
UNCOV 128	if (($default = $uriVariable->getSchema()['default'] ?? false) && ($value instanceof ParameterNotFound \|\| !$value)) {	×
129	$value = $default;	×
130	}
131
UNCOV 132	$uriVariable->setValue($value);	×
UNCOV 133	if (($op = $this->callParameterProvider($operation, $uriVariable, $values, $context)) instanceof HttpOperation) {	×
UNCOV 134	$context['operation'] = $operation = $op;	×
135	}
136	}
137
UNCOV 138	return $operation;	×
139	}
140
141	/**
142	* @param array<string,mixed> $context
143	*/
144	private function callParameterProvider(Operation $operation, Parameter $parameter, mixed $values, array $context): Operation
145	{
UNCOV 146	if ($parameter->getValue() instanceof ParameterNotFound) {	×
UNCOV 147	return $operation;	×
148	}
149
UNCOV 150	if (null === ($provider = $parameter->getProvider())) {	×
UNCOV 151	return $operation;	×
152	}
153
UNCOV 154	if (\is_callable($provider)) {	×
UNCOV 155	if (($op = $provider($parameter, $values, $context)) instanceof Operation) {	×
UNCOV 156	$operation = $op;	×
157	}
158
UNCOV 159	return $operation;	×
160	}
161
UNCOV 162	if (\is_string($provider)) {	×
UNCOV 163	if (!$this->locator->has($provider)) {	×
164	throw new ProviderNotFoundException(\sprintf('Provider "%s" not found on operation "%s"', $provider, $operation->getName()));	×
165	}
166
UNCOV 167	$provider = $this->locator->get($provider);	×
168	}
169
UNCOV 170	if (($op = $provider->provide($parameter, $values, $context)) instanceof Operation) {	×
UNCOV 171	$operation = $op;	×
172	}
173
UNCOV 174	return $operation;	×
175	}
176	}

api-platform / core / 16531587208

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