-
-
Notifications
You must be signed in to change notification settings - Fork 574
Expand file tree
/
Copy pathIntrospection.php
More file actions
834 lines (788 loc) · 34.5 KB
/
Introspection.php
File metadata and controls
834 lines (788 loc) · 34.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
<?php declare(strict_types=1);
namespace GraphQL\Type;
use GraphQL\Error\InvariantViolation;
use GraphQL\GraphQL;
use GraphQL\Language\DirectiveLocation;
use GraphQL\Language\Printer;
use GraphQL\Type\Definition\Argument;
use GraphQL\Type\Definition\Directive;
use GraphQL\Type\Definition\EnumType;
use GraphQL\Type\Definition\EnumValueDefinition;
use GraphQL\Type\Definition\FieldDefinition;
use GraphQL\Type\Definition\InputObjectField;
use GraphQL\Type\Definition\InputObjectType;
use GraphQL\Type\Definition\InterfaceType;
use GraphQL\Type\Definition\ListOfType;
use GraphQL\Type\Definition\NamedType;
use GraphQL\Type\Definition\NonNull;
use GraphQL\Type\Definition\ObjectType;
use GraphQL\Type\Definition\ResolveInfo;
use GraphQL\Type\Definition\ScalarType;
use GraphQL\Type\Definition\Type;
use GraphQL\Type\Definition\UnionType;
use GraphQL\Type\Definition\WrappingType;
use GraphQL\Utils\AST;
use GraphQL\Utils\Utils;
/**
* @phpstan-type IntrospectionOptions array{
* descriptions?: bool,
* directiveIsRepeatable?: bool,
* schemaDescription?: bool,
* typeIsOneOf?: bool,
* }
*
* Available options:
* - descriptions
* Include descriptions in the introspection result?
* Default: true
* - directiveIsRepeatable
* Include field `isRepeatable` for directives?
* Default: false
* - typeIsOneOf
* Include field `isOneOf` for types?
* Default: false
*
* @see \GraphQL\Tests\Type\IntrospectionTest
*/
class Introspection
{
public const SCHEMA_FIELD_NAME = '__schema';
public const TYPE_FIELD_NAME = '__type';
public const TYPE_NAME_FIELD_NAME = '__typename';
public const SCHEMA_OBJECT_NAME = '__Schema';
public const TYPE_OBJECT_NAME = '__Type';
public const DIRECTIVE_OBJECT_NAME = '__Directive';
public const FIELD_OBJECT_NAME = '__Field';
public const INPUT_VALUE_OBJECT_NAME = '__InputValue';
public const ENUM_VALUE_OBJECT_NAME = '__EnumValue';
public const TYPE_KIND_ENUM_NAME = '__TypeKind';
public const DIRECTIVE_LOCATION_ENUM_NAME = '__DirectiveLocation';
public const TYPE_NAMES = [
self::SCHEMA_OBJECT_NAME,
self::TYPE_OBJECT_NAME,
self::DIRECTIVE_OBJECT_NAME,
self::FIELD_OBJECT_NAME,
self::INPUT_VALUE_OBJECT_NAME,
self::ENUM_VALUE_OBJECT_NAME,
self::TYPE_KIND_ENUM_NAME,
self::DIRECTIVE_LOCATION_ENUM_NAME,
];
/** @var array<string, mixed>|null */
protected static ?array $cachedInstances;
/**
* @param IntrospectionOptions $options
*
* @api
*/
public static function getIntrospectionQuery(array $options = []): string
{
$optionsWithDefaults = array_merge([
'descriptions' => true,
'directiveIsRepeatable' => false,
'schemaDescription' => false,
'typeIsOneOf' => false,
], $options);
$descriptions = $optionsWithDefaults['descriptions']
? 'description'
: '';
$directiveIsRepeatable = $optionsWithDefaults['directiveIsRepeatable']
? 'isRepeatable'
: '';
$schemaDescription = $optionsWithDefaults['schemaDescription']
? $descriptions
: '';
$typeIsOneOf = $optionsWithDefaults['typeIsOneOf']
? 'isOneOf'
: '';
return <<<GRAPHQL
query IntrospectionQuery {
__schema {
{$schemaDescription}
queryType { name }
mutationType { name }
subscriptionType { name }
types {
...FullType
}
directives {
name
{$descriptions}
args(includeDeprecated: true) {
...InputValue
}
{$directiveIsRepeatable}
locations
}
}
}
fragment FullType on __Type {
kind
name
{$descriptions}
{$typeIsOneOf}
fields(includeDeprecated: true) {
name
{$descriptions}
args(includeDeprecated: true) {
...InputValue
}
type {
...TypeRef
}
isDeprecated
deprecationReason
}
inputFields(includeDeprecated: true) {
...InputValue
}
interfaces {
...TypeRef
}
enumValues(includeDeprecated: true) {
name
{$descriptions}
isDeprecated
deprecationReason
}
possibleTypes {
...TypeRef
}
}
fragment InputValue on __InputValue {
name
{$descriptions}
type { ...TypeRef }
defaultValue
isDeprecated
deprecationReason
}
fragment TypeRef on __Type {
kind
name
ofType {
kind
name
ofType {
kind
name
ofType {
kind
name
ofType {
kind
name
ofType {
kind
name
ofType {
kind
name
ofType {
kind
name
}
}
}
}
}
}
}
}
GRAPHQL;
}
/**
* Build an introspection query from a Schema.
*
* Introspection is useful for utilities that care about type and field
* relationships, but do not need to traverse through those relationships.
*
* This is the inverse of BuildClientSchema::build(). The primary use case is
* outside the server context, for instance when doing schema comparisons.
*
* @param IntrospectionOptions $options
*
* @throws \Exception
* @throws \JsonException
* @throws InvariantViolation
*
* @return array<string, array<mixed>>
*
* @api
*/
public static function fromSchema(Schema $schema, array $options = []): array
{
$optionsWithDefaults = array_merge([
'directiveIsRepeatable' => true,
'schemaDescription' => true,
'typeIsOneOf' => true,
], $options);
$result = GraphQL::executeQuery(
$schema,
self::getIntrospectionQuery($optionsWithDefaults)
);
$data = $result->data;
if ($data === null) {
$noDataResult = Utils::printSafeJson($result);
throw new InvariantViolation("Introspection query returned no data: {$noDataResult}.");
}
return $data;
}
/** @param Type&NamedType $type */
public static function isIntrospectionType(NamedType $type): bool
{
return in_array($type->name, self::TYPE_NAMES, true);
}
/** @return array<string, Type&NamedType> */
public static function getTypes(): array
{
return [
self::SCHEMA_OBJECT_NAME => self::_schema(),
self::TYPE_OBJECT_NAME => self::_type(),
self::DIRECTIVE_OBJECT_NAME => self::_directive(),
self::FIELD_OBJECT_NAME => self::_field(),
self::INPUT_VALUE_OBJECT_NAME => self::_inputValue(),
self::ENUM_VALUE_OBJECT_NAME => self::_enumValue(),
self::TYPE_KIND_ENUM_NAME => self::_typeKind(),
self::DIRECTIVE_LOCATION_ENUM_NAME => self::_directiveLocation(),
];
}
public static function _schema(): ObjectType
{
return self::$cachedInstances[self::SCHEMA_OBJECT_NAME] ??= new ObjectType([ // @phpstan-ignore missingType.checkedException (static configuration is known to be correct)
'name' => self::SCHEMA_OBJECT_NAME,
'isIntrospection' => true,
'description' => 'A GraphQL Schema defines the capabilities of a GraphQL '
. 'server. It exposes all available types and directives on '
. 'the server, as well as the entry points for query, mutation, and '
. 'subscription operations.',
'fields' => [
'description' => [
'type' => Type::string(),
'resolve' => static fn (Schema $schema): ?string => $schema->description,
],
'types' => [
'description' => 'A list of all types supported by this server.',
'type' => new NonNull(new ListOfType(new NonNull(self::_type()))),
'resolve' => static fn (Schema $schema): array => $schema->getTypeMap(),
],
'queryType' => [
'description' => 'The type that query operations will be rooted at.',
'type' => new NonNull(self::_type()),
'resolve' => static fn (Schema $schema): ?ObjectType => $schema->getQueryType(),
],
'mutationType' => [
'description' => 'If this server supports mutation, the type that mutation operations will be rooted at.',
'type' => self::_type(),
'resolve' => static fn (Schema $schema): ?ObjectType => $schema->getMutationType(),
],
'subscriptionType' => [
'description' => 'If this server support subscription, the type that subscription operations will be rooted at.',
'type' => self::_type(),
'resolve' => static fn (Schema $schema): ?ObjectType => $schema->getSubscriptionType(),
],
'directives' => [
'description' => 'A list of all directives supported by this server.',
'type' => Type::nonNull(Type::listOf(Type::nonNull(self::_directive()))),
'resolve' => static fn (Schema $schema): array => $schema->getDirectives(),
],
],
]);
}
public static function _type(): ObjectType
{
return self::$cachedInstances[self::TYPE_OBJECT_NAME] ??= new ObjectType([ // @phpstan-ignore missingType.checkedException (static configuration is known to be correct)
'name' => self::TYPE_OBJECT_NAME,
'isIntrospection' => true,
'description' => 'The fundamental unit of any GraphQL Schema is the type. There are '
. 'many kinds of types in GraphQL as represented by the `__TypeKind` enum.'
. "\n\n"
. 'Depending on the kind of a type, certain fields describe '
. 'information about that type. Scalar types provide no information '
. 'beyond a name and description, while Enum types provide their values. '
. 'Object and Interface types provide the fields they describe. Abstract '
. 'types, Union and Interface, provide the Object types possible '
. 'at runtime. List and NonNull types compose other types.',
'fields' => static fn (): array => [
'kind' => [
'type' => Type::nonNull(self::_typeKind()),
'resolve' => static function (Type $type): string {
switch (true) {
case $type instanceof ListOfType:
return TypeKind::LIST;
case $type instanceof NonNull:
return TypeKind::NON_NULL;
case $type instanceof ScalarType:
return TypeKind::SCALAR;
case $type instanceof ObjectType:
return TypeKind::OBJECT;
case $type instanceof EnumType:
return TypeKind::ENUM;
case $type instanceof InputObjectType:
return TypeKind::INPUT_OBJECT;
case $type instanceof InterfaceType:
return TypeKind::INTERFACE;
case $type instanceof UnionType:
return TypeKind::UNION;
default:
$safeType = Utils::printSafe($type);
throw new \Exception("Unknown kind of type: {$safeType}");
}
},
],
'name' => [
'type' => Type::string(),
'resolve' => static fn (Type $type): ?string => $type instanceof NamedType
? $type->name
: null,
],
'description' => [
'type' => Type::string(),
'resolve' => static fn (Type $type): ?string => $type instanceof NamedType
? $type->description
: null,
],
'fields' => [
'type' => Type::listOf(Type::nonNull(self::_field())),
'args' => [
'includeDeprecated' => [
'type' => Type::nonNull(Type::boolean()),
'defaultValue' => false,
],
],
'resolve' => static function (Type $type, $args): ?array {
if ($type instanceof ObjectType || $type instanceof InterfaceType) {
$fields = $type->getVisibleFields();
if (! $args['includeDeprecated']) {
return array_filter(
$fields,
static fn (FieldDefinition $field): bool => ! $field->isDeprecated()
);
}
return $fields;
}
return null;
},
],
'interfaces' => [
'type' => Type::listOf(Type::nonNull(self::_type())),
'resolve' => static fn ($type): ?array => $type instanceof ObjectType || $type instanceof InterfaceType
? $type->getInterfaces()
: null,
],
'possibleTypes' => [
'type' => Type::listOf(Type::nonNull(self::_type())),
'resolve' => static fn ($type, $args, $context, ResolveInfo $info): ?array => $type instanceof InterfaceType || $type instanceof UnionType
? $info->schema->getPossibleTypes($type)
: null,
],
'enumValues' => [
'type' => Type::listOf(Type::nonNull(self::_enumValue())),
'args' => [
'includeDeprecated' => [
'type' => Type::nonNull(Type::boolean()),
'defaultValue' => false,
],
],
'resolve' => static function ($type, $args): ?array {
if ($type instanceof EnumType) {
$values = $type->getValues();
if (! $args['includeDeprecated']) {
return array_filter(
$values,
static fn (EnumValueDefinition $value): bool => ! $value->isDeprecated()
);
}
return $values;
}
return null;
},
],
'inputFields' => [
'type' => Type::listOf(Type::nonNull(self::_inputValue())),
'args' => [
'includeDeprecated' => [
'type' => Type::nonNull(Type::boolean()),
'defaultValue' => false,
],
],
'resolve' => static function ($type, $args): ?array {
if ($type instanceof InputObjectType) {
$fields = $type->getFields();
if (! $args['includeDeprecated']) {
return array_filter(
$fields,
static fn (InputObjectField $field): bool => ! $field->isDeprecated(),
);
}
return $fields;
}
return null;
},
],
'ofType' => [
'type' => self::_type(),
'resolve' => static fn ($type): ?Type => $type instanceof WrappingType
? $type->getWrappedType()
: null,
],
'isOneOf' => [
'type' => Type::boolean(),
'resolve' => static fn ($type): ?bool => $type instanceof InputObjectType
? $type->isOneOf()
: null,
],
],
]);
}
public static function _typeKind(): EnumType
{
return self::$cachedInstances[self::TYPE_KIND_ENUM_NAME] ??= new EnumType([ // @phpstan-ignore missingType.checkedException (static configuration is known to be correct)
'name' => self::TYPE_KIND_ENUM_NAME,
'isIntrospection' => true,
'description' => 'An enum describing what kind of type a given `__Type` is.',
'values' => [
'SCALAR' => [
'value' => TypeKind::SCALAR,
'description' => 'Indicates this type is a scalar.',
],
'OBJECT' => [
'value' => TypeKind::OBJECT,
'description' => 'Indicates this type is an object. `fields` and `interfaces` are valid fields.',
],
'INTERFACE' => [
'value' => TypeKind::INTERFACE,
'description' => 'Indicates this type is an interface. `fields`, `interfaces`, and `possibleTypes` are valid fields.',
],
'UNION' => [
'value' => TypeKind::UNION,
'description' => 'Indicates this type is a union. `possibleTypes` is a valid field.',
],
'ENUM' => [
'value' => TypeKind::ENUM,
'description' => 'Indicates this type is an enum. `enumValues` is a valid field.',
],
'INPUT_OBJECT' => [
'value' => TypeKind::INPUT_OBJECT,
'description' => 'Indicates this type is an input object. `inputFields` is a valid field.',
],
'LIST' => [
'value' => TypeKind::LIST,
'description' => 'Indicates this type is a list. `ofType` is a valid field.',
],
'NON_NULL' => [
'value' => TypeKind::NON_NULL,
'description' => 'Indicates this type is a non-null. `ofType` is a valid field.',
],
],
]);
}
public static function _field(): ObjectType
{
return self::$cachedInstances[self::FIELD_OBJECT_NAME] ??= new ObjectType([ // @phpstan-ignore missingType.checkedException (static configuration is known to be correct)
'name' => self::FIELD_OBJECT_NAME,
'isIntrospection' => true,
'description' => 'Object and Interface types are described by a list of Fields, each of '
. 'which has a name, potentially a list of arguments, and a return type.',
'fields' => static fn (): array => [
'name' => [
'type' => Type::nonNull(Type::string()),
'resolve' => static fn (FieldDefinition $field): string => $field->name,
],
'description' => [
'type' => Type::string(),
'resolve' => static fn (FieldDefinition $field): ?string => $field->description,
],
'args' => [
'type' => Type::nonNull(Type::listOf(Type::nonNull(self::_inputValue()))),
'args' => [
'includeDeprecated' => [
'type' => Type::nonNull(Type::boolean()),
'defaultValue' => false,
],
],
'resolve' => static function (FieldDefinition $field, $args): array {
$values = $field->args;
if (! $args['includeDeprecated']) {
return array_filter(
$values,
static fn (Argument $value): bool => ! $value->isDeprecated(),
);
}
return $values;
},
],
'type' => [
'type' => Type::nonNull(self::_type()),
'resolve' => static fn (FieldDefinition $field): Type => $field->getType(),
],
'isDeprecated' => [
'type' => Type::nonNull(Type::boolean()),
'resolve' => static fn (FieldDefinition $field): bool => $field->isDeprecated(),
],
'deprecationReason' => [
'type' => Type::string(),
'resolve' => static fn (FieldDefinition $field): ?string => $field->deprecationReason,
],
],
]);
}
public static function _inputValue(): ObjectType
{
return self::$cachedInstances[self::INPUT_VALUE_OBJECT_NAME] ??= new ObjectType([ // @phpstan-ignore missingType.checkedException (static configuration is known to be correct)
'name' => self::INPUT_VALUE_OBJECT_NAME,
'isIntrospection' => true,
'description' => 'Arguments provided to Fields or Directives and the input fields of an '
. 'InputObject are represented as Input Values which describe their type '
. 'and optionally a default value.',
'fields' => static fn (): array => [
'name' => [
'type' => Type::nonNull(Type::string()),
/** @param Argument|InputObjectField $inputValue */
'resolve' => static fn ($inputValue): string => $inputValue->name,
],
'description' => [
'type' => Type::string(),
/** @param Argument|InputObjectField $inputValue */
'resolve' => static fn ($inputValue): ?string => $inputValue->description,
],
'type' => [
'type' => Type::nonNull(self::_type()),
/** @param Argument|InputObjectField $inputValue */
'resolve' => static fn ($inputValue): Type => $inputValue->getType(),
],
'defaultValue' => [
'type' => Type::string(),
'description' => 'A GraphQL-formatted string representing the default value for this input value.',
/** @param Argument|InputObjectField $inputValue */
'resolve' => static function ($inputValue): ?string {
if ($inputValue->defaultValueExists()) {
$defaultValueAST = AST::astFromValue($inputValue->defaultValue, $inputValue->getType());
if ($defaultValueAST === null) {
$inconvertibleDefaultValue = Utils::printSafe($inputValue->defaultValue);
throw new InvariantViolation("Unable to convert defaultValue of argument {$inputValue->name} into AST: {$inconvertibleDefaultValue}.");
}
return Printer::doPrint($defaultValueAST);
}
return null;
},
],
'isDeprecated' => [
'type' => Type::nonNull(Type::boolean()),
/** @param Argument|InputObjectField $inputValue */
'resolve' => static fn ($inputValue): bool => $inputValue->isDeprecated(),
],
'deprecationReason' => [
'type' => Type::string(),
/** @param Argument|InputObjectField $inputValue */
'resolve' => static fn ($inputValue): ?string => $inputValue->deprecationReason,
],
],
]);
}
public static function _enumValue(): ObjectType
{
return self::$cachedInstances[self::ENUM_VALUE_OBJECT_NAME] ??= new ObjectType([ // @phpstan-ignore missingType.checkedException (static configuration is known to be correct)
'name' => self::ENUM_VALUE_OBJECT_NAME,
'isIntrospection' => true,
'description' => 'One possible value for a given Enum. Enum values are unique values, not '
. 'a placeholder for a string or numeric value. However an Enum value is '
. 'returned in a JSON response as a string.',
'fields' => [
'name' => [
'type' => Type::nonNull(Type::string()),
'resolve' => static fn (EnumValueDefinition $enumValue): string => $enumValue->name,
],
'description' => [
'type' => Type::string(),
'resolve' => static fn (EnumValueDefinition $enumValue): ?string => $enumValue->description,
],
'isDeprecated' => [
'type' => Type::nonNull(Type::boolean()),
'resolve' => static fn (EnumValueDefinition $enumValue): bool => $enumValue->isDeprecated(),
],
'deprecationReason' => [
'type' => Type::string(),
'resolve' => static fn (EnumValueDefinition $enumValue): ?string => $enumValue->deprecationReason,
],
],
]);
}
public static function _directive(): ObjectType
{
return self::$cachedInstances[self::DIRECTIVE_OBJECT_NAME] ??= new ObjectType([ // @phpstan-ignore missingType.checkedException (static configuration is known to be correct)
'name' => self::DIRECTIVE_OBJECT_NAME,
'isIntrospection' => true,
'description' => 'A Directive provides a way to describe alternate runtime execution and '
. 'type validation behavior in a GraphQL document.'
. "\n\nIn some cases, you need to provide options to alter GraphQL's "
. 'execution behavior in ways field arguments will not suffice, such as '
. 'conditionally including or skipping a field. Directives provide this by '
. 'describing additional information to the executor.',
'fields' => [
'name' => [
'type' => Type::nonNull(Type::string()),
'resolve' => static fn (Directive $directive): string => $directive->name,
],
'description' => [
'type' => Type::string(),
'resolve' => static fn (Directive $directive): ?string => $directive->description,
],
'isRepeatable' => [
'type' => Type::nonNull(Type::boolean()),
'resolve' => static fn (Directive $directive): bool => $directive->isRepeatable,
],
'locations' => [
'type' => Type::nonNull(Type::listOf(Type::nonNull(
self::_directiveLocation()
))),
'resolve' => static fn (Directive $directive): array => $directive->locations,
],
'args' => [
'type' => Type::nonNull(Type::listOf(Type::nonNull(self::_inputValue()))),
'args' => [
'includeDeprecated' => [
'type' => Type::nonNull(Type::boolean()),
'defaultValue' => false,
],
],
'resolve' => static function (Directive $directive, $args): array {
$values = $directive->args;
if (! $args['includeDeprecated']) {
return array_filter(
$values,
static fn (Argument $value): bool => ! $value->isDeprecated(),
);
}
return $values;
},
],
],
]);
}
public static function _directiveLocation(): EnumType
{
return self::$cachedInstances[self::DIRECTIVE_LOCATION_ENUM_NAME] ??= new EnumType([ // @phpstan-ignore missingType.checkedException (static configuration is known to be correct)
'name' => self::DIRECTIVE_LOCATION_ENUM_NAME,
'isIntrospection' => true,
'description' => 'A Directive can be adjacent to many parts of the GraphQL language, a '
. '__DirectiveLocation describes one such possible adjacencies.',
'values' => [
'QUERY' => [
'value' => DirectiveLocation::QUERY,
'description' => 'Location adjacent to a query operation.',
],
'MUTATION' => [
'value' => DirectiveLocation::MUTATION,
'description' => 'Location adjacent to a mutation operation.',
],
'SUBSCRIPTION' => [
'value' => DirectiveLocation::SUBSCRIPTION,
'description' => 'Location adjacent to a subscription operation.',
],
'FIELD' => [
'value' => DirectiveLocation::FIELD,
'description' => 'Location adjacent to a field.',
],
'FRAGMENT_DEFINITION' => [
'value' => DirectiveLocation::FRAGMENT_DEFINITION,
'description' => 'Location adjacent to a fragment definition.',
],
'FRAGMENT_SPREAD' => [
'value' => DirectiveLocation::FRAGMENT_SPREAD,
'description' => 'Location adjacent to a fragment spread.',
],
'INLINE_FRAGMENT' => [
'value' => DirectiveLocation::INLINE_FRAGMENT,
'description' => 'Location adjacent to an inline fragment.',
],
'VARIABLE_DEFINITION' => [
'value' => DirectiveLocation::VARIABLE_DEFINITION,
'description' => 'Location adjacent to a variable definition.',
],
'SCHEMA' => [
'value' => DirectiveLocation::SCHEMA,
'description' => 'Location adjacent to a schema definition.',
],
'SCALAR' => [
'value' => DirectiveLocation::SCALAR,
'description' => 'Location adjacent to a scalar definition.',
],
'OBJECT' => [
'value' => DirectiveLocation::OBJECT,
'description' => 'Location adjacent to an object type definition.',
],
'FIELD_DEFINITION' => [
'value' => DirectiveLocation::FIELD_DEFINITION,
'description' => 'Location adjacent to a field definition.',
],
'ARGUMENT_DEFINITION' => [
'value' => DirectiveLocation::ARGUMENT_DEFINITION,
'description' => 'Location adjacent to an argument definition.',
],
'INTERFACE' => [
'value' => DirectiveLocation::IFACE,
'description' => 'Location adjacent to an interface definition.',
],
'UNION' => [
'value' => DirectiveLocation::UNION,
'description' => 'Location adjacent to a union definition.',
],
'ENUM' => [
'value' => DirectiveLocation::ENUM,
'description' => 'Location adjacent to an enum definition.',
],
'ENUM_VALUE' => [
'value' => DirectiveLocation::ENUM_VALUE,
'description' => 'Location adjacent to an enum value definition.',
],
'INPUT_OBJECT' => [
'value' => DirectiveLocation::INPUT_OBJECT,
'description' => 'Location adjacent to an input object type definition.',
],
'INPUT_FIELD_DEFINITION' => [
'value' => DirectiveLocation::INPUT_FIELD_DEFINITION,
'description' => 'Location adjacent to an input object field definition.',
],
],
]);
}
public static function schemaMetaFieldDef(): FieldDefinition
{
return self::$cachedInstances[self::SCHEMA_FIELD_NAME] ??= new FieldDefinition([
'name' => self::SCHEMA_FIELD_NAME,
'type' => Type::nonNull(self::_schema()),
'description' => 'Access the current type schema of this server.',
'args' => [],
'resolve' => static fn ($source, array $args, $context, ResolveInfo $info): Schema => $info->schema,
]);
}
public static function typeMetaFieldDef(): FieldDefinition
{
return self::$cachedInstances[self::TYPE_FIELD_NAME] ??= new FieldDefinition([
'name' => self::TYPE_FIELD_NAME,
'type' => self::_type(),
'description' => 'Request the type information of a single type.',
'args' => [
[
'name' => 'name',
'type' => Type::nonNull(Type::string()),
],
],
'resolve' => static fn ($source, array $args, $context, ResolveInfo $info): ?Type => $info->schema->getType($args['name']),
]);
}
public static function typeNameMetaFieldDef(): FieldDefinition
{
return self::$cachedInstances[self::TYPE_NAME_FIELD_NAME] ??= new FieldDefinition([
'name' => self::TYPE_NAME_FIELD_NAME,
'type' => Type::nonNull(Type::string()),
'description' => 'The name of the current Object type at runtime.',
'args' => [],
'resolve' => static fn ($source, array $args, $context, ResolveInfo $info): string => $info->parentType->name,
]);
}
public static function resetCachedInstances(): void
{
self::$cachedInstances = null;
}
}