Add #[\ReturnTypeWillChange] attribute for PHP 8.x compatibility. #339
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
2 participants
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.
Starting with PHP 8.1 the
JsonSerializableinterface has a return type ofmixedfor itsjsonSerializemethod which is implemented inMinishlink\WebPush\MessageSentReport.Adding a return type of
mixedwill break the library in all versions before PHP 8.1. Not making any changes will break the library in PHP 8.1.However, adding the attribute
#[\ReturnTypeWillChange]allows us to make no further changes but ensure the library will still work in all existing versions AND PHP 8.1.The attribute is entirely ignored in non-supporting PHP versions.
So, as per the contributing guidelines this has not been tested but you can see for yourself it does not in the slightest change the functionality so should be good to merge.
Note: There needs to be similar changes in the JWT libraries but I'll be doing some PRs for those too shortly.
Cheers!