Document possibly-null member variables #8945
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
reviewed
Aug 22, 2021
| use ReflectionClass; | ||
| use TypeError; | ||
|
|
||
| use function array_map; | ||
| use function array_merge; | ||
| use function assert; |
There was a problem hiding this comment.
Oh right, it's a remnant from a first attempt at fixing this, I'll remove it 👍
Many of the variables in AbstractHydrator are not initialized in the constructor, and should be documented as possibly null because of that. Introducing accessors that perform null checks allows to to have to do these null checks when using the accessors. Making the member variables private would be a backwards-compatibility break and could be considered for the next major version. This makes Psalm's and PHPStan's baselines smaller, and should make implementing new hydrators easier.
greg0ire
force-pushed
the
document-possible-null-variable
branch
from
626016a to
af4ecba
Compare
derrabus
approved these changes
Aug 22, 2021
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.
Many of the variables in
AbstractHydratorare not initialized in theconstructor, and should be documented as possibly null because of that.
Introducing accessors that perform null checks allows to to have to do
these null checks when using the accessors.
Making the member variables private would be a backwards-compatibility
break and could be considered for the next major version.
This makes Psalm's and PHPStan's baselines smaller, and should make
implementing new hydrators easier.
This should help with #8919