/
IterableType.php
395 lines (321 loc) · 9.12 KB
/
IterableType.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
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
<?php declare(strict_types = 1);
namespace PHPStan\Type;
use PHPStan\TrinaryLogic;
use PHPStan\Type\Generic\GenericObjectType;
use PHPStan\Type\Generic\TemplateMixedType;
use PHPStan\Type\Generic\TemplateType;
use PHPStan\Type\Generic\TemplateTypeMap;
use PHPStan\Type\Generic\TemplateTypeVariance;
use PHPStan\Type\Traits\MaybeArrayTypeTrait;
use PHPStan\Type\Traits\MaybeCallableTypeTrait;
use PHPStan\Type\Traits\MaybeObjectTypeTrait;
use PHPStan\Type\Traits\MaybeOffsetAccessibleTypeTrait;
use PHPStan\Type\Traits\NonGeneralizableTypeTrait;
use PHPStan\Type\Traits\UndecidedBooleanTypeTrait;
use PHPStan\Type\Traits\UndecidedComparisonCompoundTypeTrait;
use Traversable;
use function array_merge;
use function sprintf;
/** @api */
class IterableType implements CompoundType
{
use MaybeArrayTypeTrait;
use MaybeCallableTypeTrait;
use MaybeObjectTypeTrait;
use MaybeOffsetAccessibleTypeTrait;
use UndecidedBooleanTypeTrait;
use UndecidedComparisonCompoundTypeTrait;
use NonGeneralizableTypeTrait;
/** @api */
public function __construct(
private Type $keyType,
private Type $itemType,
)
{
}
public function getKeyType(): Type
{
return $this->keyType;
}
public function getItemType(): Type
{
return $this->itemType;
}
/**
* @return string[]
*/
public function getReferencedClasses(): array
{
return array_merge(
$this->keyType->getReferencedClasses(),
$this->getItemType()->getReferencedClasses(),
);
}
public function getConstantStrings(): array
{
return [];
}
public function accepts(Type $type, bool $strictTypes): TrinaryLogic
{
if ($type->isConstantArray()->yes() && $type->isIterableAtLeastOnce()->no()) {
return TrinaryLogic::createYes();
}
if ($type->isIterable()->yes()) {
return $this->getIterableValueType()->accepts($type->getIterableValueType(), $strictTypes)
->and($this->getIterableKeyType()->accepts($type->getIterableKeyType(), $strictTypes));
}
if ($type instanceof CompoundType) {
return $type->isAcceptedBy($this, $strictTypes);
}
return TrinaryLogic::createNo();
}
public function isSuperTypeOf(Type $type): TrinaryLogic
{
if ($type instanceof CompoundType) {
return $type->isSubTypeOf($this);
}
return $type->isIterable()
->and($this->getIterableValueType()->isSuperTypeOf($type->getIterableValueType()))
->and($this->getIterableKeyType()->isSuperTypeOf($type->getIterableKeyType()));
}
public function isSuperTypeOfMixed(Type $type): TrinaryLogic
{
return $type->isIterable()
->and($this->isNestedTypeSuperTypeOf($this->getIterableValueType(), $type->getIterableValueType()))
->and($this->isNestedTypeSuperTypeOf($this->getIterableKeyType(), $type->getIterableKeyType()));
}
private function isNestedTypeSuperTypeOf(Type $a, Type $b): TrinaryLogic
{
if (!$a instanceof MixedType || !$b instanceof MixedType) {
return $a->isSuperTypeOf($b);
}
if ($a instanceof TemplateMixedType || $b instanceof TemplateMixedType) {
return $a->isSuperTypeOf($b);
}
if ($a->isExplicitMixed()) {
if ($b->isExplicitMixed()) {
return TrinaryLogic::createYes();
}
return TrinaryLogic::createMaybe();
}
return TrinaryLogic::createYes();
}
public function isSubTypeOf(Type $otherType): TrinaryLogic
{
if ($otherType instanceof IntersectionType || $otherType instanceof UnionType) {
return $otherType->isSuperTypeOf(new UnionType([
new ArrayType($this->keyType, $this->itemType),
new IntersectionType([
new ObjectType(Traversable::class),
$this,
]),
]));
}
if ($otherType instanceof self) {
$limit = TrinaryLogic::createYes();
} else {
$limit = TrinaryLogic::createMaybe();
}
if ($otherType->isConstantArray()->yes() && $otherType->isIterableAtLeastOnce()->no()) {
return TrinaryLogic::createMaybe();
}
return $limit->and(
$otherType->isIterable(),
$otherType->getIterableValueType()->isSuperTypeOf($this->itemType),
$otherType->getIterableKeyType()->isSuperTypeOf($this->keyType),
);
}
public function isAcceptedBy(Type $acceptingType, bool $strictTypes): TrinaryLogic
{
return $this->isSubTypeOf($acceptingType);
}
public function equals(Type $type): bool
{
if (!$type instanceof self) {
return false;
}
return $this->keyType->equals($type->keyType)
&& $this->itemType->equals($type->itemType);
}
public function describe(VerbosityLevel $level): string
{
$isMixedKeyType = $this->keyType instanceof MixedType && !$this->keyType instanceof TemplateType;
$isMixedItemType = $this->itemType instanceof MixedType && !$this->itemType instanceof TemplateType;
if ($isMixedKeyType) {
if ($isMixedItemType) {
return 'iterable';
}
return sprintf('iterable<%s>', $this->itemType->describe($level));
}
return sprintf('iterable<%s, %s>', $this->keyType->describe($level), $this->itemType->describe($level));
}
public function hasOffsetValueType(Type $offsetType): TrinaryLogic
{
if ($this->getIterableKeyType()->isSuperTypeOf($offsetType)->no()) {
return TrinaryLogic::createNo();
}
return TrinaryLogic::createMaybe();
}
public function toNumber(): Type
{
return new ErrorType();
}
public function toString(): Type
{
return new ErrorType();
}
public function toInteger(): Type
{
return new ErrorType();
}
public function toFloat(): Type
{
return new ErrorType();
}
public function toArray(): Type
{
return new ArrayType($this->keyType, $this->getItemType());
}
public function toArrayKey(): Type
{
return new ErrorType();
}
public function isIterable(): TrinaryLogic
{
return TrinaryLogic::createYes();
}
public function isIterableAtLeastOnce(): TrinaryLogic
{
return TrinaryLogic::createMaybe();
}
public function getArraySize(): Type
{
return IntegerRangeType::fromInterval(0, null);
}
public function getIterableKeyType(): Type
{
return $this->keyType;
}
public function getFirstIterableKeyType(): Type
{
return $this->keyType;
}
public function getLastIterableKeyType(): Type
{
return $this->keyType;
}
public function getIterableValueType(): Type
{
return $this->getItemType();
}
public function getFirstIterableValueType(): Type
{
return $this->getItemType();
}
public function getLastIterableValueType(): Type
{
return $this->getItemType();
}
public function isNull(): TrinaryLogic
{
return TrinaryLogic::createNo();
}
public function isTrue(): TrinaryLogic
{
return TrinaryLogic::createNo();
}
public function isFalse(): TrinaryLogic
{
return TrinaryLogic::createNo();
}
public function isBoolean(): TrinaryLogic
{
return TrinaryLogic::createNo();
}
public function isFloat(): TrinaryLogic
{
return TrinaryLogic::createNo();
}
public function isInteger(): TrinaryLogic
{
return TrinaryLogic::createNo();
}
public function isString(): TrinaryLogic
{
return TrinaryLogic::createNo();
}
public function isNumericString(): TrinaryLogic
{
return TrinaryLogic::createNo();
}
public function isNonEmptyString(): TrinaryLogic
{
return TrinaryLogic::createNo();
}
public function isNonFalsyString(): TrinaryLogic
{
return TrinaryLogic::createNo();
}
public function isLiteralString(): TrinaryLogic
{
return TrinaryLogic::createNo();
}
public function isClassStringType(): TrinaryLogic
{
return TrinaryLogic::createNo();
}
public function isVoid(): TrinaryLogic
{
return TrinaryLogic::createNo();
}
public function inferTemplateTypes(Type $receivedType): TemplateTypeMap
{
if ($receivedType instanceof UnionType || $receivedType instanceof IntersectionType) {
return $receivedType->inferTemplateTypesOn($this);
}
if (!$receivedType->isIterable()->yes()) {
return TemplateTypeMap::createEmpty();
}
$keyTypeMap = $this->getIterableKeyType()->inferTemplateTypes($receivedType->getIterableKeyType());
$valueTypeMap = $this->getIterableValueType()->inferTemplateTypes($receivedType->getIterableValueType());
return $keyTypeMap->union($valueTypeMap);
}
public function getReferencedTemplateTypes(TemplateTypeVariance $positionVariance): array
{
return array_merge(
$this->getIterableKeyType()->getReferencedTemplateTypes(TemplateTypeVariance::createCovariant()),
$this->getIterableValueType()->getReferencedTemplateTypes(TemplateTypeVariance::createCovariant()),
);
}
public function traverse(callable $cb): Type
{
$keyType = $cb($this->keyType);
$itemType = $cb($this->itemType);
if ($keyType !== $this->keyType || $itemType !== $this->itemType) {
return new self($keyType, $itemType);
}
return $this;
}
public function tryRemove(Type $typeToRemove): ?Type
{
$arrayType = new ArrayType(new MixedType(), new MixedType());
if ($typeToRemove->isSuperTypeOf($arrayType)->yes()) {
return new GenericObjectType(Traversable::class, [
$this->getIterableKeyType(),
$this->getIterableValueType(),
]);
}
$traversableType = new ObjectType(Traversable::class);
if ($typeToRemove->isSuperTypeOf($traversableType)->yes()) {
return new ArrayType($this->getIterableKeyType(), $this->getIterableValueType());
}
return null;
}
/**
* @param mixed[] $properties
*/
public static function __set_state(array $properties): Type
{
return new self($properties['keyType'], $properties['itemType']);
}
}