Skip to content

Fix phpstan/phpstan#13637: Array might not have offset, if array is deep #5203

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
phpstan-bot wants to merge 7 commits into
base: 2.1.x
Choose a base branch
from
+154 −0
Open

Fix phpstan/phpstan#13637: Array might not have offset, if array is deep #5203

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
73870d5
Fix deep nested array dim assignment marking keys as optional
github-actions[bot] Mar 11, 2026
72c1e75
Generalize deep nested array setExistingOffsetValueType for arbitrary…
phpstan-bot Mar 18, 2026
d3189c7
Add tests for 5 and 6 level deep nested array assignments
phpstan-bot Mar 18, 2026
d77e08d
Add assertType on $final inside and outside for loops in bug-13637 test
phpstan-bot Mar 19, 2026
263c20a
Use elseif for mutually exclusive constant array check
phpstan-bot Mar 19, 2026
1c9704b
Add unit tests for setExistingOffsetValueType with maybe-array item type
phpstan-bot Mar 19, 2026
3c21170
Convert setExistingOffsetValueType unit tests to NSRT tests
phpstan-bot Mar 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions src/Type/ArrayType.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -410,6 +410,26 @@ public function setExistingOffsetValueType(Type $offsetType, Type $valueType): T
}
}

if (
$this->itemType->isArray()->yes()
&& !$this->itemType->isConstantArray()->yes()
&& $valueType->isArray()->yes()
&& !$valueType->isConstantArray()->yes()
&& $this->itemType->getIterableValueType()->isArray()->yes()
&& $valueType->getIterableValueType()->isArray()->yes()
) {
$newItemType = $this->itemType->setExistingOffsetValueType(
$valueType->getIterableKeyType(),
$valueType->getIterableValueType(),
);
if ($newItemType !== $this->itemType) {
return new self(
$this->keyType,
$newItemType,
);
}
}

