Fix incorrect @return phpdoc types in Client class#371
Open
sawirricardo wants to merge 1 commit into
Open
Conversation
The Client methods (post, put, delete, options) documented their return type as \stdClass, but json_decode() returns array for JSON arrays. This caused phpstan errors for users expecting the documented type. The HttpClient::request() method already correctly documents \stdClass|array. Update all Client method phpdocs to match. Fixes woocommerce#329
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.
Problem
The
Clientmethods (post,put,delete,options) document their return type as\stdClass, butjson_decode()(used inHttpClient::processResponse()) returns anarraywhen the JSON response is a JSON array. This causes phpstan/phpcs type-checking errors for users who rely on the documented return type.See issue #329 for details.
Solution
Update the
@returnphpdoc onpost(),put(),delete(), andoptions()from\stdClassto\stdClass|array, which is consistent with the existing phpdoc onHttpClient::request()andHttpClient::processResponse().Changes
src/WooCommerce/Client.php: Updated@returntags onpost(),put(),delete(), andoptions()methods.Fixes #329