Use PHPStan 1 #2385
Use PHPStan 1 #2385
Conversation
| @@ -1356,7 +1363,7 @@ public function getCollection(): string | |||
| * Sets the collection this Document is mapped to. | |||
| * | |||
| * @param array|string $name | |||
| * @psalm-param array{name: string, capped?: bool, size?: int, max?: int}|string $name | |||
| * @psalm-param array{name?: string, capped?: bool, size?: int, max?: int}|string $name | |||
There was a problem hiding this comment.
Why this? name is actually required to be present in the array :)
There was a problem hiding this comment.
It was because of the isset check below, I've added treatPhpDocTypesAsCertain option as false which seems cleaner.
| @@ -243,6 +243,7 @@ public function matching(Criteria $criteria): ArrayCollection | |||
| } | |||
|
|
|||
| // @TODO: wrap around a specialized Collection for efficient count on large collections | |||
| /** @var Iterator<int, T> $iterator */ | |||
| $iterator = $queryBuilder->getQuery()->execute(); | |||
| assert($iterator instanceof Iterator); | |||
There was a problem hiding this comment.
I guess the assert can be removed now?
There was a problem hiding this comment.
yeah we can, I left it because if we reach level 6 of PHPStan or achieve to make query builder generic, we could get rid of the @var annotation, but we can remove it in the meanwhile.
| */ | ||
| protected $referencedChild; | ||
|
|
||
| /** | ||
| * @ODM\ReferenceMany(targetDocument=ChildDocumentWithoutDiscriminator::class) | ||
| * | ||
| * @var Collection<int, ChildDocumentWithDiscriminator> | ||
| * @var Collection<int, ChildDocumentWithDiscriminator>|array<ChildDocumentWithDiscriminator> |
There was a problem hiding this comment.
Personally I'm more for ChildDocumentWithDiscriminator[]. How do we tend to use these across the repository?
There was a problem hiding this comment.
I was using [] at first and then I changed them to this because I was getting (not in this case):
https://phpstan.org/r/3d620f33-b686-4cea-ad37-510b638b2845
Apparently that only happens when there is a default value of [] 🤔
There was a problem hiding this comment.
Weird, empty array should be good enough for anything array-ish :) Mind reporting it to PHPStan?
There was a problem hiding this comment.
I was looking at this and I found in https://phpstan.org/writing-php-code/phpdoc-types#iterables
These iterable rules are applied only when the Collection type isn’t generic. When it’s generic, generics rules for class-level type variables are applied.
If PHP encounters Collection|Foo[], two possible paths are taken:
Collection implements Traversable so Collection|Foo[] is interpreted as a Collection object that iterates over Foo. The array part isn’t applied.
Collection does not implement Traversable so Collection|Foo[] is interpreted as a Collection object or an array of Foo objects.
If Collection|Foo[] means "Collection or array" in your case even if Collection implements Traversable, you need to disambiguate the type by usingCollection|array<Foo>instead.
So this last paragraph explains this case, good to know.
franmomu
force-pushed
the
use_phpstan_1
branch
from
a31b144 to
1f3c5bf
Compare
franmomu
force-pushed
the
use_phpstan_1
branch
from
1f3c5bf to
5f4a863
Compare
|
Thanks @franmomu! |
Summary
It's made on top of #2383, once that is merge I'll rebase this one