feat: implement isOffsetAccessLegal #3045

rajyan · 2024-05-05T02:26:42Z

Details about isOffsetAccessLegal are explained in phpstan/phpstan#8393

ref #1791 (comment)
closes phpstan/phpstan#8393
resolves phpstan/phpstan#10926

rajyan · 2024-05-05T03:22:40Z

tests/PHPStan/Rules/Arrays/NonexistentOffsetInArrayDimFetchRuleTest.php

+			[
+				'Cannot access offset \'a\' on array{a: 1, b: 1}|(Closure(): void).',
+				258,
+			],


This is the behavior I wanted to revert.
ClosureType (Object not implementing ArrayAcces) throws fatal error.

rajyan · 2024-05-05T05:09:30Z

src/Type/Traits/NonOffsetAccessibleTypeTrait.php

+	public function isOffsetAccessLegal(): TrinaryLogic
+	{
+		return TrinaryLogic::createYes();
+	}


The most important difference between isOffsetAccessible is this line. Types like integer, boolean are not offset accessible but doesn't throw a fatal error on access in isset.

I don't like this being added to a trait with a name like this. I'd like a separate trait for this method that would be used in all the places where relevant. Or maybe no trait at all, and just put this implementation in all the places where it applies.

rajyan · 2024-05-05T06:13:47Z

src/Rules/Arrays/NonexistentOffsetInArrayDimFetchRule.php

@@ -64,7 +64,7 @@ public function processNode(Node $node, Scope $scope): array
 			return [];
 		}

