15187574500

Committed 22 May 2025 01:14PM UTC coverage: 27.347%. Remained the same

Build # 15187574500

Build Type

push

github

Committed by

soyuka

Commit Message

docs: changelog 4.1.11

Run Details

13482 of 49299 relevant lines covered (27.35%)

74.57 hits per line

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

90.0

/src/Metadata/Resource/Factory/ParameterResourceMetadataCollectionFactory.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\Metadata\Resource\Factory;

use ApiPlatform\Metadata\ApiProperty;
use ApiPlatform\Metadata\Exception\RuntimeException;
use ApiPlatform\Metadata\FilterInterface;
use ApiPlatform\Metadata\JsonSchemaFilterInterface;
use ApiPlatform\Metadata\OpenApiParameterFilterInterface;
use ApiPlatform\Metadata\Operation;
use ApiPlatform\Metadata\Parameter;
use ApiPlatform\Metadata\ParameterProviderFilterInterface;
use ApiPlatform\Metadata\Parameters;
use ApiPlatform\Metadata\PropertiesAwareInterface;
use ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
use ApiPlatform\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
use ApiPlatform\Metadata\Resource\ResourceMetadataCollection;
use ApiPlatform\OpenApi\Model\Parameter as OpenApiParameter;
use ApiPlatform\Serializer\Filter\FilterInterface as SerializerFilterInterface;
use ApiPlatform\State\Util\StateOptionsTrait;
use Psr\Container\ContainerInterface;
use Psr\Log\LoggerInterface;
use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
use Symfony\Component\TypeInfo\Type;

/**
 * Prepares Parameters documentation by reading its filter details and declaring an OpenApi parameter.
 *
 * @experimental
 */
final class ParameterResourceMetadataCollectionFactory implements ResourceMetadataCollectionFactoryInterface
{
    use StateOptionsTrait;

    private array $localPropertyCache;

    public function __construct(
        private readonly PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory,
        private readonly PropertyMetadataFactoryInterface $propertyMetadataFactory,
        private readonly ?ResourceMetadataCollectionFactoryInterface $decorated = null,
        private readonly ?ContainerInterface $filterLocator = null,
        private readonly ?NameConverterInterface $nameConverter = null,
        private readonly ?LoggerInterface $logger = null,
    ) {
    }

    public function create(string $resourceClass): ResourceMetadataCollection
    {
        $resourceMetadataCollection = $this->decorated?->create($resourceClass) ?? new ResourceMetadataCollection($resourceClass);

        foreach ($resourceMetadataCollection as $i => $resource) {
            $operations = $resource->getOperations();

            $internalPriority = -1;
            foreach ($operations as $operationName => $operation) {
                $parameters = $this->getDefaultParameters($operation, $resourceClass, $internalPriority);
                if (\count($parameters) > 0) {
                    $operations->add($operationName, $operation->withParameters($parameters));
                }
            }

            $resourceMetadataCollection[$i] = $resource->withOperations($operations->sort());

            if (!$graphQlOperations = $resource->getGraphQlOperations()) {
                continue;
            }

            $internalPriority = -1;
            foreach ($graphQlOperations as $operationName => $operation) {
                $parameters = $this->getDefaultParameters($operation, $resourceClass, $internalPriority);
                if (\count($parameters) > 0) {
                    $graphQlOperations[$operationName] = $operation->withParameters($parameters);
                }
            }

            $resourceMetadataCollection[$i] = $resource->withGraphQlOperations($graphQlOperations);
        }

        return $resourceMetadataCollection;
    }

