Fix signatures of bsonSerialize() methods #1156
Merged
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
GromNaN
reviewed
Sep 8, 2023
| @@ -66,7 +67,7 @@ public function __construct(array $index) | |||
| * @see \MongoDB\Collection::createSearchIndexes() | |||
| * @see https://php.net/mongodb-bson-serializable.bsonserialize | |||
| */ | |||
| public function bsonSerialize(): object | |||
| public function bsonSerialize(): stdClass | |||
| { | |||
| return (object) $this->index; | |||
There was a problem hiding this comment.
The psalm inferred type is incorrect. $this->index is an array, so (object) $this->index cannot be anything different that stdClass.
Let's add this warnings to the baseline.
src/Model/SearchIndexInput.php:70:38: MoreSpecificReturnType: The declared return type 'stdClass' for MongoDB\Model\SearchIndexInput::bsonSerialize is more specific than the inferred return type 'object' (see https://psalm.dev/070)
There was a problem hiding this comment.
Known issue: vimeo/psalm#10019
GromNaN
approved these changes
Sep 8, 2023
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.
mongodb/mongo-php-driver#1449 changed the tentative return type of
MongoDB\BSON\Serializableto no longer allow anyobject(which was incorrect as we never supported returning any object other thanstdClassinstances), instead restricting it tostdClassinstances. This PR deals with the resulting deprecation notices emitted on PHP 8.1 and newer.