Update serialization mechanism #90
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
- Suggest suggest __serialize and __unserialize (previously discouraged) - Add sniff to discourage Serializable interface See - https://wiki.php.net/rfc/custom_object_serialization - https://www.php.net/manual/en/class.serializable.php
tfrommen
reviewed
Apr 16, 2024
shvlv
approved these changes
Apr 16, 2024
There was a problem hiding this comment.
We have to update documentation
php-coding-standards/README.md
Line 124 in 85e25cf
DisableSerializeInterfaceSniff.
Apart from that looks good 👍
- Added docs for DisableSerializeInterface - Updated docs for DisableMagicSerialize
tfrommen
approved these changes
Apr 17, 2024
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.
Currently we have a rule that discourages the usage of magic
__serializeand__unserializewhile suggesting usage of theSerializableinterface.That was the "state of the art" up to PHP 7.3, and the rule even predates that.
With PHP 7.4 the
Serializableinterface is not recommended anymore (the RFC define it as "severely broken").The new recommended method is to use
__serializeand__unserializemethods.Not being a major release PHP 7.4 did not deprecate
Serializable.PHP 8.1 triggers a deprecation warning if
Serializablewithout also having__serializeand__unserialize.And PHP 9 will probably remove the interface altogether.
Because v2 is PHP 7.4 we can safely discourage
Serializablealready and fully recommend__serializeand__unserialize.This PR does that by:
__serializeand__unserializeto actually suggest them where__sleepand__wakeupare usedSerializableinterface, suggesting__serializeand__unserializePlease check if the PR fulfills these requirements
What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
Feature.
What is the current behavior? (You can also link to an open issue here)
__serializeand__unserializeare discouragedSerializableinterface is suggestedWhat is the new behavior (if this is a feature change)?
__serializeand__unserializeare suggestedSerializableinterface is discouragedDoes this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)
Other information:
--