    /**
     * @return array{propertyNames: string[], properties: array<string, ApiProperty>}
     */
    private function getProperties(string $resourceClass, ?Parameter $parameter = null): array
    {
        $k = $resourceClass.($parameter?->getProperties() ? ($parameter->getKey() ?? '') : '');
        if (isset($this->localPropertyCache[$k])) {
            return $this->localPropertyCache[$k];
        }

        $propertyNames = [];
        $properties = [];
        foreach ($parameter?->getProperties() ?? $this->propertyNameCollectionFactory->create($resourceClass) as $property) {
            $propertyMetadata = $this->propertyMetadataFactory->create($resourceClass, $property);
            if ($propertyMetadata->isReadable()) {
                $propertyNames[] = $property;
                $properties[$property] = $propertyMetadata;
            }
        }

        $this->localPropertyCache[$k] = ['propertyNames' => $propertyNames, 'properties' => $properties];

        return $this->localPropertyCache[$k];
    }

    private function getDefaultParameters(Operation $operation, string $resourceClass, int &$internalPriority): Parameters
    {
        $propertyNames = $properties = [];
        $parameters = $operation->getParameters() ?? new Parameters();
        foreach ($parameters as $key => $parameter) {
            ['propertyNames' => $propertyNames, 'properties' => $properties] = $this->getProperties($resourceClass, $parameter);
            if (null === $parameter->getProvider() && (($f = $parameter->getFilter()) && $f instanceof ParameterProviderFilterInterface)) {
                $parameters->add($key, $parameter->withProvider($f->getParameterProvider()));
            }

            if (':property' === $key) {
                foreach ($propertyNames as $property) {
                    $converted = $this->nameConverter?->denormalize($property) ?? $property;
                    $propertyParameter = $this->setDefaults($converted, $parameter, $resourceClass, $properties, $operation);
                    $priority = $propertyParameter->getPriority() ?? $internalPriority--;
                    $parameters->add($converted, $propertyParameter->withPriority($priority)->withKey($converted));
                }

                $parameters->remove($key, $parameter::class);
                continue;
            }

            $key = $parameter->getKey() ?? $key;

            if (str_contains($key, ':property') || ((($f = $parameter->getFilter()) && is_a($f, PropertiesAwareInterface::class, true)) || $parameter instanceof PropertiesAwareInterface)) {
                $p = [];
                foreach ($propertyNames as $prop) {
                    $p[$this->nameConverter?->denormalize($prop) ?? $prop] = $prop;
                }

                $parameter = $parameter->withExtraProperties($parameter->getExtraProperties() + ['_properties' => $p]);
            }

            $parameter = $this->setDefaults($key, $parameter, $resourceClass, $properties, $operation);
            // We don't do any type cast yet, a query parameter or an header is always a string or a list of strings
            if (null === $parameter->getNativeType()) {
                // this forces the type to be only a list
                if ('array' === ($parameter->getSchema()['type'] ?? null)) {
                    $parameter = $parameter->withNativeType(Type::list(Type::string()));
                } elseif ('string' === ($parameter->getSchema()['type'] ?? null)) {
                    $parameter = $parameter->withNativeType(Type::string());
                } else {
                    $parameter = $parameter->withNativeType(Type::union(Type::string(), Type::list(Type::string())));
                }
            }

            $priority = $parameter->getPriority() ?? $internalPriority--;
            $parameters->add($key, $parameter->withPriority($priority));
        }

        return $parameters;
    }

    private function addFilterMetadata(Parameter $parameter): Parameter
    {
        if (!($filterId = $parameter->getFilter())) {
            return $parameter;
        }

        if (!\is_object($filterId) && !$this->filterLocator->has($filterId)) {
            return $parameter;
        }

        $filter = \is_object($filterId) ? $filterId : $this->filterLocator->get($filterId);

        if ($filter instanceof ParameterProviderFilterInterface) {
            $parameter = $parameter->withProvider($filter::getParameterProvider());
        }

        if (!$filter) {
            return $parameter;
        }

        if (null === $parameter->getSchema() && $filter instanceof JsonSchemaFilterInterface && $schema = $filter->getSchema($parameter)) {
            $parameter = $parameter->withSchema($schema);
        }

        if (null === $parameter->getOpenApi() && $filter instanceof OpenApiParameterFilterInterface && ($openApiParameter = $filter->getOpenApiParameters($parameter))) {
            $parameter = $parameter->withOpenApi($openApiParameter);
        }

        return $parameter;
    }