-		if ($scope->isUndefinedExpressionAllowed($node) && !$isOffsetAccessible->no()) {
+		if ($scope->isUndefinedExpressionAllowed($node) && $isOffsetAccessibleType->isOffsetAccessLegal()->yes()) {


Maybe it's better to add a tip for !$isOffsetAccessibleType->isOffsetAccessLegal()->yes() case.

The isOffsetAccessibleType should be narrowed down to a type excluding ObjectType that do not implement ArrayAccess::class

The class implementing ArrayAccess::Class should be marked final

The class implementing ArrayAccess::Class should be marked final

I don't get this part. It doesn't matter if a class is final when it already implements ArrayAccess. What a finality of such class would achieve?

This was just a mistake. I was mixed up with the fact that we cant say isOffsetAccessLegal()->no() if the class is not final, because child class might implement ArrayClass.

phpstan/phpstan#10926 (comment)

phpstan-bot · 2024-05-05T06:14:52Z

This pull request has been marked as ready for review.

ondrejmirtes

Otherwise awesome! 👍

ondrejmirtes · 2024-05-06T12:47:26Z

src/Type/Traits/NonOffsetAccessibleTypeTrait.php

+	public function isOffsetAccessLegal(): TrinaryLogic
+	{
+		return TrinaryLogic::createYes();
+	}


I don't like this being added to a trait with a name like this. I'd like a separate trait for this method that would be used in all the places where relevant. Or maybe no trait at all, and just put this implementation in all the places where it applies.

ondrejmirtes · 2024-05-06T12:48:25Z

src/Rules/Arrays/NonexistentOffsetInArrayDimFetchRule.php

@@ -64,7 +64,7 @@ public function processNode(Node $node, Scope $scope): array
 			return [];
 		}

-		if ($scope->isUndefinedExpressionAllowed($node) && !$isOffsetAccessible->no()) {
+		if ($scope->isUndefinedExpressionAllowed($node) && $isOffsetAccessibleType->isOffsetAccessLegal()->yes()) {


The class implementing ArrayAccess::Class should be marked final

I don't get this part. It doesn't matter if a class is final when it already implements ArrayAccess. What a finality of such class would achieve?

rajyan · 2024-05-07T01:38:47Z

tests/PHPStan/Rules/Arrays/NonexistentOffsetInArrayDimFetchRuleTest.php

+			[
+				"Cannot access offset 'path' on iterable<int|string, object>.",
+				26,
+			],


ref https://3v4l.org/hIimN

ondrejmirtes

One levels test needs updating (just re-run it and commit the generated JSON), thanks

ondrejmirtes · 2024-05-07T05:53:58Z

src/Type/NonexistentParentClassType.php

@@ -152,6 +152,11 @@ public function toArrayKey(): Type
 		return new ErrorType();
 	}

+	public function isOffsetAccessLegal(): TrinaryLogic
+	{
+		return TrinaryLogic::createYes();


I think this should be no, and I think we can test it with $p = new parent(); and trying offset access on that.

You are definitely right! Thank you.

Also, found an interesting result that NonExistentParentClassType behavior has changed from 7.4.

We cannot even declare a NonExistentParentClassType from PHP 8.0.
https://3v4l.org/7TR10

Calling array access is an error across all versions.
https://3v4l.org/ClM1B

We can just skip the file from linting in Makefile

phpstan-src/Makefile

Line 76 in 78d3d99

--exclude tests/PHPStan/Rules/Classes/data/instantiation-promoted-properties.php \

ondrejmirtes · 2024-05-07T12:18:43Z

Awesome, thank you!

rajyan · 2024-05-07T12:20:50Z

Thank you for your swift responses as always!

rajyan commented May 5, 2024

View reviewed changes

rajyan force-pushed the feat/offset-access-legal branch from 39c88e3 to e65f4c2 Compare May 5, 2024 03:43

rajyan added 2 commits May 5, 2024 12:43

feat: implement isOffsetAccessLegal

5277d55

feat: use isOffsetAccessLegal in NonexistentOffsetInArrayDimFetchRule

b81633f

rajyan force-pushed the feat/offset-access-legal branch from e65f4c2 to 7e26cd7 Compare May 5, 2024 03:43

rajyan added 2 commits May 5, 2024 13:04

test: add test for issue-10926

461cb89

test: add test for offset access legal

ed98710

rajyan force-pushed the feat/offset-access-legal branch from 7e26cd7 to ed98710 Compare May 5, 2024 04:05

fix: fix isOffsetAccessLegal for mixed type

b012509

rajyan commented May 5, 2024

View reviewed changes

rajyan marked this pull request as ready for review May 5, 2024 06:14

rajyan mentioned this pull request May 5, 2024

Feat/offset access legal additional #3046

Closed

ondrejmirtes requested changes May 6, 2024

View reviewed changes

rajyan added 4 commits May 7, 2024 09:58

chore: fix miss-leading comments

fbf47dd

fix: move isOffsetAccessLegal out of trait

6ed2ea6

fix: fix MaybeObjectType isOffsetAccessLegal

dbfc3b8

fix: callable and iterable are maybe not isOffsetAccessLegal

4b4af8e

rajyan commented May 7, 2024

View reviewed changes

ondrejmirtes requested changes May 7, 2024

View reviewed changes

rajyan added 3 commits May 7, 2024 20:56

fix: NonexistentParentClassType is not offsetAccessLegal

631a3a1

test: update levels test behavior for array access to iterator

d7951a7

chore: fix lint

9b18667

ondrejmirtes merged commit e55a83f into phpstan:1.11.x May 7, 2024
443 of 444 checks passed

rajyan deleted the feat/offset-access-legal branch May 7, 2024 12:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: implement isOffsetAccessLegal #3045

feat: implement isOffsetAccessLegal #3045

rajyan commented May 5, 2024 •

edited

rajyan May 5, 2024 •

edited

rajyan May 5, 2024

ondrejmirtes May 6, 2024

rajyan May 5, 2024 •

edited

ondrejmirtes May 6, 2024

rajyan May 7, 2024

phpstan-bot commented May 5, 2024

ondrejmirtes left a comment

ondrejmirtes May 6, 2024

ondrejmirtes May 6, 2024

rajyan May 7, 2024

ondrejmirtes left a comment

ondrejmirtes May 7, 2024

rajyan May 7, 2024 •

edited

ondrejmirtes May 7, 2024

ondrejmirtes commented May 7, 2024

rajyan commented May 7, 2024

feat: implement isOffsetAccessLegal #3045

feat: implement isOffsetAccessLegal #3045

Conversation

rajyan commented May 5, 2024 • edited

rajyan May 5, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rajyan May 5, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

phpstan-bot commented May 5, 2024

ondrejmirtes left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ondrejmirtes left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rajyan May 7, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ondrejmirtes commented May 7, 2024

rajyan commented May 7, 2024

rajyan commented May 5, 2024 •

edited

rajyan May 5, 2024 •

edited

rajyan May 5, 2024 •

edited

rajyan May 7, 2024 •

edited