Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Explicit type hint and magic methods for id #51

Merged
merged 3 commits into from
Jul 1, 2019

Conversation

JaZo
Copy link
Member

@JaZo JaZo commented Jul 1, 2019

Description

I have added explicit (optional string) type hints to the setId and getId 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:

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

Go over all the following points, and put an x in all the boxes that apply.

  • I have read the CONTRIBUTING document.
  • My pull request addresses exactly one patch/feature.
  • I have created a branch for this patch/feature.
  • Each individual commit in the pull request is meaningful.
  • I have added tests to cover my changes.
  • If my change requires a change to the documentation, I have updated it accordingly.

@JaZo JaZo requested a review from vblinden July 1, 2019 10:11
@JaZo JaZo force-pushed the feature/magic-methods-for-id branch from 15ea8bb to 4bca753 Compare July 1, 2019 10:12
JaZo added 3 commits July 1, 2019 12:21
According to the specification, the id must always be a string when present.

See: https://jsonapi.org/format/#document-resource-object-identification
This 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.
@JaZo JaZo force-pushed the feature/magic-methods-for-id branch from 4bca753 to 2dd8d60 Compare July 1, 2019 10:21
@JaZo JaZo merged commit 695cd08 into master Jul 1, 2019
@JaZo JaZo deleted the feature/magic-methods-for-id branch July 1, 2019 10:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants