Improve return types with conditional statements #283
Conversation
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The
country()andcountries()helpers' return types depend on the value of the$hydrateparameter: in particular,country()might return either an array or aCountryinstance. This is a problem for static analysis tools like PHPStan, that are unable to correctly determine the return type.This PR improves the return type annotations to conditionally determine the return type based on the the value of the parameter.
This is based on PHPStan syntax. Alternatively, if you prefer not to change the
@returnannotation, it is possible to add this as@phpstan-returnannotation.