Skip to content

Do not report non existent offset for invalid ones #4385

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

Merged
merged 1 commit into from
Oct 2, 2025
Merged

Do not report non existent offset for invalid ones #4385

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 19 additions & 5 deletions src/Rules/Arrays/NonexistentOffsetInArrayDimFetchCheck.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@
use PHPStan\Rules\RuleLevelHelper;
use PHPStan\Type\BenevolentUnionType;
use PHPStan\Type\ErrorType;
use PHPStan\Type\NeverType;
use PHPStan\Type\Type;
use PHPStan\Type\TypeCombinator;
use PHPStan\Type\TypeUtils;
use PHPStan\Type\VerbosityLevel;
use function count;
Expand Down Expand Up @@ -60,6 +62,14 @@ public function check(
}

if ($type->hasOffsetValueType($dimType)->no()) {
if ($type->isArray()->yes()) {
$validArrayDimType = TypeCombinator::intersect(AllowedArrayKeysTypes::getType(), $dimType);
if ($validArrayDimType instanceof NeverType) {
// Already reported by InvalidKeyInArrayDimFetchRule
return [];
}
}

return [
RuleErrorBuilder::message(sprintf('Offset %s does not exist on %s.', $dimType->describe(count($dimType->getConstantStrings()) > 0 ? VerbosityLevel::precise() : VerbosityLevel::value()), $type->describe(VerbosityLevel::value())))
->identifier('offsetAccess.notFound')
Expand All @@ -76,28 +86,32 @@ public function check(
$flattenedTypes = TypeUtils::flattenTypes($type);
}

$validArrayDimType = TypeCombinator::intersect(AllowedArrayKeysTypes::getType(), $dimType);

foreach ($flattenedTypes as $innerType) {
$dimTypeToCheck = $innerType->isArray()->yes() ? $validArrayDimType : $dimType;
Copy link
Contributor Author

@VincentLanglet VincentLanglet Oct 2, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This only apply to array because we just have InvalidKeyInArrayDimFetchRule.

But you considered maybe extending the rule to String.

I wonder if in another PR we should create something like

  • isOffsetValueTypeLegal(Type $offsetType, PHPVersion $phpVersion) (with maybe a strict param...)
  • ArrayType::isOffsetValueTypeLegal rely on AllowedArrayKeysTypes::getType`
  • We use isOffsetValueTypeLegal in InvalidKeyInArrayDimFetchRule
  • And we use it here to filter the offsetDim

Dunno... this topic does not seems to be easy ^^'


if (
$this->reportPossiblyNonexistentGeneralArrayOffset
&& $innerType->isArray()->yes()
&& !$innerType->isConstantArray()->yes()
&& !$innerType->hasOffsetValueType($dimType)->yes()
&& !$innerType->hasOffsetValueType($dimTypeToCheck)->yes()
) {
$report = true;
break;
}
if (
$this->reportPossiblyNonexistentConstantArrayOffset
&& $innerType->isConstantArray()->yes()
&& !$innerType->hasOffsetValueType($dimType)->yes()
&& !$innerType->hasOffsetValueType($dimTypeToCheck)->yes()
) {
$report = true;
break;
}
if ($dimType instanceof BenevolentUnionType) {
$flattenedInnerTypes = [$dimType];
if ($dimTypeToCheck instanceof BenevolentUnionType) {
$flattenedInnerTypes = [$dimTypeToCheck];
} else {
$flattenedInnerTypes = TypeUtils::flattenTypes($dimType);
$flattenedInnerTypes = TypeUtils::flattenTypes($dimTypeToCheck);
}
foreach ($flattenedInnerTypes as $innerDimType) {
if (
Expand Down
5 changes: 0 additions & 5 deletions tests/PHPStan/Levels/data/arrayOffsetAccess-3.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,5 @@
"message": "Invalid array key type DateTimeImmutable.",
"line": 17,
"ignorable": true
},
{
"message": "Offset DateTimeImmutable does not exist on array.",
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As expected, I reduce the duplicates from #4387

"line": 17,
"ignorable": true
}
]
25 changes: 0 additions & 25 deletions tests/PHPStan/Levels/data/arrayOffsetAccess-7.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,49 +1,24 @@
[
{
"message": "Offset int|object might not exist on array.",
"line": 19,
"ignorable": true
},
{
"message": "Possibly invalid array key type int|object.",
"line": 19,
"ignorable": true
},
{
"message": "Offset object|null might not exist on array.",
"line": 20,
"ignorable": true
},
{
"message": "Possibly invalid array key type object|null.",
"line": 20,
"ignorable": true
},
{
"message": "Offset DateTimeImmutable might not exist on array|ArrayAccess.",
"line": 26,
"ignorable": true
},
{
"message": "Possibly invalid array key type DateTimeImmutable.",
"line": 26,
"ignorable": true
},
{
"message": "Offset int|object might not exist on array|ArrayAccess.",
"line": 28,
"ignorable": true
},
{
"message": "Possibly invalid array key type int|object.",
"line": 28,
"ignorable": true
},
{
"message": "Offset object|null might not exist on array|ArrayAccess.",
"line": 29,
"ignorable": true
},
{
"message": "Possibly invalid array key type object|null.",
"line": 29,
Expand Down
5 changes: 0 additions & 5 deletions tests/PHPStan/Levels/data/stringOffsetAccess-3.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,5 @@
"message": "Invalid array key type stdClass.",
"line": 59,
"ignorable": true
},
{
"message": "Offset stdClass does not exist on array{baz: 21}|array{foo: 17, bar: 19}.",
"line": 59,
"ignorable": true
}
]
53 changes: 49 additions & 4 deletions tests/PHPStan/Rules/Arrays/NonexistentOffsetInArrayDimFetchRuleTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -949,10 +949,6 @@ public function testBugObject(): void
'Offset int|object does not exist on array{baz: 21}|array{foo: 17, bar: 19}.',
12,
],
[
'Offset object does not exist on array<string, int>.',
21,
],
]);
}

Expand Down Expand Up @@ -1049,6 +1045,55 @@ public function testBug13538(): void
]);
}

public function testPR4385(): void
{
$this->reportPossiblyNonexistentGeneralArrayOffset = true;
$this->reportPossiblyNonexistentConstantArrayOffset = true;

$this->analyse([__DIR__ . '/data/pr-4385.php'], [
[
'Offset int might not exist on array<int>.',
24,
],
[
'Offset string might not exist on array<int>.',
25,
],
[
'Offset array<int>|int might not exist on array<int>.',
28,
],
[
'Offset array<int>|string might not exist on array<int>.',
29,
],
[
'Offset 0|array<int> might not exist on array<int>.',
30,
],
[
'Offset int might not exist on array{string}.',
33,
],
[
'Offset string might not exist on array{string}.',
34,
],
[
'Offset array<int>|int might not exist on array{string}.',
37,
],
[
'Offset array<int>|string might not exist on array{string}.',
38,
],
[
'Offset array<int>|int might not exist on array<int>|string.',
41,
],
]);
}

public function testBug12805(): void
{
$this->reportPossiblyNonexistentGeneralArrayOffset = true;
Expand Down
43 changes: 43 additions & 0 deletions tests/PHPStan/Rules/Arrays/data/pr-4385.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
<?php

namespace Pr4385;

class Foo
{
/**
* @param array<int> $array
* @param int $int
* @param string $string
* @param object $object
* @param array{0: string} $constantArray
*
* @return void
*/
public function test($array, $int, $string, $object, $constantArray)
{
$arrayOrObject = rand(0, 1) ? $array : $object;
$arrayOrInt = rand(0, 1) ? $array : $int;
$arrayOrString = rand(0, 1) ? $array : $string;
$arrayOrZero = rand(0, 1) ? $array : 0;

$array[$array];
$array[$int];
$array[$string];
$array[$object]; // Reported by InvalidKeyInArrayDimFetchRule
$array[$arrayOrObject]; // Reported by InvalidKeyInArrayDimFetchRule
$array[$arrayOrInt];
$array[$arrayOrString];
$array[$arrayOrZero];

$constantArray[$array];
$constantArray[$int];
$constantArray[$string];
$constantArray[$object]; // Reported by InvalidKeyInArrayDimFetchRule
$constantArray[$arrayOrObject]; // Reported by InvalidKeyInArrayDimFetchRule
$constantArray[$arrayOrInt];
$constantArray[$arrayOrString];
$constantArray[$arrayOrZero]; // Reported by InvalidKeyInArrayDimFetchRule

$arrayOrString[$arrayOrInt];
}
}
Loading