-
Notifications
You must be signed in to change notification settings - Fork 7.9k
Partially deprecate Serializable #6494
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Hm, looks like |
31ccf91
to
807e5c2
Compare
|
||
?> | ||
--EXPECTF-- | ||
Deprecated: The Serializable interface is deprecated. If you need to retain the Serializable interface for cross-version compatibility, you can suppress this warning by implementing __serialize() and __unserialize() in addition, which will take precedence over Serializable in PHP versions that support them in %s on line 6 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Deprecated: The Serializable interface is deprecated. If you need to retain the Serializable interface for cross-version compatibility, you can suppress this warning by implementing __serialize() and __unserialize() in addition, which will take precedence over Serializable in PHP versions that support them in %s on line 6 | |
Deprecated: The Serializable interface is deprecated. For cross-version compatibility, also implement __serialize() and __unserialize() which take precedente over Serializable in %s on line 6 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Deprecated: The Serializable interface is deprecated. If you need to retain the Serializable interface for cross-version compatibility, you can suppress this warning by implementing __serialize() and __unserialize() in addition, which will take precedence over Serializable in PHP versions that support them in %s on line 6 | |
Deprecated: The Serializable interface is deprecated. Implement __serialize() and __unserialize() instead (or in addition, if support for old PHP versions or serialization payloads needs to be retained) in %s on line 6 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the main thing I want to convey here is that the alternative is __serialize/__unserialize, and you only need both for supporting multiple versions, otherwise you don't.
807e5c2
to
2d81670
Compare
If Serializable is implemented, require that __serialize() and __unserialize() are implemented as well, else issue a deprecation warning.
2d81670
to
f811e57
Compare
f811e57
to
9154c53
Compare
New sniff which addresses the following deprecation in PHP 8.1: > **Implementing Serializable without `__serialize()` and `__unserialize()`** > > Either only the new methods should be implemented, if no support for PHP prior to version 7.4 is provided, or both should be implemented. This sniff will throw a warning when a class implements the `Serializable` interface, but does not implement the magic `__serialize()` and `__unserialize()` methods. The sniff contains a `public` `$serializableInterfaces` property for users to provide their own list of additional interfaces (which extend the `Serializable` interface) to scan for. If the sniff comes across an interface declaration extending the `Serializable` interface and the interface is not in the user provided `$serializableInterfaces` list, a warning will be thrown for the user to add the interface to the property via a custom ruleset. Additionally, when the `testVersion` has a minimum PHP version of `7.4` or higher, an additional check is executed: * For interfaces directly extending `Serializable` AND containing a declaration of both the `__serialize()` as well as the `__unserialize()` magic method, thus enforcing the implementation of these methods in classes implementing the interface, a warning will be thrown that the extension of the `Serializable` interface can be removed. * For classes which implement the `Serializable` interface AND contain a declaration of both the `__serialize()` as well as the `__unserialize()` magic method, a warning will be thrown that the implementation of the `Serializable` interface can be removed. Includes unit tests. Includes updating the section about available custom properties in the README. Refs: * https://www.php.net/manual/en/migration81.deprecated.php#migration81.deprecated.core.serialize-interface * https://wiki.php.net/rfc/phase_out_serializable * https://www.php.net/manual/en/class.serializable.php * https://www.php.net/manual/en/language.oop5.magic.php#object.serialize * php/php-src#6494 * php/php-src@3e6b447
New sniff which addresses the following deprecation in PHP 8.1: > **Implementing Serializable without `__serialize()` and `__unserialize()`** > > Either only the new methods should be implemented, if no support for PHP prior to version 7.4 is provided, or both should be implemented. This sniff will throw a warning when a class implements the `Serializable` interface, but does not implement the magic `__serialize()` and `__unserialize()` methods. The sniff contains a `public` `$serializableInterfaces` property for users to provide their own list of additional interfaces (which extend the `Serializable` interface) to scan for. If the sniff comes across an interface declaration extending the `Serializable` interface and the interface is not in the user provided `$serializableInterfaces` list, a warning will be thrown for the user to add the interface to the property via a custom ruleset. Additionally, when the `testVersion` has a minimum PHP version of `7.4` or higher, an additional check is executed: * For interfaces directly extending `Serializable` AND containing a declaration of both the `__serialize()` as well as the `__unserialize()` magic method, thus enforcing the implementation of these methods in classes implementing the interface, a warning will be thrown that the extension of the `Serializable` interface can be removed. * For classes which implement the `Serializable` interface AND contain a declaration of both the `__serialize()` as well as the `__unserialize()` magic method, a warning will be thrown that the implementation of the `Serializable` interface can be removed. Includes unit tests. Includes updating the section about available custom properties in the README. Refs: * https://www.php.net/manual/en/migration81.deprecated.php#migration81.deprecated.core.serialize-interface * https://wiki.php.net/rfc/phase_out_serializable * https://www.php.net/manual/en/class.serializable.php * https://www.php.net/manual/en/language.oop5.magic.php#object.serialize * php/php-src#6494 * php/php-src@3e6b447
RFC: https://wiki.php.net/rfc/phase_out_serializable
If Serializable is implemented, require that __serialize() and
__unserialize() are implemented as well, else issue a deprecation
warning.