return new self(
$this->keyType,
TypeCombinator::union($this->itemType, $valueType),
Expand Down
118 changes: 118 additions & 0 deletions tests/PHPStan/Analyser/nsrt/bug-13637.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
<?php declare(strict_types = 1);

namespace Bug13637;

use function PHPStan\Testing\assertType;

/**
* @return array<int, array<int, array<int, array{abc: int, def: int, ghi: int}>>>
*/
function doesNotWork() : array {
$final = [];

for ($i = 0; $i < 5; $i++) {
$j = $i * 2;
$k = $j +1;
$l = $i * 3;
$final[$i][$j][$k]['abc'] = $i;
$final[$i][$j][$k]['def'] = $i;
$final[$i][$j][$k]['ghi'] = $i;

assertType("array{abc: int<0, 4>, def: int<0, 4>, ghi: int<0, 4>}", $final[$i][$j][$k]);
assertType("non-empty-array<int<0, 4>, non-empty-array<int<0, 8>, non-empty-array<int<1, 9>, array{abc: int<0, 4>, def: int<0, 4>, ghi: int<0, 4>}>>>", $final);
}

assertType("non-empty-array<int<0, 4>, non-empty-array<int<0, 8>, non-empty-array<int<1, 9>, array{abc: int<0, 4>, def: int<0, 4>, ghi: int<0, 4>}>>>", $final);
return $final;
}

/**
* @return array<int, array<int, array<int, array<int, array{abc: int, def: int, ghi: int}>>>>
*/
function fourLevelsDeep() : array {
$final = [];

for ($i = 0; $i < 5; $i++) {
$j = $i * 2;
$k = $j + 1;
$l = $i * 3;
$final[$i][$j][$k][$l]['abc'] = $i;
$final[$i][$j][$k][$l]['def'] = $i;
$final[$i][$j][$k][$l]['ghi'] = $i;

assertType("array{abc: int<0, 4>, def: int<0, 4>, ghi: int<0, 4>}", $final[$i][$j][$k][$l]);
assertType("non-empty-array<int<0, 4>, non-empty-array<int<0, 8>, non-empty-array<int<1, 9>, non-empty-array<int<0, 12>, array{abc: int<0, 4>, def: int<0, 4>, ghi: int<0, 4>}>>>>", $final);
}

assertType("non-empty-array<int<0, 4>, non-empty-array<int<0, 8>, non-empty-array<int<1, 9>, non-empty-array<int<0, 12>, array{abc: int<0, 4>, def: int<0, 4>, ghi: int<0, 4>}>>>>", $final);
return $final;
}

/**
* @return array<int, array<int, array<int, array<int, array<int, array{abc: int, def: int, ghi: int}>>>>>
*/
function fiveLevelsDeep() : array {
$final = [];

for ($i = 0; $i < 5; $i++) {
$j = $i * 2;
$k = $j + 1;
$l = $i * 3;
$m = $i + 10;
$final[$i][$j][$k][$l][$m]['abc'] = $i;
$final[$i][$j][$k][$l][$m]['def'] = $i;
$final[$i][$j][$k][$l][$m]['ghi'] = $i;

assertType("array{abc: int<0, 4>, def: int<0, 4>, ghi: int<0, 4>}", $final[$i][$j][$k][$l][$m]);
assertType("non-empty-array<int<0, 4>, non-empty-array<int<0, 8>, non-empty-array<int<1, 9>, non-empty-array<int<0, 12>, non-empty-array<int<10, 14>, array{abc: int<0, 4>, def: int<0, 4>, ghi: int<0, 4>}>>>>>", $final);
}

assertType("non-empty-array<int<0, 4>, non-empty-array<int<0, 8>, non-empty-array<int<1, 9>, non-empty-array<int<0, 12>, non-empty-array<int<10, 14>, array{abc: int<0, 4>, def: int<0, 4>, ghi: int<0, 4>}>>>>>", $final);
return $final;
}

/**
* @return array<int, array<int, array<int, array<int, array<int, array<int, array{abc: int, def: int, ghi: int}>>>>>>
*/
function sixLevelsDeep() : array {
$final = [];

for ($i = 0; $i < 5; $i++) {
$j = $i * 2;
$k = $j + 1;
$l = $i * 3;
$m = $i + 10;
$n = $i + 20;
$final[$i][$j][$k][$l][$m][$n]['abc'] = $i;
$final[$i][$j][$k][$l][$m][$n]['def'] = $i;
$final[$i][$j][$k][$l][$m][$n]['ghi'] = $i;

assertType("array{abc: int<0, 4>, def: int<0, 4>, ghi: int<0, 4>}", $final[$i][$j][$k][$l][$m][$n]);
assertType("non-empty-array<int<0, 4>, non-empty-array<int<0, 8>, non-empty-array<int<1, 9>, non-empty-array<int<0, 12>, non-empty-array<int<10, 14>, non-empty-array<int<20, 24>, array{abc: int<0, 4>, def: int<0, 4>, ghi: int<0, 4>}>>>>>>", $final);
}

assertType("non-empty-array<int<0, 4>, non-empty-array<int<0, 8>, non-empty-array<int<1, 9>, non-empty-array<int<0, 12>, non-empty-array<int<10, 14>, non-empty-array<int<20, 24>, array{abc: int<0, 4>, def: int<0, 4>, ghi: int<0, 4>}>>>>>>", $final);
return $final;
}

/**
* @return array<int, array<int, array{abc: int, def: int, ghi: int}>>
*/
function thisWorks() : array {
$final = [];

for ($i = 0; $i < 5; $i++) {
$j = $i * 2;
$k = $j +1;
$l = $i * 3;
$final[$i][$j]['abc'] = $i;
$final[$i][$j]['def'] = $i;
$final[$i][$j]['ghi'] = $i;

assertType("array{abc: int<0, 4>, def: int<0, 4>, ghi: int<0, 4>}", $final[$i][$j]);
assertType("non-empty-array<int<0, 4>, non-empty-array<int<0, 8>, array{abc: int<0, 4>, def: int<0, 4>, ghi: int<0, 4>}>>", $final);
}

assertType("non-empty-array<int<0, 4>, non-empty-array<int<0, 8>, array{abc: int<0, 4>, def: int<0, 4>, ghi: int<0, 4>}>>", $final);
return $final;
}
Loading