Total Complexity | 40 |
Total Lines | 359 |
Duplicated Lines | 0 % |
Changes | 4 | ||
Bugs | 0 | Features | 0 |
Complex classes like Schema often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Schema, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
53 | class Schema extends Definition implements SchemaInterface |
||
54 | { |
||
55 | use ExtensionASTNodesTrait; |
||
56 | use ASTNodeTrait; |
||
57 | |||
58 | /** |
||
59 | * @var ObjectTypeInterface|null |
||
60 | */ |
||
61 | protected $queryType; |
||
62 | |||
63 | /** |
||
64 | * @var ObjectTypeInterface|null |
||
65 | */ |
||
66 | protected $mutationType; |
||
67 | |||
68 | /** |
||
69 | * @var ObjectTypeInterface|null |
||
70 | */ |
||
71 | protected $subscriptionType; |
||
72 | |||
73 | /** |
||
74 | * @var array|TypeInterface[] |
||
75 | */ |
||
76 | protected $types = []; |
||
77 | |||
78 | /** |
||
79 | * @var array|DirectiveInterface[] |
||
80 | */ |
||
81 | protected $directives = []; |
||
82 | |||
83 | /** |
||
84 | * @var bool |
||
85 | */ |
||
86 | protected $assumeValid = false; |
||
87 | |||
88 | /** |
||
89 | * @var array|NamedTypeInterface[] |
||
90 | */ |
||
91 | protected $typeMap = []; |
||
92 | |||
93 | /** |
||
94 | * @var array|ObjectTypeInterface[][] |
||
95 | */ |
||
96 | protected $implementations = []; |
||
97 | |||
98 | /** |
||
99 | * @var array|NamedTypeInterface[] |
||
100 | */ |
||
101 | protected $possibleTypesMap = []; |
||
102 | |||
103 | /** |
||
104 | * Schema constructor. |
||
105 | * |
||
106 | * @param ObjectTypeInterface|null $queryType |
||
107 | * @param ObjectTypeInterface|null $mutationType |
||
108 | * @param ObjectTypeInterface|null $subscriptionType |
||
109 | * @param TypeInterface[] $types |
||
110 | * @param DirectiveInterface[] $directives |
||
111 | * @param bool $assumeValid |
||
112 | * @param SchemaDefinitionNode|null $astNode |
||
113 | * @param ObjectTypeExtensionNode[]|InterfaceTypeExtensionNode[] $extensionASTNodes |
||
114 | * @throws InvariantException |
||
115 | */ |
||
116 | public function __construct( |
||
117 | ?ObjectTypeInterface $queryType, |
||
118 | ?ObjectTypeInterface $mutationType, |
||
119 | ?ObjectTypeInterface $subscriptionType, |
||
120 | array $types, |
||
121 | array $directives, |
||
122 | bool $assumeValid, |
||
123 | ?SchemaDefinitionNode $astNode, |
||
124 | array $extensionASTNodes |
||
125 | ) { |
||
126 | $this->queryType = $queryType; |
||
127 | $this->mutationType = $mutationType; |
||
128 | $this->subscriptionType = $subscriptionType; |
||
129 | $this->types = $types; |
||
130 | $this->directives = !empty($directives) |
||
131 | ? $directives |
||
132 | : specifiedDirectives(); |
||
133 | $this->assumeValid = $assumeValid; |
||
134 | $this->astNode = $astNode; |
||
135 | $this->extensionAstNodes = $extensionASTNodes; |
||
136 | |||
137 | $this->buildTypeMap(); |
||
138 | $this->buildImplementations(); |
||
139 | } |
||
140 | |||
141 | /** |
||
142 | * @return ObjectTypeInterface|null |
||
143 | */ |
||
144 | public function getQueryType(): ?ObjectTypeInterface |
||
145 | { |
||
146 | return $this->queryType; |
||
147 | } |
||
148 | |||
149 | /** |
||
150 | * @return ObjectTypeInterface|null |
||
151 | */ |
||
152 | public function getMutationType(): ?ObjectTypeInterface |
||
153 | { |
||
154 | return $this->mutationType; |
||
155 | } |
||
156 | |||
157 | /** |
||
158 | * @return ObjectTypeInterface|null |
||
159 | */ |
||
160 | public function getSubscriptionType(): ?ObjectTypeInterface |
||
161 | { |
||
162 | return $this->subscriptionType; |
||
163 | } |
||
164 | |||
165 | /** |
||
166 | * @param string $name |
||
167 | * @return DirectiveInterface|null |
||
168 | */ |
||
169 | public function getDirective(string $name): ?DirectiveInterface |
||
170 | { |
||
171 | return find($this->directives, static function (Directive $directive) use ($name) { |
||
172 | return $directive->getName() === $name; |
||
173 | }); |
||
174 | } |
||
175 | |||
176 | /** |
||
177 | * @return DirectiveInterface[] |
||
178 | */ |
||
179 | public function getDirectives(): array |
||
182 | } |
||
183 | |||
184 | /** |
||
185 | * @return NamedTypeInterface[] |
||
186 | */ |
||
187 | public function getTypeMap(): array |
||
188 | { |
||
189 | return $this->typeMap; |
||
190 | } |
||
191 | |||
192 | /** |
||
193 | * @return bool |
||
194 | */ |
||
195 | public function getAssumeValid(): bool |
||
198 | } |
||
199 | |||
200 | /** |
||
201 | * @param AbstractTypeContract|AbstractTypeInterface $abstractType |
||
202 | * @param ObjectTypeInterface $possibleType |
||
203 | * @return bool |
||
204 | * @throws InvariantException |
||
205 | */ |
||
206 | public function isPossibleType(AbstractTypeContract $abstractType, ObjectTypeInterface $possibleType): bool |
||
207 | { |
||
208 | assert($abstractType instanceof NamedTypeInterface); |
||
209 | |||
210 | $abstractTypeName = $abstractType->getName(); |
||
211 | $possibleTypeName = $possibleType->getName(); |
||
212 | |||
213 | if (!isset($this->possibleTypesMap[$abstractTypeName])) { |
||
214 | $possibleTypes = $this->getPossibleTypes($abstractType); |
||
215 | |||
216 | if ($possibleTypes === []) { |
||
217 | throw new InvariantException(\sprintf( |
||
218 | 'Could not find possible implementing types for %s ' . |
||
219 | 'in schema. Check that schema.types is defined and is an array of ' . |
||
220 | 'all possible types in the schema.', |
||
221 | $abstractTypeName |
||
222 | )); |
||
223 | } |
||
224 | |||
225 | $this->possibleTypesMap[$abstractTypeName] = \array_reduce( |
||
226 | $possibleTypes, |
||
227 | static function (array $map, NamedTypeInterface $type) { |
||
228 | $map[$type->getName()] = true; |
||
229 | |||
230 | return $map; |
||
231 | }, |
||
232 | [] |
||
233 | ); |
||
234 | } |
||
235 | |||
236 | return isset($this->possibleTypesMap[$abstractTypeName][$possibleTypeName]); |
||
237 | } |
||
238 | |||
239 | /** |
||
240 | * @param AbstractTypeContract $abstractType |
||
241 | * @return array|ObjectTypeInterface[] |
||
242 | * @throws InvariantException |
||
243 | */ |
||
244 | public function getPossibleTypes(AbstractTypeContract $abstractType): array |
||
245 | { |
||
246 | assert($abstractType instanceof NamedTypeInterface); |
||
247 | |||
248 | if ($abstractType instanceof UnionType) { |
||
249 | return $abstractType->getTypes(); |
||
250 | } |
||
251 | |||
252 | return $this->implementations[$abstractType->getName()] ?? []; |
||
253 | } |
||
254 | |||
255 | /** |
||
256 | * @param string $name |
||
257 | * @return NamedTypeInterface|null |
||
258 | */ |
||
259 | public function getType(string $name): ?NamedTypeInterface |
||
260 | { |
||
261 | return $this->typeMap[$name] ?? null; |
||
262 | } |
||
263 | |||
264 | /** |
||
265 | * @return void |
||
266 | */ |
||
267 | protected function buildTypeMap(): void |
||
268 | { |
||
269 | $initialTypes = [ |
||
270 | $this->queryType, |
||
271 | $this->mutationType, |
||
272 | $this->subscriptionType, |
||
273 | __Schema(), // Introspection schema |
||
274 | ]; |
||
275 | |||
276 | if (!empty($this->types)) { |
||
277 | $initialTypes = \array_merge($initialTypes, $this->types); |
||
278 | } |
||
279 | |||
280 | // Keep track of all types referenced within the schema. |
||
281 | $typeMap = []; |
||
282 | |||
283 | // First by deeply visiting all initial types. |
||
284 | $typeMap = \array_reduce($initialTypes, [$this, 'typeMapReducer'], $typeMap); |
||
285 | |||
286 | // Then by deeply visiting all directive types. |
||
287 | $typeMap = \array_reduce($this->directives, [$this, 'typeMapDirectiveReducer'], $typeMap); |
||
288 | |||
289 | // Storing the resulting map for reference by the schema. |
||
290 | $this->typeMap = $typeMap; |
||
291 | } |
||
292 | |||
293 | /** |
||
294 | * @throws InvariantException |
||
295 | */ |
||
296 | protected function buildImplementations(): void |
||
297 | { |
||
298 | $implementations = []; |
||
299 | |||
300 | // Keep track of all implementations by interface name. |
||
301 | foreach ($this->typeMap as $typeName => $type) { |
||
302 | if ($type instanceof ObjectType) { |
||
303 | foreach ($type->getInterfaces() as $interface) { |
||
304 | if (!($interface instanceof InterfaceType)) { |
||
305 | continue; |
||
306 | } |
||
307 | |||
308 | $interfaceName = $interface->getName(); |
||
309 | |||
310 | if (!isset($implementations[$interfaceName])) { |
||
311 | $implementations[$interfaceName] = []; |
||
312 | } |
||
313 | |||
314 | $implementations[$interfaceName][] = $type; |
||
315 | } |
||
316 | } |
||
317 | } |
||
318 | |||
319 | $this->implementations = $implementations; |
||
320 | } |
||
321 | |||
322 | /** |
||
323 | * @param array $map |
||
324 | * @param TypeInterface|null $type |
||
325 | * @return array |
||
326 | * @throws InvariantException |
||
327 | */ |
||
328 | protected function typeMapReducer(array $map, ?TypeInterface $type): array |
||
329 | { |
||
330 | if (null === $type) { |
||
331 | return $map; |
||
332 | } |
||
333 | |||
334 | if ($type instanceof WrappingTypeInterface) { |
||
335 | return $this->typeMapReducer($map, $type->getOfType()); |
||
336 | } |
||
337 | |||
338 | if ($type instanceof NamedTypeInterface) { |
||
339 | $typeName = $type->getName(); |
||
340 | |||
341 | if (isset($map[$typeName])) { |
||
342 | if ($type !== $map[$typeName]) { |
||
343 | throw new InvariantException(\sprintf( |
||
344 | 'Schema must contain unique named types but contains multiple types named "%s".', |
||
345 | $type->getName() |
||
346 | )); |
||
347 | } |
||
348 | |||
349 | return $map; |
||
350 | } |
||
351 | |||
352 | $map[$typeName] = $type; |
||
353 | |||
354 | $reducedMap = $map; |
||
355 | |||
356 | if ($type instanceof UnionType) { |
||
357 | $reducedMap = \array_reduce($type->getTypes(), [$this, 'typeMapReducer'], $reducedMap); |
||
358 | } |
||
359 | |||
360 | if ($type instanceof ObjectType) { |
||
361 | $reducedMap = \array_reduce($type->getInterfaces(), [$this, 'typeMapReducer'], $reducedMap); |
||
362 | } |
||
363 | |||
364 | if ($type instanceof ObjectType || $type instanceof InterfaceType) { |
||
365 | foreach ($type->getFields() as $field) { |
||
366 | if ($field->hasArguments()) { |
||
367 | $fieldArgTypes = \array_map(function (Argument $argument) { |
||
368 | return $argument->getNullableType(); |
||
369 | }, $field->getArguments()); |
||
370 | |||
371 | $reducedMap = \array_reduce($fieldArgTypes, [$this, 'typeMapReducer'], $reducedMap); |
||
372 | } |
||
373 | |||
374 | $reducedMap = $this->typeMapReducer($reducedMap, $field->getNullableType()); |
||
375 | } |
||
376 | } |
||
377 | |||
378 | if ($type instanceof InputObjectType) { |
||
379 | foreach ($type->getFields() as $field) { |
||
380 | $reducedMap = $this->typeMapReducer($reducedMap, $field->getNullableType()); |
||
381 | } |
||
382 | } |
||
383 | |||
384 | return $reducedMap; |
||
385 | } |
||
386 | |||
387 | return $map; |
||
388 | } |
||
389 | |||
390 | /** |
||
391 | * @param array $map |
||
392 | * @param Directive $directive |
||
393 | * @return array |
||
394 | */ |
||
395 | protected function typeMapDirectiveReducer(array $map, Directive $directive): array |
||
396 | { |
||
397 | if (!$directive->hasArguments()) { |
||
398 | return $map; |
||
399 | } |
||
400 | |||
401 | return \array_reduce($directive->getArguments(), function ($map, Argument $argument) { |
||
402 | return $this->typeMapReducer($map, $argument->getNullableType()); |
||
403 | }, $map); |
||
404 | } |
||
405 | |||
406 | /** |
||
407 | * @return string |
||
408 | */ |
||
409 | public function __toString(): string |
||
412 | } |
||
413 | } |
||
414 |