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

api-platform / core / 13175309672

06 Feb 2025 09:04AM UTC coverage: 7.663% (-0.2%) from 7.841%
13175309672

push

github

web-flow
fix: ensure template files have a tpl file extension (#6826) (#6829)

2 of 5 new or added lines in 4 files covered. (40.0%)

3676 existing lines in 122 files now uncovered.

13073 of 170593 relevant lines covered (7.66%)

27.3 hits per line

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

94.87
/src/GraphQl/Type/TypeBuilder.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\GraphQl\Type;
15

16
use ApiPlatform\GraphQl\Serializer\ItemNormalizer;
17
use ApiPlatform\Metadata\ApiProperty;
18
use ApiPlatform\Metadata\CollectionOperationInterface;
19
use ApiPlatform\Metadata\Exception\OperationNotFoundException;
20
use ApiPlatform\Metadata\GraphQl\Mutation;
21
use ApiPlatform\Metadata\GraphQl\Operation;
22
use ApiPlatform\Metadata\GraphQl\Query;
23
use ApiPlatform\Metadata\GraphQl\Subscription;
24
use ApiPlatform\Metadata\Resource\ResourceMetadataCollection;
25
use ApiPlatform\State\Pagination\Pagination;
26
use GraphQL\Type\Definition\EnumType;
27
use GraphQL\Type\Definition\InputObjectType;
28
use GraphQL\Type\Definition\InterfaceType;
29
use GraphQL\Type\Definition\NonNull;
30
use GraphQL\Type\Definition\ObjectType;
31
use GraphQL\Type\Definition\Type as GraphQLType;
32
use Psr\Container\ContainerInterface;
33
use Symfony\Component\PropertyInfo\Type;
34

35
/**
36
 * Builds the GraphQL types.
37
 *
38
 * @author Alan Poulain <contact@alanpoulain.eu>
39
 */
40
final class TypeBuilder implements ContextAwareTypeBuilderInterface
41
{
42
    private $defaultFieldResolver;
43

44
    public function __construct(private readonly TypesContainerInterface $typesContainer, callable $defaultFieldResolver, private ?ContainerInterface $fieldsBuilderLocator, private readonly Pagination $pagination)
45
    {
46
        $this->fieldsBuilderLocator = $fieldsBuilderLocator;
444✔
47
        $this->defaultFieldResolver = $defaultFieldResolver;
444✔
48
    }
49

50
    public function setFieldsBuilderLocator(ContainerInterface $fieldsBuilderLocator): void
51
    {
52
        $this->fieldsBuilderLocator = $fieldsBuilderLocator;
×
53
    }
54

55
    /**
56
     * {@inheritdoc}
57
     */
58
    public function getResourceObjectType(ResourceMetadataCollection $resourceMetadataCollection, Operation $operation, ?ApiProperty $propertyMetadata = null, array $context = []): GraphQLType
59
    {
60
        $shortName = $operation->getShortName();
438✔
61
        $operationName = $operation->getName();
438✔
62
        $input = $context['input'];
438✔
63
        $depth = $context['depth'] ?? 0;
438✔
64
        $wrapped = $context['wrapped'] ?? false;
438✔
65

66
        if ($operation instanceof Mutation) {
438✔
67
            $shortName = $operationName.ucfirst($shortName);
414✔
68
        }
69

70
        if ($operation instanceof Subscription) {
438✔
71
            $shortName = $operationName.ucfirst($shortName).'Subscription';
411✔
72
        }
73

74
        if ($input) {
438✔
75
            if ($depth > 0) {
414✔
76
                $shortName .= 'Nested';
18✔
77
            }
78
            $shortName .= 'Input';
414✔
79
        } elseif ($operation instanceof Mutation || $operation instanceof Subscription) {
438✔
80
            if ($depth > 0) {
414✔
81
                $shortName .= 'Nested';
12✔
82
            }
83
            $shortName .= 'Payload';
414✔
84
        }
85

86
        if ('item_query' === $operationName || 'collection_query' === $operationName) {
438✔
87
            // Test if the collection/item has different groups
88
            if ($resourceMetadataCollection->getOperation($operation instanceof CollectionOperationInterface ? 'item_query' : 'collection_query')->getNormalizationContext() !== $operation->getNormalizationContext()) {
438✔
89
                $shortName .= $operation instanceof CollectionOperationInterface ? 'Collection' : 'Item';
411✔
90
            }
91
        }
92

93
        if ($wrapped && ($operation instanceof Mutation || $operation instanceof Subscription)) {
438✔
94
            $shortName .= 'Data';
30✔
95
        }
96

97
        $resourceObjectType = null;
438✔
98
        if (!$this->typesContainer->has($shortName)) {
438✔
99
            $resourceObjectType = $this->getResourceObjectTypeConfiguration($shortName, $resourceMetadataCollection, $operation, $context);
438✔
100
            $this->typesContainer->set($shortName, $resourceObjectType);
438✔
101
        }
102

103
        $resourceObjectType = $resourceObjectType ?? $this->typesContainer->get($shortName);
438✔
104
        if (!($resourceObjectType instanceof ObjectType || $resourceObjectType instanceof NonNull || $resourceObjectType instanceof InputObjectType)) {
438✔
105
            throw new \LogicException(\sprintf('Expected GraphQL type "%s" to be %s.', $shortName, implode('|', [ObjectType::class, NonNull::class, InputObjectType::class])));
×
106
        }
107

108
        $required = $propertyMetadata?->isRequired() ?? true;
438✔
109
        if ($required && $input) {
438✔
110
            $resourceObjectType = GraphQLType::nonNull($resourceObjectType);
414✔
111
        }
112

113
        return $resourceObjectType;
438✔
114
    }
115

116
    /**
117
     * {@inheritdoc}
118
     */
119
    public function getNodeInterface(): InterfaceType
120
    {
121
        if ($this->typesContainer->has('Node')) {
438✔
122
            $nodeInterface = $this->typesContainer->get('Node');
438✔
123
            if (!$nodeInterface instanceof InterfaceType) {
438✔
124
                throw new \LogicException(\sprintf('Expected GraphQL type "Node" to be %s.', InterfaceType::class));
×
125
            }
126

127
            return $nodeInterface;
438✔
128
        }
129

130
        $nodeInterface = new InterfaceType([
438✔
131
            'name' => 'Node',
438✔
132
            'description' => 'A node, according to the Relay specification.',
438✔
133
            'fields' => [
438✔
134
                'id' => [
438✔
135
                    'type' => GraphQLType::nonNull(GraphQLType::id()),
438✔
136
                    'description' => 'The id of this node.',
438✔
137
                ],
438✔
138
            ],
438✔
139
            'resolveType' => function ($value): ?GraphQLType {
438✔
140
                if (!isset($value[ItemNormalizer::ITEM_RESOURCE_CLASS_KEY])) {
3✔
141
                    return null;
×
142
                }
143

144
                $shortName = (new \ReflectionClass($value[ItemNormalizer::ITEM_RESOURCE_CLASS_KEY]))->getShortName();
3✔
145

146
                return $this->typesContainer->has($shortName) ? $this->typesContainer->get($shortName) : null;
3✔
147
            },
438✔
148
        ]);
438✔
149

150
        $this->typesContainer->set('Node', $nodeInterface);
438✔
151

152
        return $nodeInterface;
438✔
153
    }
154

155
    /**
156
     * {@inheritdoc}
157
     */
158
    public function getResourcePaginatedCollectionType(GraphQLType $resourceType, string $resourceClass, Operation $operation): GraphQLType
159
    {
160
        @trigger_error('Using getResourcePaginatedCollectionType method of TypeBuilder is deprecated since API Platform 3.1. Use getPaginatedCollectionType method instead.', \E_USER_DEPRECATED);
×
161

162
        return $this->getPaginatedCollectionType($resourceType, $operation);
×
163
    }
164

165
    /**
166
     * {@inheritdoc}
167
     */
168
    public function getPaginatedCollectionType(GraphQLType $resourceType, Operation $operation): GraphQLType
169
    {
170
        $namedType = GraphQLType::getNamedType($resourceType);
417✔
171
        // graphql-php 15: name() exists
172
        $shortName = method_exists($namedType, 'name') ? $namedType->name() : $namedType->name;
417✔
173
        $paginationType = $this->pagination->getGraphQlPaginationType($operation);
417✔
174

175
        $connectionTypeKey = \sprintf('%s%sConnection', $shortName, ucfirst($paginationType));
417✔
176
        if ($this->typesContainer->has($connectionTypeKey)) {
417✔
177
            return $this->typesContainer->get($connectionTypeKey);
411✔
178
        }
179

180
        $fields = 'cursor' === $paginationType ?
417✔
181
            $this->getCursorBasedPaginationFields($resourceType) :
417✔
182
            $this->getPageBasedPaginationFields($resourceType);
411✔
183

184
        $configuration = [
417✔
185
            'name' => $connectionTypeKey,
417✔
186
            'description' => \sprintf("%s connection for $shortName.", ucfirst($paginationType)),
417✔
187
            'fields' => $fields,
417✔
188
        ];
417✔
189

190
        $resourcePaginatedCollectionType = new ObjectType($configuration);
417✔
191
        $this->typesContainer->set($connectionTypeKey, $resourcePaginatedCollectionType);
417✔
192

193
        return $resourcePaginatedCollectionType;
417✔
194
    }
195

196
    public function getEnumType(Operation $operation): GraphQLType
197
    {
198
        $enumName = $operation->getShortName();
16✔
199

200
        if ($this->typesContainer->has($enumName)) {
16✔
201
            return $this->typesContainer->get($enumName);
10✔
202
        }
203

204
        /** @var FieldsBuilderEnumInterface $fieldsBuilder */
205
        $fieldsBuilder = $this->fieldsBuilderLocator->get('api_platform.graphql.fields_builder');
16✔
206
        $enumCases = [];
16✔
207
        $enumCases = $fieldsBuilder->getEnumFields($operation->getClass());
16✔
208

209
        $enumConfig = [
16✔
210
            'name' => $enumName,
16✔
211
            'values' => $enumCases,
16✔
212
        ];
16✔
213
        if ($enumDescription = $operation->getDescription()) {
16✔
214
            $enumConfig['description'] = $enumDescription;
×
215
        }
216

217
        $enumType = new EnumType($enumConfig);
16✔
218
        $this->typesContainer->set($enumName, $enumType);
16✔
219

220
        return $enumType;
16✔
221
    }
222

223
    /**
224
     * {@inheritdoc}
225
     */
226
    public function isCollection(Type $type): bool
227
    {
228
        return $type->isCollection() && ($collectionValueType = $type->getCollectionValueTypes()[0] ?? null) && null !== $collectionValueType->getClassName();
438✔
229
    }
230

231
    private function getCursorBasedPaginationFields(GraphQLType $resourceType): array
232
    {
233
        $namedType = GraphQLType::getNamedType($resourceType);
417✔
234
        // graphql-php 15: name() exists
235
        $shortName = method_exists($namedType, 'name') ? $namedType->name() : $namedType->name;
417✔
236

237
        $edgeObjectTypeConfiguration = [
417✔
238
            'name' => "{$shortName}Edge",
417✔
239
            'description' => "Edge of $shortName.",
417✔
240
            'fields' => [
417✔
241
                'node' => $resourceType,
417✔
242
                'cursor' => GraphQLType::nonNull(GraphQLType::string()),
417✔
243
            ],
417✔
244
        ];
417✔
245
        $edgeObjectType = new ObjectType($edgeObjectTypeConfiguration);
417✔
246
        $this->typesContainer->set("{$shortName}Edge", $edgeObjectType);
417✔
247

248
        $pageInfoObjectTypeConfiguration = [
417✔
249
            'name' => "{$shortName}PageInfo",
417✔
250
            'description' => 'Information about the current page.',
417✔
251
            'fields' => [
417✔
252
                'endCursor' => GraphQLType::string(),
417✔
253
                'startCursor' => GraphQLType::string(),
417✔
254
                'hasNextPage' => GraphQLType::nonNull(GraphQLType::boolean()),
417✔
255
                'hasPreviousPage' => GraphQLType::nonNull(GraphQLType::boolean()),
417✔
256
            ],
417✔
257
        ];
417✔
258
        $pageInfoObjectType = new ObjectType($pageInfoObjectTypeConfiguration);
417✔
259
        $this->typesContainer->set("{$shortName}PageInfo", $pageInfoObjectType);
417✔
260

261
        return [
417✔
262
            'edges' => GraphQLType::listOf($edgeObjectType),
417✔
263
            'pageInfo' => GraphQLType::nonNull($pageInfoObjectType),
417✔
264
            'totalCount' => GraphQLType::nonNull(GraphQLType::int()),
417✔
265
        ];
417✔
266
    }
267

268
    private function getPageBasedPaginationFields(GraphQLType $resourceType): array
269
    {
270
        $namedType = GraphQLType::getNamedType($resourceType);
411✔
271
        // graphql-php 15: name() exists
272
        $shortName = method_exists($namedType, 'name') ? $namedType->name() : $namedType->name;
411✔
273

274
        $paginationInfoObjectTypeConfiguration = [
411✔
275
            'name' => "{$shortName}PaginationInfo",
411✔
276
            'description' => 'Information about the pagination.',
411✔
277
            'fields' => [
411✔
278
                'itemsPerPage' => GraphQLType::nonNull(GraphQLType::int()),
411✔
279
                'lastPage' => GraphQLType::nonNull(GraphQLType::int()),
411✔
280
                'totalCount' => GraphQLType::nonNull(GraphQLType::int()),
411✔
281
                'currentPage' => GraphQLType::nonNull(GraphQLType::int()),
411✔
282
                'hasNextPage' => GraphQLType::nonNull(GraphQLType::boolean()),
411✔
283
            ],
411✔
284
        ];
411✔
285
        $paginationInfoObjectType = new ObjectType($paginationInfoObjectTypeConfiguration);
411✔
286
        $this->typesContainer->set("{$shortName}PaginationInfo", $paginationInfoObjectType);
411✔
287

288
        return [
411✔
289
            'collection' => GraphQLType::listOf($resourceType),
411✔
290
            'paginationInfo' => GraphQLType::nonNull($paginationInfoObjectType),
411✔
291
        ];
411✔
292
    }
293

294
    private function getQueryOperation(ResourceMetadataCollection $resourceMetadataCollection): ?Operation
295
    {
296
        foreach ($resourceMetadataCollection as $resourceMetadata) {
131✔
297
            foreach ($resourceMetadata->getGraphQlOperations() as $operation) {
131✔
298
                // Filter the custom queries.
299
                if ($operation instanceof Query && !$operation->getResolver()) {
131✔
300
                    return $operation;
131✔
301
                }
302
            }
303
        }
304

UNCOV
305
        return null;
×
306
    }
307

308
    private function getResourceObjectTypeConfiguration(string $shortName, ResourceMetadataCollection $resourceMetadataCollection, Operation $operation, array $context = []): InputObjectType|ObjectType
309
    {
310
        $operationName = $operation->getName();
438✔
311
        $resourceClass = $operation->getClass();
438✔
312
        $input = $context['input'];
438✔
313
        $depth = $context['depth'] ?? 0;
438✔
314
        $wrapped = $context['wrapped'] ?? false;
438✔
315

316
        $ioMetadata = $input ? $operation->getInput() : $operation->getOutput();
438✔
317
        if (null !== $ioMetadata && \array_key_exists('class', $ioMetadata) && null !== $ioMetadata['class']) {
438✔
318
            $resourceClass = $ioMetadata['class'];
411✔
319
        }
320

321
        $wrapData = !$wrapped && ($operation instanceof Mutation || $operation instanceof Subscription) && !$input && $depth < 1;
438✔
322

323
        $configuration = [
438✔
324
            'name' => $shortName,
438✔
325
            'description' => $operation->getDescription(),
438✔
326
            'resolveField' => $this->defaultFieldResolver,
438✔
327
            'fields' => function () use ($resourceClass, $operation, $operationName, $resourceMetadataCollection, $input, $wrapData, $depth, $ioMetadata) {
438✔
328
                if ($wrapData) {
420✔
329
                    $queryNormalizationContext = $this->getQueryOperation($resourceMetadataCollection)?->getNormalizationContext() ?? [];
131✔
330

331
                    try {
332
                        $mutationNormalizationContext = $operation instanceof Mutation || $operation instanceof Subscription ? ($resourceMetadataCollection->getOperation($operationName)->getNormalizationContext() ?? []) : [];
131✔
333
                    } catch (OperationNotFoundException) {
×
UNCOV
334
                        $mutationNormalizationContext = [];
×
335
                    }
336
                    // Use a new type for the wrapped object only if there is a specific normalization context for the mutation or the subscription.
337
                    // If not, use the query type in order to ensure the client cache could be used.
338
                    $useWrappedType = $queryNormalizationContext !== $mutationNormalizationContext;
131✔
339

340
                    $wrappedOperationName = $operationName;
131✔
341

342
                    if (!$useWrappedType) {
131✔
343
                        $wrappedOperationName = $operation instanceof Query ? $operationName : 'item_query';
107✔
344
                    }
345

346
                    $wrappedOperation = $resourceMetadataCollection->getOperation($wrappedOperationName);
131✔
347

348
                    $fields = [
131✔
349
                        lcfirst($wrappedOperation->getShortName()) => $this->getResourceObjectType($resourceMetadataCollection, $wrappedOperation instanceof Operation ? $wrappedOperation : null, null, [
131✔
350
                            'input' => $input,
131✔
351
                            'wrapped' => true,
131✔
352
                            'depth' => $depth,
131✔
353
                        ]),
131✔
354
                    ];
131✔
355

356
                    if ($operation instanceof Subscription) {
131✔
357
                        $fields['clientSubscriptionId'] = GraphQLType::string();
9✔
358
                        if ($operation->getMercure()) {
9✔
359
                            $fields['mercureUrl'] = GraphQLType::string();
9✔
360
                        }
361

362
                        return $fields;
9✔
363
                    }
364

365
                    return $fields + ['clientMutationId' => GraphQLType::string()];
128✔
366
                }
367

368
                $fieldsBuilder = $this->fieldsBuilderLocator->get('api_platform.graphql.fields_builder');
420✔
369
                $fields = $fieldsBuilder->getResourceObjectTypeFields($resourceClass, $operation, $input, $depth, $ioMetadata);
420✔
370

371
                if ($input && $operation instanceof Mutation && null !== $mutationArgs = $operation->getArgs()) {
420✔
372
                    return $fieldsBuilder->resolveResourceArgs($mutationArgs, $operation) + ['clientMutationId' => $fields['clientMutationId']];
15✔
373
                }
374
                if ($input && $operation instanceof Mutation && null !== $extraMutationArgs = $operation->getExtraArgs()) {
420✔
375
                    return $fields + $fieldsBuilder->resolveResourceArgs($extraMutationArgs, $operation);
18✔
376
                }
377

378
                return $fields;
420✔
379
            },
438✔
380
            'interfaces' => $wrapData ? [] : [$this->getNodeInterface()],
438✔
381
        ];
438✔
382

383
        return $input ? new InputObjectType($configuration) : new ObjectType($configuration);
438✔
384
    }
385
}
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

© 2026 Coveralls, Inc