Keep relationship data when linking items from included #97
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.
Description
I've changed the relationship classes so they can store both data and included.
Motivation and context
#89 fixed a bug where meta in relationship data was ignored. However, when an item that has meta in it's relationship data is included, it is overwritten by the item from the included. Removing access to that meta.
Use case
Given the following JSON:
It was not possible to use the meta from the relationship (
{"a": "foo"}
), as the entire item would be overwritten by the included item. So when you get the meta from the related item, you getnull
as there is no meta in included.New situation
$document->getData()->getRelation('child')->getData()->getMeta()
>{"a": "foo"}
$document->getData()->getRelation('child')->getIncluded()->getMeta()
or$document->getData()->child->getMeta()
>null
N.B.
To make this fix backwards compatible, a relationship's included is filled, even when the item(s) are not actually included. In the next major version, we can choose to make this more strict and only fill the included when the item is actually included.
How has this been tested?
I've added new tests.
Types of changes
What types of changes does your code introduce? Put an
x
in all the boxes that apply:Checklist:
Go over all the following points, and put an
x
in all the boxes that apply.