Skip to content

Commit 5b4de14

Browse files
herndlmherndlm
committed
Add Type::spliceArray(), improve splice_array() array type narrowing
1 parent ac60c83 commit 5b4de14

22 files changed

+597
-32
lines changed

‎phpstan-baseline.neon‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -969,7 +969,7 @@ parameters:
969969
-
970970
message: '#^Doing instanceof PHPStan\\Type\\Constant\\ConstantArrayType is error\-prone and deprecated\. Use Type\:\:getConstantArrays\(\) instead\.$#'
971971
identifier: phpstanApi.instanceofType
972-
count: 5
972+
count: 6
973973
path: src/Type/Constant/ConstantArrayType.php
974974

975975
-

‎src/Analyser/NodeScopeResolver.php‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2670,19 +2670,20 @@ static function (): void {
26702670
if (
26712671
$functionReflection !== null
26722672
&& $functionReflection->getName() === 'array_splice'
2673-
&& count($expr->getArgs()) >= 1
2673+
&& count($expr->getArgs()) >= 2
26742674
) {
26752675
$arrayArg = $expr->getArgs()[0]->value;
26762676
$arrayArgType = $scope->getType($arrayArg);
2677-
$valueType = $arrayArgType->getIterableValueType();
2678-
if (count($expr->getArgs()) >= 4) {
2679-
$replacementType = $scope->getType($expr->getArgs()[3]->value)->toArray();
2680-
$valueType = TypeCombinator::union($valueType, $replacementType->getIterableValueType());
2681-
}
2677+
$arrayArgNativeType = $scope->getNativeType($arrayArg);
2678+
2679+
$offsetType = $scope->getType($expr->getArgs()[1]->value);
2680+
$lengthType = isset($expr->getArgs()[2]) ? $scope->getType($expr->getArgs()[2]->value) : new NullType();
2681+
$replacementType = isset($expr->getArgs()[3]) ? $scope->getType($expr->getArgs()[3]->value) : new ConstantArrayType([], []);
2682+
26822683
$scope = $scope->invalidateExpression($arrayArg)->assignExpression(
26832684
$arrayArg,
2684-
new ArrayType($arrayArgType->getIterableKeyType(), $valueType),
2685-
new ArrayType($arrayArgType->getIterableKeyType(), $valueType),
2685+
$arrayArgType->spliceArray($offsetType, $lengthType, $replacementType),
2686+
$arrayArgNativeType->spliceArray($offsetType, $lengthType, $replacementType),
26862687
);
26872688
}
26882689

‎src/Type/Accessory/AccessoryArrayListType.php‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -248,6 +248,11 @@ public function sliceArray(Type $offsetType, Type $lengthType, TrinaryLogic $pre
248248
return new MixedType();
249249
}
250250

251+
public function spliceArray(Type $offsetType, Type $lengthType, Type $replacementType): Type
252+
{
253+
return $this;
254+
}
255+
251256
public function isIterable(): TrinaryLogic
252257
{
253258
return TrinaryLogic::createYes();

‎src/Type/Accessory/HasOffsetType.php‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -214,6 +214,15 @@ public function sliceArray(Type $offsetType, Type $lengthType, TrinaryLogic $pre
214214
return new MixedType();
215215
}
216216

217+
public function spliceArray(Type $offsetType, Type $lengthType, Type $replacementType): Type
218+
{
219+
if ((new ConstantIntegerType(0))->isSuperTypeOf($lengthType)->yes()) {
220+
return $this;
221+
}
222+
223+
return new MixedType();
224+
}
225+
217226
public function isIterableAtLeastOnce(): TrinaryLogic
218227
{
219228
return TrinaryLogic::createYes();

‎src/Type/Accessory/HasOffsetValueType.php‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -274,6 +274,15 @@ public function sliceArray(Type $offsetType, Type $lengthType, TrinaryLogic $pre
274274
return new MixedType();
275275
}
276276

277+
public function spliceArray(Type $offsetType, Type $lengthType, Type $replacementType): Type
278+
{
279+
if ((new ConstantIntegerType(0))->isSuperTypeOf($lengthType)->yes()) {
280+
return $this;
281+
}
282+
283+
return new MixedType();
284+
}
285+
277286
public function isIterableAtLeastOnce(): TrinaryLogic
278287
{
279288
return TrinaryLogic::createYes();

‎src/Type/Accessory/NonEmptyArrayType.php‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -223,6 +223,18 @@ public function sliceArray(Type $offsetType, Type $lengthType, TrinaryLogic $pre
223223
return new MixedType();
224224
}
225225

226+
public function spliceArray(Type $offsetType, Type $lengthType, Type $replacementType): Type
227+
{
228+
if (
229+
(new ConstantIntegerType(0))->isSuperTypeOf($lengthType)->yes()
230+
|| $replacementType->toArray()->isIterableAtLeastOnce()->yes()
231+
) {
232+
return $this;
233+
}
234+
235+
return new MixedType();
236+
}
237+
226238
public function isIterable(): TrinaryLogic
227239
{
228240
return TrinaryLogic::createYes();

‎src/Type/Accessory/OversizedArrayType.php‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -214,6 +214,11 @@ public function sliceArray(Type $offsetType, Type $lengthType, TrinaryLogic $pre
214214
return $this;
215215
}
216216

217+
public function spliceArray(Type $offsetType, Type $lengthType, Type $replacementType): Type
218+
{
219+
return $this;
220+
}
221+
217222
public function isIterable(): TrinaryLogic
218223
{
219224
return TrinaryLogic::createYes();

‎src/Type/ArrayType.php‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -453,6 +453,27 @@ public function sliceArray(Type $offsetType, Type $lengthType, TrinaryLogic $pre
453453
return $this;
454454
}
455455

456+
public function spliceArray(Type $offsetType, Type $lengthType, Type $replacementType): Type
457+
{
458+
$replacementArrayType = $replacementType->toArray();
459+
$replacementArrayTypeIsIterableAtLeastOnce = $replacementArrayType->isIterableAtLeastOnce();
460+
461+
if ((new ConstantIntegerType(0))->isSuperTypeOf($offsetType)->yes() && $lengthType->isNull()->yes() && $replacementArrayTypeIsIterableAtLeastOnce->no()) {
462+
return new ConstantArrayType([], []);
463+
}
464+
465+
$arrayType = new self(
466+
TypeCombinator::union($this->getIterableKeyType(), $replacementArrayType->getKeysArray()->getIterableKeyType()),
467+
TypeCombinator::union($this->getIterableValueType(), $replacementArrayType->getIterableValueType()),
468+
);
469+
470+
if ($replacementArrayTypeIsIterableAtLeastOnce->yes()) {
471+
$arrayType = TypeCombinator::intersect($arrayType, new NonEmptyArrayType());
472+
}
473+
474+
return $arrayType;
475+
}
476+
456477
public function isCallable(): TrinaryLogic
457478
{
458479
return TrinaryLogic::createMaybe()->and($this->itemType->isString());

‎src/Type/Constant/ConstantArrayType.php‎

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1016,6 +1016,108 @@ public function sliceArray(Type $offsetType, Type $lengthType, TrinaryLogic $pre
10161016
return $builder->getArray();
10171017
}
10181018

1019+
public function spliceArray(Type $offsetType, Type $lengthType, Type $replacementType): Type
1020+
{
1021+
$keyTypesCount = count($this->keyTypes);
1022+
1023+
$offset = $offsetType instanceof ConstantIntegerType ? $offsetType->getValue() : null;
1024+
1025+
if ($lengthType instanceof ConstantIntegerType) {
1026+
$length = $lengthType->getValue();
1027+
} elseif ($lengthType->isNull()->yes()) {
1028+
$length = $keyTypesCount;
1029+
} else {
1030+
$length = null;
1031+
}
1032+
1033+
if ($offset === null || $length === null) {
1034+
return $this->degradeToGeneralArray()
1035+
->spliceArray($offsetType, $lengthType, $replacementType);
1036+
}
1037+
1038+
if ($keyTypesCount + $offset <= 0) {
1039+
// A negative offset cannot reach left outside the array twice
1040+
$offset = 0;
1041+
}
1042+
1043+
if ($keyTypesCount + $length <= 0) {
1044+
// A negative length cannot reach left outside the array twice
1045+
$length = 0;
1046+
}
1047+
1048+
$offsetWasNegative = false;
1049+
if ($offset < 0) {
1050+
$offsetWasNegative = true;
1051+
$offset = $keyTypesCount + $offset;
1052+
}
1053+
1054+
if ($length < 0) {
1055+
$length = $keyTypesCount - $offset + $length;
1056+
}
1057+
1058+
$extractType = $this->sliceArray($offsetType, $lengthType, TrinaryLogic::createYes());
1059+
1060+
$types = [];
1061+
foreach ($replacementType->toArray()->getArrays() as $replacementArrayType) {
1062+
$removeKeysCount = 0;
1063+
$optionalKeysBeforeReplacement = 0;
1064+
1065+
$builder = ConstantArrayTypeBuilder::createEmpty();
1066+
for ($i = 0;; $i++) {
1067+
$isOptional = $this->isOptionalKey($i);
1068+
1069+
if (!$offsetWasNegative && $i < $offset && $isOptional) {
1070+
$optionalKeysBeforeReplacement++;
1071+
}
1072+
1073+
if ($i === $offset + $optionalKeysBeforeReplacement) {
1074+
// When the offset is reached we have to a) put the replacement array in and b) remove $length elements
1075+
$removeKeysCount = $length;
1076+
1077+
if ($replacementArrayType instanceof self) {
1078+
$valuesArray = $replacementArrayType->getValuesArray();
1079+
for ($j = 0, $jMax = count($valuesArray->keyTypes); $j < $jMax; $j++) {
1080+
$builder->setOffsetValueType(null, $valuesArray->valueTypes[$j], $valuesArray->isOptionalKey($j));
1081+
}
1082+
} else {
1083+
$builder->degradeToGeneralArray();
1084+
$builder->setOffsetValueType($replacementArrayType->getValuesArray()->getIterableKeyType(), $replacementArrayType->getIterableValueType(), true);
1085+
}
1086+
}
1087+
1088+
if (!isset($this->keyTypes[$i])) {
1089+
break;
1090+
}
1091+
1092+
if ($removeKeysCount > 0) {
1093+
$extractTypeHasOffsetValueType = $extractType->hasOffsetValueType($this->keyTypes[$i]);
1094+
1095+
if (
1096+
(!$isOptional && $extractTypeHasOffsetValueType->yes())
1097+
|| ($isOptional && $extractTypeHasOffsetValueType->maybe())
1098+
) {
1099+
$removeKeysCount--;
1100+
continue;
1101+
}
1102+
}
1103+
1104+
if (!$isOptional && $extractType->hasOffsetValueType($this->keyTypes[$i])->maybe()) {
1105+
$isOptional = true;
1106+
}
1107+
1108+
$builder->setOffsetValueType(
1109+
$this->keyTypes[$i]->isInteger()->no() ? $this->keyTypes[$i] : null,
1110+
$this->valueTypes[$i],
1111+
$isOptional,
1112+
);
1113+
}
1114+
1115+
$types[] = $builder->getArray();
1116+
}
1117+
1118+
return TypeCombinator::union(...$types);
1119+
}
1120+
10191121
public function isIterableAtLeastOnce(): TrinaryLogic
10201122
{
10211123
$keysCount = count($this->keyTypes);

‎src/Type/IntersectionType.php‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -910,6 +910,11 @@ public function sliceArray(Type $offsetType, Type $lengthType, TrinaryLogic $pre
910910
return $result;
911911
}
912912

913+
public function spliceArray(Type $offsetType, Type $lengthType, Type $replacementType): Type
914+
{
915+
return $this->intersectTypes(static fn (Type $type): Type => $type->spliceArray($offsetType, $lengthType, $replacementType));
916+
}
917+
913918
public function getEnumCases(): array
914919
{
915920
$compare = [];

0 commit comments

Comments
 (0)