    /**
     * @param array<string, ApiProperty> $properties
     */
    private function setDefaults(string $key, Parameter $parameter, string $resourceClass, array $properties, Operation $operation): Parameter
    {
        if (null === $parameter->getKey()) {
            $parameter = $parameter->withKey($key);
        }

        $filter = $parameter->getFilter();
        if (\is_string($filter) && $this->filterLocator->has($filter)) {
            $filter = $this->filterLocator->get($filter);
        }

        if ($filter instanceof SerializerFilterInterface && null === $parameter->getProvider()) {
            $parameter = $parameter->withProvider('api_platform.serializer.filter_parameter_provider');
        }
        $currentKey = $key;
        if (null === $parameter->getProperty() && isset($properties[$key])) {
            $parameter = $parameter->withProperty($key);
        }

        if (null === $parameter->getProperty() && $this->nameConverter && ($nameConvertedKey = $this->nameConverter->normalize($key)) && isset($properties[$nameConvertedKey])) {
            $parameter = $parameter->withProperty($key)->withExtraProperties(['_query_property' => $nameConvertedKey] + $parameter->getExtraProperties());
            $currentKey = $nameConvertedKey;
        }

        if ($this->nameConverter && $property = $parameter->getProperty()) {
            $parameter = $parameter->withProperty($this->nameConverter->normalize($property));
        }

        if (isset($properties[$currentKey]) && ($eloquentRelation = ($properties[$currentKey]->getExtraProperties()['eloquent_relation'] ?? null)) && isset($eloquentRelation['foreign_key'])) {
            $parameter = $parameter->withExtraProperties(['_query_property' => $eloquentRelation['foreign_key']] + $parameter->getExtraProperties());
        }

        $parameter = $this->addFilterMetadata($parameter);

        if ($filter instanceof FilterInterface) {
            try {
                return $this->getLegacyFilterMetadata($parameter, $operation, $filter);
            } catch (RuntimeException $exception) {
                $this->logger?->alert($exception->getMessage(), ['exception' => $exception]);

                return $parameter;
            }
        }

        return $parameter;
    }

