Extending Doctrine ArrayCollection

[bramcordie]

I have a Custom collection class that extends Doctrine ArrayCollection, which has template annotations out of the box.

The ArrayCollection class has a filter method which I call from my custom collection to create a new collection instance with some items removed. When I try to set the return type for the function, that calls the original filter method, in my custom collection class to self I get an error telling me the return type should be ArrayCollection and not an instance of my custom collection.

If I remove the @psalm-return static<TKey,T> annotation from the filter method things work like I expect.
Can someone explain to me what is going on here?

Simplified versions of both the ArrayCollection and the custom class:
https://phpstan.org/r/7d36bc06-b81b-45c4-9f63-38dfaa0c5458

[ondrejmirtes]

Hi, static<TKey, T> is a very weird syntax, because you don't know what template type variables are the child classes going to use. I'm not sure how that should work.

But in your case @return static is sufficient: https://phpstan.org/r/626013ff-7559-4238-9ff4-95053f0d0a6c

[bramcordie]

OK, thanks for the confirmation.

That's actually an annotation used by the Doctrine Collection library, see: https://github.com/doctrine/collections/blob/1.6.x/lib/Doctrine/Common/Collections/ArrayCollection.php#L356.
It's used multiple times in the same file so It's probably intentional.

Psalm does not seem bothered about it but maybe it was left over after fixing: doctrine/collections#201.

If it is intentional and needed for Psalm, how do I deal with integrating this third party code in my own project running both Psalm and PHPStan? I know there's a bunch of workarounds I can do in the custom Collection class but I have multiple of those in my actual project. Can this be solved at a lower level?

[ondrejmirtes]

Please open a feature request and I'll think about it.

[bramcordie]

Will do once I figure things out from Doctrine's perspective. I dropped a comment there as well: doctrine/collections#201 (comment)

Thanks!

[ikvasnica]

Is there any update on this issue please? For now I can just ignore the whole line using ArrayCollection filter method :/

[ondrejmirtes]

@ikvasnica Please open a feature request and describe your problem in detail.