Explicit type hint and magic methods for id #51
Merged
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 have added explicit (optional string) type hints to the
setId
andgetId
methods. This requires a change to the interface and can be breaking if you implement the interface yourself. Besides that, I have made the id accessible using magic methods.Motivation and context
According to the specification (https://jsonapi.org/format/#document-resource-object-identification), the id must always be a string when present. Making the id accessible via magic methods allows you to set/get the id just like any other attribute. This is useful for example if you want to pluck all ids of a collection of items.
How has this been tested?
Tested with new unit 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.