[12.x] feat: Make custom eloquent castings comparable for more granular isDirty check #55945
+102
−0
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.
This PR adds the ability to compare custom casted attributes to detect if a model attribute is dirty or not.
Some background:
Currently when a JSON field is used in the database and a cast to
object
orcollection
is used, the format{"key": "value", "key2": "value"}
and{"key":"value","key2":"value"}
will match and will not be flagged as dirty.The problem is that this isn't possible for custom casts (A good example would be spatie/laravel-data)
This PR doesn't solve the problem directly for JSON fields, but gives custom casts the possibility to give more granular control about how the values will be compared in the
originalIsEquivalent
method.This is done by checking if the attribute is casted by a class and if that custom caster has the method
compare
This also gives the ability to prevent dirty hits when the order of a JSON field is changed, There was a loose comparison but that was reverted in #41337