Clarify static return type of MessageTrait methods#629
Open
braindawg wants to merge 2 commits intoguzzle:2.8from
Open
Clarify static return type of MessageTrait methods#629braindawg wants to merge 2 commits intoguzzle:2.8from
braindawg wants to merge 2 commits intoguzzle:2.8from
Conversation
Per the PSR spec, the methods currently hinting MessageInterface should be returning `static`. That was not supported until PHP 8.0, so to maintain PHP 7 compatibility, a docblock can be used to clarify the return behavior of these methods. Closes guzzle#617.
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.
Per the PSR spec (and the code), the methods on
MessageTraitcurrently hintingMessageInterfaceshould be returningstatic. That return type was not supported until PHP 8.0, so to maintain PHP 7 compatibility, a docblock can be used to clarify the return behavior of these methods.This should appease static analyzers that throw errors when these methods are used on more specific implementations of
MessageInterface.Closes #617, which should hopefully explain the benefit of this change. Happy to clarify if not.