Introduce __unserialize behaviour in docs #9390
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
derrabus
reviewed
Jan 17, 2022
docs/en/reference/architecture.rst
Outdated
Comment on lines
88
to
90
| - PHP 7.4 introduces the new magic method ``__unserialize``, which changes the execution | ||
| priority between ``__wakeup`` and itself when used. This can cause unexpected behaviour in | ||
| an Entity. |
There was a problem hiding this comment.
I'd simply apply the same warning as for __wakeup() because effectively __unserialize() replaces __wakeup() if it's present.
Also, we should remove the recommendation to implement Serializable because that interface is considered deprecated. And cookbook/implementing-wakeup-or-clone might need adjustments as well.
There was a problem hiding this comment.
I agree. __unserialize() isn't something that can be added lightly to an entity, but should we discourage from using it as long as ORM can't use this method in entities? Currently it shouldn't be used there. I expect that a future version will deprecate __wakeup() in favour of __unserialize().
derrabus
approved these changes
Jan 30, 2022
derrabus
added a commit
to derrabus/orm
that referenced
this pull request
Jan 30, 2022
* 2.12.x: Introduce __unserialize behaviour in docs (doctrine#9390) Adapt test logic to PHP and SQLite II (doctrine#9442) Use the identify generator strategy Added php 8.1 to CI Psalm 4.19.0, PHPStan 1.4.3 (doctrine#9438) Ignore PHPUnit result cache everywhere (doctrine#9425)
derrabus
added a commit
to derrabus/orm
that referenced
this pull request
Jan 30, 2022
* 2.12.x: Introduce DoctrineSetup as a replacement for Setup (doctrine#9443) Introduce __unserialize behaviour in docs (doctrine#9390) Adapt test logic to PHP and SQLite II (doctrine#9442) Use the identify generator strategy Added php 8.1 to CI Psalm 4.19.0, PHPStan 1.4.3 (doctrine#9438) Ignore PHPUnit result cache everywhere (doctrine#9425)
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.
I'm not sure about the detail in which this should be described in the docs, which is why the first change is another list entry.
This PR mentions the magic method
__unserialize()in entities.__wakeupis already considered a problem when used in an entity and__unserialize()introduces a new behaviour that should be mentioned in the docs: https://3v4l.org/EQ90PIt probably needs a link to the the new methods and maybe a more detailed description about how it should be handled.