    private function getLegacyFilterMetadata(Parameter $parameter, Operation $operation, FilterInterface $filter): Parameter
    {
        $description = $filter->getDescription($this->getStateOptionsClass($operation, $operation->getClass()));
        $key = $parameter->getKey();
        if (($schema = $description[$key]['schema'] ?? null) && null === $parameter->getSchema()) {
            $parameter = $parameter->withSchema($schema);
        }

        if (null === $parameter->getProperty() && ($property = $description[$key]['property'] ?? null)) {
            $parameter = $parameter->withProperty($property);
        }

        if (null === $parameter->getRequired() && ($required = $description[$key]['required'] ?? null)) {
            $parameter = $parameter->withRequired($required);
        }

        if (null === $parameter->getOpenApi() && ($openApi = $description[$key]['openapi'] ?? null) && $openApi instanceof OpenApiParameter) {
            $parameter = $parameter->withOpenApi($openApi);
        }

        return $parameter;
    }
}

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\Metadata\Resource\Factory;
15
16	use ApiPlatform\Metadata\ApiProperty;
17	use ApiPlatform\Metadata\Exception\RuntimeException;
18	use ApiPlatform\Metadata\FilterInterface;
19	use ApiPlatform\Metadata\JsonSchemaFilterInterface;
20	use ApiPlatform\Metadata\OpenApiParameterFilterInterface;
21	use ApiPlatform\Metadata\Operation;
22	use ApiPlatform\Metadata\Parameter;
23	use ApiPlatform\Metadata\ParameterProviderFilterInterface;
24	use ApiPlatform\Metadata\Parameters;
25	use ApiPlatform\Metadata\PropertiesAwareInterface;
26	use ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
27	use ApiPlatform\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
28	use ApiPlatform\Metadata\Resource\ResourceMetadataCollection;
29	use ApiPlatform\OpenApi\Model\Parameter as OpenApiParameter;
30	use ApiPlatform\Serializer\Filter\FilterInterface as SerializerFilterInterface;
31	use ApiPlatform\State\Util\StateOptionsTrait;
32	use Psr\Container\ContainerInterface;
33	use Psr\Log\LoggerInterface;
34	use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
35	use Symfony\Component\TypeInfo\Type;
36
37	/**
38	* Prepares Parameters documentation by reading its filter details and declaring an OpenApi parameter.
39	*
40	* @experimental
41	*/
42	final class ParameterResourceMetadataCollectionFactory implements ResourceMetadataCollectionFactoryInterface
43	{
44	use StateOptionsTrait;
45
46	private array $localPropertyCache;
47
48	public function __construct(
49	private readonly PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory,
50	private readonly PropertyMetadataFactoryInterface $propertyMetadataFactory,
51	private readonly ?ResourceMetadataCollectionFactoryInterface $decorated = null,
52	private readonly ?ContainerInterface $filterLocator = null,
53	private readonly ?NameConverterInterface $nameConverter = null,
54	private readonly ?LoggerInterface $logger = null,
55	) {
56	}	2,093✔
57
58	public function create(string $resourceClass): ResourceMetadataCollection
59	{
60	$resourceMetadataCollection = $this->decorated?->create($resourceClass) ?? new ResourceMetadataCollection($resourceClass);	141✔
61
62	foreach ($resourceMetadataCollection as $i => $resource) {	141✔
63	$operations = $resource->getOperations();	134✔
64
65	$internalPriority = -1;	134✔
66	foreach ($operations as $operationName => $operation) {	134✔
67	$parameters = $this->getDefaultParameters($operation, $resourceClass, $internalPriority);	134✔
68	if (\count($parameters) > 0) {	134✔
69	$operations->add($operationName, $operation->withParameters($parameters));	31✔
70	}
71	}
72
73	$resourceMetadataCollection[$i] = $resource->withOperations($operations->sort());	134✔
74
75	if (!$graphQlOperations = $resource->getGraphQlOperations()) {	134✔
76	continue;	60✔
77	}
78
79	$internalPriority = -1;	109✔
80	foreach ($graphQlOperations as $operationName => $operation) {	109✔
81	$parameters = $this->getDefaultParameters($operation, $resourceClass, $internalPriority);	109✔
82	if (\count($parameters) > 0) {	109✔
83	$graphQlOperations[$operationName] = $operation->withParameters($parameters);	4✔
84	}
85	}
86
87	$resourceMetadataCollection[$i] = $resource->withGraphQlOperations($graphQlOperations);	109✔
88	}
89
90	return $resourceMetadataCollection;	141✔
91	}
92
93	/**
94	* @return array{propertyNames: string[], properties: array<string, ApiProperty>}
95	*/
96	private function getProperties(string $resourceClass, ?Parameter $parameter = null): array
97	{
98	$k = $resourceClass.($parameter?->getProperties() ? ($parameter->getKey() ?? '') : '');	31✔
99	if (isset($this->localPropertyCache[$k])) {	31✔
100	return $this->localPropertyCache[$k];	27✔
101	}
102
103	$propertyNames = [];	31✔
104	$properties = [];	31✔
105	foreach ($parameter?->getProperties() ?? $this->propertyNameCollectionFactory->create($resourceClass) as $property) {	31✔
106	$propertyMetadata = $this->propertyMetadataFactory->create($resourceClass, $property);	27✔
107	if ($propertyMetadata->isReadable()) {	27✔
108	$propertyNames[] = $property;	27✔
109	$properties[$property] = $propertyMetadata;	27✔
110	}
111	}
112
113	$this->localPropertyCache[$k] = ['propertyNames' => $propertyNames, 'properties' => $properties];	31✔
114
115	return $this->localPropertyCache[$k];	31✔
116	}
117
118	private function getDefaultParameters(Operation $operation, string $resourceClass, int &$internalPriority): Parameters
119	{
120	$propertyNames = $properties = [];	134✔
121	$parameters = $operation->getParameters() ?? new Parameters();	134✔
122	foreach ($parameters as $key => $parameter) {	134✔
123	['propertyNames' => $propertyNames, 'properties' => $properties] = $this->getProperties($resourceClass, $parameter);	31✔
124	if (null === $parameter->getProvider() && (($f = $parameter->getFilter()) && $f instanceof ParameterProviderFilterInterface)) {	31✔
125	$parameters->add($key, $parameter->withProvider($f->getParameterProvider()));	×
126	}
127
128	if (':property' === $key) {	31✔
129	foreach ($propertyNames as $property) {	4✔
130	$converted = $this->nameConverter?->denormalize($property) ?? $property;	4✔
131	$propertyParameter = $this->setDefaults($converted, $parameter, $resourceClass, $properties, $operation);	4✔
132	$priority = $propertyParameter->getPriority() ?? $internalPriority--;	4✔
133	$parameters->add($converted, $propertyParameter->withPriority($priority)->withKey($converted));	4✔
134	}
135
136	$parameters->remove($key, $parameter::class);	4✔
137	continue;	4✔
138	}
139
140	$key = $parameter->getKey() ?? $key;	31✔
141
142	if (str_contains($key, ':property') \|\| ((($f = $parameter->getFilter()) && is_a($f, PropertiesAwareInterface::class, true)) \|\| $parameter instanceof PropertiesAwareInterface)) {	31✔
143	$p = [];	12✔
144	foreach ($propertyNames as $prop) {	12✔
145	$p[$this->nameConverter?->denormalize($prop) ?? $prop] = $prop;	10✔
146	}
147
148	$parameter = $parameter->withExtraProperties($parameter->getExtraProperties() + ['_properties' => $p]);	12✔
149	}
150
151	$parameter = $this->setDefaults($key, $parameter, $resourceClass, $properties, $operation);	31✔
152	// We don't do any type cast yet, a query parameter or an header is always a string or a list of strings
153	if (null === $parameter->getNativeType()) {	31✔
154	// this forces the type to be only a list
155	if ('array' === ($parameter->getSchema()['type'] ?? null)) {	27✔
156	$parameter = $parameter->withNativeType(Type::list(Type::string()));	4✔
157	} elseif ('string' === ($parameter->getSchema()['type'] ?? null)) {	27✔
158	$parameter = $parameter->withNativeType(Type::string());	15✔
159	} else {
160	$parameter = $parameter->withNativeType(Type::union(Type::string(), Type::list(Type::string())));	18✔
161	}
162	}
163
164	$priority = $parameter->getPriority() ?? $internalPriority--;	31✔
165	$parameters->add($key, $parameter->withPriority($priority));	31✔
166	}
167
168	return $parameters;	134✔
169	}
170
171	private function addFilterMetadata(Parameter $parameter): Parameter
172	{
173	if (!($filterId = $parameter->getFilter())) {	31✔
174	return $parameter;	14✔
175	}
176
177	if (!\is_object($filterId) && !$this->filterLocator->has($filterId)) {	23✔
178	return $parameter;	×
179	}
180
181	$filter = \is_object($filterId) ? $filterId : $this->filterLocator->get($filterId);	23✔
182
183	if ($filter instanceof ParameterProviderFilterInterface) {	23✔
184	$parameter = $parameter->withProvider($filter::getParameterProvider());	×
185	}
186
187	if (!$filter) {	23✔
188	return $parameter;	×
189	}
190
191	if (null === $parameter->getSchema() && $filter instanceof JsonSchemaFilterInterface && $schema = $filter->getSchema($parameter)) {	23✔
192	$parameter = $parameter->withSchema($schema);	21✔
193	}
194
195	if (null === $parameter->getOpenApi() && $filter instanceof OpenApiParameterFilterInterface && ($openApiParameter = $filter->getOpenApiParameters($parameter))) {	23✔
196	$parameter = $parameter->withOpenApi($openApiParameter);	13✔
197	}
198
199	return $parameter;	23✔
200	}
201
202	/**
203	* @param array<string, ApiProperty> $properties
204	*/
205	private function setDefaults(string $key, Parameter $parameter, string $resourceClass, array $properties, Operation $operation): Parameter
206	{
207	if (null === $parameter->getKey()) {	31✔
208	$parameter = $parameter->withKey($key);	31✔
209	}
210
211	$filter = $parameter->getFilter();	31✔
212	if (\is_string($filter) && $this->filterLocator->has($filter)) {	31✔
213	$filter = $this->filterLocator->get($filter);	9✔
214	}
215
216	if ($filter instanceof SerializerFilterInterface && null === $parameter->getProvider()) {	31✔
217	$parameter = $parameter->withProvider('api_platform.serializer.filter_parameter_provider');	4✔
218	}
219	$currentKey = $key;	31✔
220	if (null === $parameter->getProperty() && isset($properties[$key])) {	31✔
221	$parameter = $parameter->withProperty($key);	19✔
222	}
223
224	if (null === $parameter->getProperty() && $this->nameConverter && ($nameConvertedKey = $this->nameConverter->normalize($key)) && isset($properties[$nameConvertedKey])) {	31✔
225	$parameter = $parameter->withProperty($key)->withExtraProperties(['_query_property' => $nameConvertedKey] + $parameter->getExtraProperties());	×
226	$currentKey = $nameConvertedKey;	×
227	}
228
229	if ($this->nameConverter && $property = $parameter->getProperty()) {	31✔
230	$parameter = $parameter->withProperty($this->nameConverter->normalize($property));	23✔
231	}
232
233	if (isset($properties[$currentKey]) && ($eloquentRelation = ($properties[$currentKey]->getExtraProperties()['eloquent_relation'] ?? null)) && isset($eloquentRelation['foreign_key'])) {	31✔
234	$parameter = $parameter->withExtraProperties(['_query_property' => $eloquentRelation['foreign_key']] + $parameter->getExtraProperties());	×
235	}
236
237	$parameter = $this->addFilterMetadata($parameter);	31✔
238
239	if ($filter instanceof FilterInterface) {	31✔
240	try {
241	return $this->getLegacyFilterMetadata($parameter, $operation, $filter);	23✔
242	} catch (RuntimeException $exception) {	14✔
243	$this->logger?->alert($exception->getMessage(), ['exception' => $exception]);	14✔
244
245	return $parameter;	14✔
246	}
247	}
248
249	return $parameter;	14✔
250	}
251
252	private function getLegacyFilterMetadata(Parameter $parameter, Operation $operation, FilterInterface $filter): Parameter
253	{
254	$description = $filter->getDescription($this->getStateOptionsClass($operation, $operation->getClass()));	23✔
255	$key = $parameter->getKey();	11✔
256	if (($schema = $description[$key]['schema'] ?? null) && null === $parameter->getSchema()) {	11✔
257	$parameter = $parameter->withSchema($schema);	×
258	}
259
260	if (null === $parameter->getProperty() && ($property = $description[$key]['property'] ?? null)) {	11✔
261	$parameter = $parameter->withProperty($property);	×
262	}
263
264	if (null === $parameter->getRequired() && ($required = $description[$key]['required'] ?? null)) {	11✔
265	$parameter = $parameter->withRequired($required);	×
266	}
267
268	if (null === $parameter->getOpenApi() && ($openApi = $description[$key]['openapi'] ?? null) && $openApi instanceof OpenApiParameter) {	11✔
269	$parameter = $parameter->withOpenApi($openApi);	×
270	}
271
272	return $parameter;	11✔
273	}
274	}

api-platform / core / 15187574500

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