Document PHPUnit mocks with intersection types #9318
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
derrabus
commented
Jan 2, 2022
| } | ||
|
|
||
| protected function addMockFilterCollection(EntityManagerInterface $em): FilterCollection | ||
| /** | ||
| * @psalm-param EntityManagerInterface&MockObject $em |
There was a problem hiding this comment.
Note: I'm using @psalm-param instead of @param because CodeSniffer will do strange this otherwise, see squizlabs/PHP_CodeSniffer#2887.
derrabus
force-pushed
the
types/mock-intersection
branch
from
715604d
to
538f886
Compare
greg0ire
approved these changes
Jan 2, 2022
derrabus
added a commit
to derrabus/orm
that referenced
this pull request
Jan 2, 2022
* 2.10.x: Run static analysis with language level PHP 8.1 (doctrine#9314) Document PHPUnit mocks with intersection types (doctrine#9318)
derrabus
added a commit
to derrabus/orm
that referenced
this pull request
Jan 2, 2022
* 2.10.x: Run static analysis with language level PHP 8.1 (doctrine#9314) Document PHPUnit mocks with intersection types (doctrine#9318)
derrabus
added a commit
to derrabus/orm
that referenced
this pull request
Jan 2, 2022
* 2.11.x: Run static analysis with language level PHP 8.1 (doctrine#9314) Document LockMode enums (doctrine#9319) Document PHPUnit mocks with intersection types (doctrine#9318) Run PHP CodeSniffer on PHP 8.1 (doctrine#9317) Psalm 4.17.0 (doctrine#9315) Run static analysis on PHP 8.1 (doctrine#9310)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PHPUnit's
createMock()will return an object that extends the mocked type and implementsMockObjectat the same time. The accurate way to document this is an intersection type, but we often document a union type instead. This declaration is too wide because virtally any mock object would pass it.This might look nit-picking now, but it will become more important later when we try to infer native types from the docblock types in an automated manner.