PHP 8.1: fix deprecation notice #919
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
As of PHP 8.1, PHP will start throwing deprecation warnings along the lines of: ``` Deprecated: Return type of [CLASS]::[METHOD]() should either be compatible with [PHP NATIVE INTERFACE]::[METHOD](): [TYPE], or the #[ReturnTypeWillChange] attribute should be used to temporarily suppress the notice ``` These type of deprecation notices relate to the [Return types for internal methods RFC](https://wiki.php.net/rfc/internal_method_return_types) in PHP 8.1. Basically, as of PHP 8.1, these methods in classes which implement PHP native interfaces are expected to have a return type declared. The return type can be the same as used in PHP itself or a more specific type. This complies with the Liskov principle of covariance, which allows the return type of a child overloaded method to be more specific than that of the parent. The return type for `JsonSerializable::jsonSerialize()` is supposed to be `mixed`, but as that is a PHP 8.0 type, it cannot yet be added. Ref: https://www.php.net/manual/en/class.jsonserializable.php With that in mind, I've added the annotation instead. Note: While attributes are a PHP 8.0 feature only, due to the syntax choice for `#[]`, they will ignored in PHP < 8 and can be safely added.
Merged
moorscode
added a commit
to Yoast/wordpress-seo
that referenced
this pull request
Oct 28, 2021
PHP Scoper is prefixing the attribute use statement that will need to be pulled into the TheLeague OAuth Client implenetation of the JSONSerializableInterface. See thephpleague/oauth2-client#919 This change removes the prefix from the use statement. PHP Scoper was updated to 0.15.0 during investigation of this issue and was not worked as desired on the newer version. Bumping the version in this commit seemed out of scope. This is addressed in the following ticket: humbug/php-scoper#539
jrfnl
pushed a commit
to Yoast/wordpress-seo
that referenced
this pull request
Oct 28, 2021
PHP Scoper is prefixing the attribute use statement that will need to be pulled into the TheLeague OAuth Client implenetation of the JSONSerializableInterface. See thephpleague/oauth2-client#919 This change removes the prefix from the use statement. PHP Scoper was updated to 0.15.0 during investigation of this issue and was not worked as desired on the newer version. Bumping the version in this commit seemed out of scope. This is addressed in the following ticket: humbug/php-scoper#539
|
👋 Hiya all! Anything I can do to move this (and my other PRs) forward ? All relatively small changes and atomic PRs, so would be great if they could get some traction.... |
|
I'll try to take a look and get them merged this week, @jrfnl. Thanks so much for contributing! |
Codecov Report
@@ Coverage Diff @@
## master #919 +/- ##
===========================================
Coverage 100.00% 100.00%
Complexity 180 180
===========================================
Files 20 20
Lines 464 464
===========================================
Hits 464 464 |
|
Thanks @ramsey, appreciated! |
jrfnl
pushed a commit
to Yoast/wordpress-seo
that referenced
this pull request
Nov 11, 2021
PHP Scoper is prefixing the attribute use statement that will need to be pulled into the TheLeague OAuth Client implenetation of the JSONSerializableInterface. See thephpleague/oauth2-client#919 This change removes the prefix from the use statement. PHP Scoper was updated to 0.15.0 during investigation of this issue and was not worked as desired on the newer version. Bumping the version in this commit seemed out of scope. This is addressed in the following ticket: humbug/php-scoper#539
Closed
|
Is there anything I can help with to get this PR merged? |
ramsey
approved these changes
Nov 29, 2021
jrfnl
pushed a commit
to Yoast/wordpress-seo
that referenced
this pull request
Nov 30, 2021
PHP Scoper is prefixing the attribute use statement that will need to be pulled into the TheLeague OAuth Client implenetation of the JSONSerializableInterface. See thephpleague/oauth2-client#919 This change removes the prefix from the use statement. PHP Scoper was updated to 0.15.0 during investigation of this issue and was not worked as desired on the newer version. Bumping the version in this commit seemed out of scope. This is addressed in the following ticket: humbug/php-scoper#539
jrfnl
pushed a commit
to Yoast/wordpress-seo
that referenced
this pull request
Nov 30, 2021
PHP Scoper is prefixing the attribute use statement that will need to be pulled into the TheLeague OAuth Client implenetation of the JSONSerializableInterface. See thephpleague/oauth2-client#919 This change removes the prefix from the use statement. PHP Scoper was updated to 0.15.0 during investigation of this issue and was not worked as desired on the newer version. Bumping the version in this commit seemed out of scope. This is addressed in the following ticket: humbug/php-scoper#539
jrfnl
pushed a commit
to Yoast/wordpress-seo
that referenced
this pull request
Dec 6, 2021
PHP Scoper is prefixing the attribute use statement that will need to be pulled into the TheLeague OAuth Client implenetation of the JSONSerializableInterface. See thephpleague/oauth2-client#919 This change removes the prefix from the use statement. PHP Scoper was updated to 0.15.0 during investigation of this issue and was not worked as desired on the newer version. Bumping the version in this commit seemed out of scope. This is addressed in the following ticket: humbug/php-scoper#539
jrfnl
pushed a commit
to Yoast/wordpress-seo
that referenced
this pull request
Dec 9, 2021
PHP Scoper is prefixing the attribute use statement that will need to be pulled into the TheLeague OAuth Client implenetation of the JSONSerializableInterface. See thephpleague/oauth2-client#919 This change removes the prefix from the use statement. PHP Scoper was updated to 0.15.0 during investigation of this issue and was not worked as desired on the newer version. Bumping the version in this commit seemed out of scope. This is addressed in the following ticket: humbug/php-scoper#539
|
Can we get a tag for this? Otherwise we cannot upgrade to PHP 8.1... |
jrfnl
pushed a commit
to Yoast/wordpress-seo
that referenced
this pull request
Dec 16, 2021
PHP Scoper is prefixing the attribute use statement that will need to be pulled into the TheLeague OAuth Client implenetation of the JSONSerializableInterface. See thephpleague/oauth2-client#919 This change removes the prefix from the use statement. PHP Scoper was updated to 0.15.0 during investigation of this issue and was not worked as desired on the newer version. Bumping the version in this commit seemed out of scope. This is addressed in the following ticket: humbug/php-scoper#539
jrfnl
pushed a commit
to Yoast/wordpress-seo
that referenced
this pull request
Dec 16, 2021
PHP Scoper is prefixing the attribute use statement that will need to be pulled into the TheLeague OAuth Client implenetation of the JSONSerializableInterface. See thephpleague/oauth2-client#919 This change removes the prefix from the use statement. PHP Scoper was updated to 0.15.0 during investigation of this issue and was not worked as desired on the newer version. Bumping the version in this commit seemed out of scope. This is addressed in the following ticket: humbug/php-scoper#539
|
Hi @ramsey, is there a plan for the next bugfix release which could contain that change? Imho it should be planned soon as its currently a blocker for many people for using PHP 8.1. WHats your opinion / the release schedule of this package on that? |
jrfnl
pushed a commit
to Yoast/wordpress-seo
that referenced
this pull request
Dec 20, 2021
PHP Scoper is prefixing the attribute use statement that will need to be pulled into the TheLeague OAuth Client implenetation of the JSONSerializableInterface. See thephpleague/oauth2-client#919 This change removes the prefix from the use statement. PHP Scoper was updated to 0.15.0 during investigation of this issue and was not worked as desired on the newer version. Bumping the version in this commit seemed out of scope. This is addressed in the following ticket: humbug/php-scoper#539
jrfnl
pushed a commit
to Yoast/wordpress-seo
that referenced
this pull request
Dec 23, 2021
PHP Scoper is prefixing the attribute use statement that will need to be pulled into the TheLeague OAuth Client implementation of the `JSONSerializable` interface. See thephpleague/oauth2-client#919 This change removes the prefix from the use statement. PHP Scoper was updated to 0.15.0 during investigation of this issue and it still does not work as desired on the newer version. Bumping the version in this commit seemed out of scope. PHP 8.1 compatibility for PHP Scoper is being tracked in the following ticket: humbug/php-scoper#539
1 task
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.
As of PHP 8.1, PHP will start throwing deprecation warnings along the lines of:
These type of deprecation notices relate to the Return types for internal methods RFC in PHP 8.1.
Basically, as of PHP 8.1, these methods in classes which implement PHP native interfaces are expected to have a return type declared.
The return type can be the same as used in PHP itself or a more specific type. This complies with the Liskov principle of covariance, which allows the return type of a child overloaded method to be more specific than that of the parent.
The return type for
JsonSerializable::jsonSerialize()is supposed to bemixed, but as that is a PHP 8.0 type, it cannot yet be added.Ref: https://www.php.net/manual/en/class.jsonserializable.php
With that in mind, I've added the annotation instead.
Note: While attributes are a PHP 8.0 feature only, due to the syntax choice for
#[], they will ignored in PHP < 8 and can be safely added.