False positives on array access on iterable property with PHPDoc type that allows it

[julienfalque]

Bug report

Given a property with native type iterable and PHPDoc type that allows array access, e.g. array, reading or writing to this property using array access is reported as an error.

Code snippet that reproduces the problem

<?php

class Foo
{
    /** @var list<string>|(\ArrayAccess<int, string>&iterable<int, string>) */
    private iterable $values;

    /**
     * @param list<string> $values
     */
    public function update(array $values): void {
        foreach ($this->values as $key => $_) {
            unset($this->values[$key]);
        }

        foreach ($values as $value) {
            $this->values[] = $value;
        }
    }
}

PHPStan reports the following errors:

13 | Cannot access offset int on (ArrayAccess<int, string>&iterable<int, string>)\|iterable<int, string>.
-- | --
17 | Cannot access an offset on iterable<int, string>.

https://phpstan.org/r/42af72fd-760d-4132-8e1b-14449f2efe59

Expected output

No errors

[ondrejmirtes]

The problem is that having:

• list<string>|(\ArrayAccess<int, string>&iterable<int, string>) in PHPDoc
• iterable in the native type

leads to (ArrayAccess<int, string>&iterable<int, string>)|iterable<int, string> actual type: https://phpstan.org/r/c85fad6d-0047-4f3f-a5f9-a41753298935

So that's what we need to solve here.

[julienfalque]

phpstan/phpstan-src#891 solves that by keeping the PHPDoc type as-is. I had to change a few existing tests but that seemed legit to me. Are there use cases I am missing that would require a different fix?

[phpstan-bot]

@julienfalque After the latest commit in dev-master, PHPStan now reports different result with your code snippet:

@@ @@
-13: Cannot access offset int on (ArrayAccess<int, string>&iterable<int, string>)|iterable<int, string>.
+13: Cannot access offset int on iterable<int, string>.
 17: Cannot access an offset on iterable<int, string>.

Full report

Line	Error
13	Cannot access offset int on iterable<int, string>.
17	Cannot access an offset on iterable<int, string>.

[phpstan-bot]

@ondrejmirtes After the latest commit in dev-master, PHPStan now reports different result with your code snippet:

@@ @@
 12: Dumped type: (ArrayAccess<int, string>&iterable<int, string>)|iterable<int, string>
-14: Cannot access offset int on (ArrayAccess<int, string>&iterable<int, string>)|iterable<int, string>.
+14: Cannot access offset int on iterable<int, string>.
 18: Cannot access an offset on iterable<int, string>.

Full report

Line	Error
12	`Dumped type: (ArrayAccess<int, string>&iterable<int, string>)
14	Cannot access offset int on iterable<int, string>.
18	Cannot access an offset on iterable<int, string>.

[phpstan-bot]

@julienfalque After the latest commit in 1.7.x, PHPStan now reports different result with your code snippet:

@@ @@
-13: Cannot access offset int on (ArrayAccess<int, string>&iterable<int, string>)|iterable<int, string>.
 17: Cannot access an offset on iterable<int, string>.

Full report

Line	Error
17	Cannot access an offset on iterable<int, string>.

[phpstan-bot]

@ondrejmirtes After the latest commit in 1.7.x, PHPStan now reports different result with your code snippet:

@@ @@
 12: Dumped type: (ArrayAccess<int, string>&iterable<int, string>)|iterable<int, string>
-14: Cannot access offset int on (ArrayAccess<int, string>&iterable<int, string>)|iterable<int, string>.
 18: Cannot access an offset on iterable<int, string>.

Full report

Line	Error
12	`Dumped type: (ArrayAccess<int, string>&iterable<int, string>)
18	Cannot access an offset on iterable<int, string>.

[phpstan-bot]

@julienfalque After the latest push in 1.9.x, PHPStan now reports different result with your code snippet:

@@ @@
-13: Cannot access offset int on (ArrayAccess<int, string>&iterable<int, string>)|iterable<int, string>.
-17: Cannot access an offset on iterable<int, string>.
+No errors

[phpstan-bot]

@ondrejmirtes After the latest push in 1.9.x, PHPStan now reports different result with your code snippet:

@@ @@
-12: Dumped type: (ArrayAccess<int, string>&iterable<int, string>)|iterable<int, string>
-14: Cannot access offset int on (ArrayAccess<int, string>&iterable<int, string>)|iterable<int, string>.
-18: Cannot access an offset on iterable<int, string>.
+12: Dumped type: list<string>|(ArrayAccess<int, string>&iterable<int, string>)

Full report

Line	Error
12	`Dumped type: list

[github-actions]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.