• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

api-platform / core / 15063570239

16 May 2025 07:56AM UTC coverage: 27.494% (-0.001%) from 27.495%
15063570239

push

github

web-flow
fix: error formats (#7148)

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

11139 existing lines in 371 files now uncovered.

13476 of 49015 relevant lines covered (27.49%)

74.77 hits per line

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

89.81
/src/Metadata/Resource/Factory/ParameterResourceMetadataCollectionFactory.php
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
    ) {
UNCOV
56
    }
2,083✔
57

58
    public function create(string $resourceClass): ResourceMetadataCollection
59
    {
UNCOV
60
        $resourceMetadataCollection = $this->decorated?->create($resourceClass) ?? new ResourceMetadataCollection($resourceClass);
141✔
61

UNCOV
62
        foreach ($resourceMetadataCollection as $i => $resource) {
141✔
UNCOV
63
            $operations = $resource->getOperations();
134✔
64

UNCOV
65
            $internalPriority = -1;
134✔
UNCOV
66
            foreach ($operations as $operationName => $operation) {
134✔
UNCOV
67
                $parameters = $this->getDefaultParameters($operation, $resourceClass, $internalPriority);
134✔
UNCOV
68
                if (\count($parameters) > 0) {
134✔
UNCOV
69
                    $operations->add($operationName, $operation->withParameters($parameters));
31✔
70
                }
71
            }
72

UNCOV
73
            $resourceMetadataCollection[$i] = $resource->withOperations($operations->sort());
134✔
74

UNCOV
75
            if (!$graphQlOperations = $resource->getGraphQlOperations()) {
134✔
UNCOV
76
                continue;
60✔
77
            }
78

UNCOV
79
            $internalPriority = -1;
109✔
UNCOV
80
            foreach ($graphQlOperations as $operationName => $operation) {
109✔
UNCOV
81
                $parameters = $this->getDefaultParameters($operation, $resourceClass, $internalPriority);
109✔
UNCOV
82
                if (\count($parameters) > 0) {
109✔
UNCOV
83
                    $graphQlOperations[$operationName] = $operation->withParameters($parameters);
4✔
84
                }
85
            }
86

UNCOV
87
            $resourceMetadataCollection[$i] = $resource->withGraphQlOperations($graphQlOperations);
109✔
88
        }
89

UNCOV
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
    {
UNCOV
98
        $k = $resourceClass.($parameter?->getProperties() ? ($parameter->getKey() ?? '') : '');
31✔
UNCOV
99
        if (isset($this->localPropertyCache[$k])) {
31✔
UNCOV
100
            return $this->localPropertyCache[$k];
27✔
101
        }
102

UNCOV
103
        $propertyNames = [];
31✔
UNCOV
104
        $properties = [];
31✔
UNCOV
105
        foreach ($parameter?->getProperties() ?? $this->propertyNameCollectionFactory->create($resourceClass) as $property) {
31✔
UNCOV
106
            $propertyMetadata = $this->propertyMetadataFactory->create($resourceClass, $property);
27✔
UNCOV
107
            if ($propertyMetadata->isReadable()) {
27✔
UNCOV
108
                $propertyNames[] = $property;
27✔
UNCOV
109
                $properties[$property] = $propertyMetadata;
27✔
110
            }
111
        }
112

UNCOV
113
        $this->localPropertyCache[$k] = ['propertyNames' => $propertyNames, 'properties' => $properties];
31✔
114

UNCOV
115
        return $this->localPropertyCache[$k];
31✔
116
    }
117

118
    private function getDefaultParameters(Operation $operation, string $resourceClass, int &$internalPriority): Parameters
119
    {
UNCOV
120
        $propertyNames = $properties = [];
134✔
UNCOV
121
        $parameters = $operation->getParameters() ?? new Parameters();
134✔
UNCOV
122
        foreach ($parameters as $key => $parameter) {
134✔
UNCOV
123
            ['propertyNames' => $propertyNames, 'properties' => $properties] = $this->getProperties($resourceClass, $parameter);
31✔
UNCOV
124
            if (null === $parameter->getProvider() && (($f = $parameter->getFilter()) && $f instanceof ParameterProviderFilterInterface)) {
31✔
125
                $parameters->add($key, $parameter->withProvider($f->getParameterProvider()));
×
126
            }
127

UNCOV
128
            if (':property' === $key) {
31✔
UNCOV
129
                foreach ($propertyNames as $property) {
4✔
UNCOV
130
                    $converted = $this->nameConverter?->denormalize($property) ?? $property;
4✔
UNCOV
131
                    $propertyParameter = $this->setDefaults($converted, $parameter, $resourceClass, $properties, $operation);
4✔
UNCOV
132
                    $priority = $propertyParameter->getPriority() ?? $internalPriority--;
4✔
UNCOV
133
                    $parameters->add($converted, $propertyParameter->withPriority($priority)->withKey($converted));
4✔
134
                }
135

UNCOV
136
                $parameters->remove($key, $parameter::class);
4✔
UNCOV
137
                continue;
4✔
138
            }
139

UNCOV
140
            $key = $parameter->getKey() ?? $key;
31✔
141

UNCOV
142
            if (str_contains($key, ':property') || ((($f = $parameter->getFilter()) && is_a($f, PropertiesAwareInterface::class, true)) || $parameter instanceof PropertiesAwareInterface)) {
31✔
UNCOV
143
                $p = [];
12✔
UNCOV
144
                foreach ($propertyNames as $prop) {
12✔
UNCOV
145
                    $p[$this->nameConverter?->denormalize($prop) ?? $prop] = $prop;
10✔
146
                }
147

UNCOV
148
                $parameter = $parameter->withExtraProperties($parameter->getExtraProperties() + ['_properties' => $p]);
12✔
149
            }
150

UNCOV
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
UNCOV
153
            if (null === $parameter->getNativeType()) {
31✔
154
                // this forces the type to be only a list
UNCOV
155
                if ('array' === ($parameter->getSchema()['type'] ?? null)) {
27✔
UNCOV
156
                    $parameter = $parameter->withNativeType(Type::list(Type::string()));
4✔
157
                } else {
UNCOV
158
                    $parameter = $parameter->withNativeType(Type::union(Type::string(), Type::list(Type::string())));
27✔
159
                }
160
            }
161

UNCOV
162
            $priority = $parameter->getPriority() ?? $internalPriority--;
31✔
UNCOV
163
            $parameters->add($key, $parameter->withPriority($priority));
31✔
164
        }
165

UNCOV
166
        return $parameters;
134✔
167
    }
168

169
    private function addFilterMetadata(Parameter $parameter): Parameter
170
    {
UNCOV
171
        if (!($filterId = $parameter->getFilter())) {
31✔
UNCOV
172
            return $parameter;
14✔
173
        }
174

UNCOV
175
        if (!\is_object($filterId) && !$this->filterLocator->has($filterId)) {
23✔
176
            return $parameter;
×
177
        }
178

UNCOV
179
        $filter = \is_object($filterId) ? $filterId : $this->filterLocator->get($filterId);
23✔
180

UNCOV
181
        if ($filter instanceof ParameterProviderFilterInterface) {
23✔
182
            $parameter = $parameter->withProvider($filter::getParameterProvider());
×
183
        }
184

UNCOV
185
        if (!$filter) {
23✔
186
            return $parameter;
×
187
        }
188

UNCOV
189
        if (null === $parameter->getSchema() && $filter instanceof JsonSchemaFilterInterface && $schema = $filter->getSchema($parameter)) {
23✔
UNCOV
190
            $parameter = $parameter->withSchema($schema);
21✔
191
        }
192

UNCOV
193
        if (null === $parameter->getOpenApi() && $filter instanceof OpenApiParameterFilterInterface && ($openApiParameter = $filter->getOpenApiParameters($parameter))) {
23✔
UNCOV
194
            $parameter = $parameter->withOpenApi($openApiParameter);
13✔
195
        }
196

UNCOV
197
        return $parameter;
23✔
198
    }
199

200
    /**
201
     * @param array<string, ApiProperty> $properties
202
     */
203
    private function setDefaults(string $key, Parameter $parameter, string $resourceClass, array $properties, Operation $operation): Parameter
204
    {
UNCOV
205
        if (null === $parameter->getKey()) {
31✔
UNCOV
206
            $parameter = $parameter->withKey($key);
31✔
207
        }
208

UNCOV
209
        $filter = $parameter->getFilter();
31✔
UNCOV
210
        if (\is_string($filter) && $this->filterLocator->has($filter)) {
31✔
UNCOV
211
            $filter = $this->filterLocator->get($filter);
9✔
212
        }
213

UNCOV
214
        if ($filter instanceof SerializerFilterInterface && null === $parameter->getProvider()) {
31✔
UNCOV
215
            $parameter = $parameter->withProvider('api_platform.serializer.filter_parameter_provider');
4✔
216
        }
UNCOV
217
        $currentKey = $key;
31✔
UNCOV
218
        if (null === $parameter->getProperty() && isset($properties[$key])) {
31✔
UNCOV
219
            $parameter = $parameter->withProperty($key);
19✔
220
        }
221

UNCOV
222
        if (null === $parameter->getProperty() && $this->nameConverter && ($nameConvertedKey = $this->nameConverter->normalize($key)) && isset($properties[$nameConvertedKey])) {
31✔
223
            $parameter = $parameter->withProperty($key)->withExtraProperties(['_query_property' => $nameConvertedKey] + $parameter->getExtraProperties());
×
224
            $currentKey = $nameConvertedKey;
×
225
        }
226

UNCOV
227
        if ($this->nameConverter && $property = $parameter->getProperty()) {
31✔
UNCOV
228
            $parameter = $parameter->withProperty($this->nameConverter->normalize($property));
23✔
229
        }
230

UNCOV
231
        if (isset($properties[$currentKey]) && ($eloquentRelation = ($properties[$currentKey]->getExtraProperties()['eloquent_relation'] ?? null)) && isset($eloquentRelation['foreign_key'])) {
31✔
232
            $parameter = $parameter->withExtraProperties(['_query_property' => $eloquentRelation['foreign_key']] + $parameter->getExtraProperties());
×
233
        }
234

UNCOV
235
        $parameter = $this->addFilterMetadata($parameter);
31✔
236

UNCOV
237
        if ($filter instanceof FilterInterface) {
31✔
238
            try {
UNCOV
239
                return $this->getLegacyFilterMetadata($parameter, $operation, $filter);
23✔
UNCOV
240
            } catch (RuntimeException $exception) {
14✔
UNCOV
241
                $this->logger?->alert($exception->getMessage(), ['exception' => $exception]);
14✔
242

UNCOV
243
                return $parameter;
14✔
244
            }
245
        }
246

UNCOV
247
        return $parameter;
14✔
248
    }
249

250
    private function getLegacyFilterMetadata(Parameter $parameter, Operation $operation, FilterInterface $filter): Parameter
251
    {
UNCOV
252
        $description = $filter->getDescription($this->getStateOptionsClass($operation, $operation->getClass()));
23✔
UNCOV
253
        $key = $parameter->getKey();
11✔
UNCOV
254
        if (($schema = $description[$key]['schema'] ?? null) && null === $parameter->getSchema()) {
11✔
255
            $parameter = $parameter->withSchema($schema);
×
256
        }
257

UNCOV
258
        if (null === $parameter->getProperty() && ($property = $description[$key]['property'] ?? null)) {
11✔
259
            $parameter = $parameter->withProperty($property);
×
260
        }
261

UNCOV
262
        if (null === $parameter->getRequired() && ($required = $description[$key]['required'] ?? null)) {
11✔
263
            $parameter = $parameter->withRequired($required);
×
264
        }
265

UNCOV
266
        if (null === $parameter->getOpenApi() && ($openApi = $description[$key]['openapi'] ?? null) && $openApi instanceof OpenApiParameter) {
11✔
267
            $parameter = $parameter->withOpenApi($openApi);
×
268
        }
269

UNCOV
270
        return $parameter;
11✔
271
    }
272
}
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2025 Coveralls, Inc