Translate comment into code and annotations #11294
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
Feb 24, 2024
src/Mapping/ClassMetadata.php
Outdated
| */ | ||
| public function fullyQualifiedClassName(string|null $className): string|null | ||
| { | ||
| if (empty($className)) { | ||
| if ($className === null) { | ||
| return $className; |
There was a problem hiding this comment.
Let's do return null; instead?
| * @return string|null null if and only if the input value is null | ||
| * @psalm-return (C is string ? string : null) | ||
| * | ||
| * @template C of string|null | ||
| */ | ||
| public function fullyQualifiedClassName(string|null $className): string|null |
There was a problem hiding this comment.
Does it make sense to call this method with null? Should we rather deprecate that case?
There was a problem hiding this comment.
I think it would. Right now, it is only useful for a call from setCustomRepositoryClass. Let me push an extra commit that adds the deprecation.
The phpdoc comment for the return type of ClassMetadata::fullyQualifiedClassName() says that the return type will be null if the input value is null. I have made it more precise by using "if and only if", made the null check more strict and translated that into template annotations. Also, since we say we return a class-string, I've asserted that.
derrabus
reviewed
Feb 24, 2024
derrabus
reviewed
Feb 25, 2024
src/Mapping/ClassMetadata.php
Outdated
Comment on lines
2007
to
2011
| if ($repositoryClassName === null) { | ||
| $this->customRepositoryClassName = null; | ||
| } |
It can easily be avoided by the only caller.
derrabus
approved these changes
Feb 25, 2024
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.
The phpdoc comment for the return type of
ClassMetadata::fullyQualifiedClassName()says that the return type will be null if the input value is null. I have made it more precise by using "if and only if", made the null check more strict and translated that into template annotations. Also, since we say we return a class-string, I've asserted that.