This repository has been archived by the owner on Mar 8, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 11
/
UnionType.php
141 lines (121 loc) · 3.38 KB
/
UnionType.php
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
<?php
namespace Digia\GraphQL\Type\Definition;
use Digia\GraphQL\Behavior\ConfigTrait;
use Digia\GraphQL\Type\Definition\Behavior\DescriptionTrait;
use Digia\GraphQL\Language\AST\Node\NodeTrait;
use Digia\GraphQL\Language\AST\Node\UnionTypeDefinitionNode;
use Digia\GraphQL\Type\Definition\Behavior\NameTrait;
use Digia\GraphQL\Type\Definition\Behavior\ResolveTypeTrait;
use Digia\GraphQL\Type\Definition\Contract\AbstractTypeInterface;
use Digia\GraphQL\Type\Definition\Contract\CompositeTypeInterface;
use Digia\GraphQL\Type\Definition\Contract\OutputTypeInterface;
use Digia\GraphQL\Type\Definition\Contract\TypeInterface;
use function Digia\GraphQL\Type\resolveThunk;
use function Digia\GraphQL\Util\invariant;
/**
* Union Type Definition
* When a field can return one of a heterogeneous set of types, a Union type
* is used to describe what types are possible as well as providing a function
* to determine which type is actually used when the field is resolved.
* Example:
* const PetType = new GraphQLUnionType({
* name: 'Pet',
* types: [ DogType, CatType ],
* resolveType(value) {
* if (value instanceof Dog) {
* return DogType;
* }
* if (value instanceof Cat) {
* return CatType;
* }
* }
* });
*/
/**
* Class UnionType
*
* @package Digia\GraphQL\Type\Definition
* @property UnionTypeDefinitionNode $astNode
*/
class UnionType implements AbstractTypeInterface, CompositeTypeInterface, OutputTypeInterface
{
use NameTrait;
use DescriptionTrait;
use ResolveTypeTrait;
use NodeTrait;
use ConfigTrait;
/**
* @var array|callable
*/
private $_typesThunk;
/**
* @var TypeInterface[]
*/
private $_typeMap = [];
/**
* @var bool
*/
private $_isTypeMapBuilt = false;
/**
* @inheritdoc
*/
protected function beforeConfig(): void
{
$this->setName(TypeEnum::UNION);
}
/**
* @param TypeInterface $type
* @return UnionType
*/
public function addType(TypeInterface $type): UnionType
{
$this->_typeMap[$type->getName()] = $type;
return $this;
}
/**
* @return TypeInterface[]
* @throws \Exception
*/
public function getTypes(): array
{
$this->buildTypeMapIfNecessary();
return $this->_typeMap;
}
/**
* @param array|callable $typesThunk
* @return UnionType
*/
protected function setTypes($typesThunk): UnionType
{
$this->_typesThunk = $typesThunk;
return $this;
}
/**
* @throws \Exception
*/
protected function buildTypeMapIfNecessary()
{
// Types are built lazily to avoid concurrency issues.
if (!$this->_isTypeMapBuilt) {
$this->_typeMap = array_merge($this->defineTypes($this->_typesThunk), $this->_typeMap);
$this->_isTypeMapBuilt = true;
}
}
/**
* @param array|callable $typesThunk
* @return array
* @throws \Exception
*/
protected function defineTypes($typesThunk): array
{
$types = resolveThunk($typesThunk) ?: [];
invariant(
is_array($types),
sprintf(
'Must provide Array of types or a function which returns such an array for Union %s.',
$this->getName()
)
);
return $types;
}
}