[Feature] Allow snake case relation names #326
Merged
Conversation
This file contains hidden or 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
Although developers should follow the PSR1 standard of camel casing method names, there are some developers who follow the Eloquent attribute standard of snake casing attributes when defining relationships. This commit allows an adapter to have its relation method name in exactly the same format as the JSON API field name. I.e. a field name of `user_history` and a relation method called `user_history`. Otherwise it falls back to the PSR1 standard and expects the method name to be the camel case version of the field name. See #315 for discussion.
Adds a property on the includes models trait so that camel casing of include path segments can be disabled. Note that the default behaviour will remaing to camel case these as PSR1 says that method names on classes must be camel case. See #315
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.
Allow developers to use the exact JSON API field name as the relationship method name on their
adapters, plus for default conversion of names in include paths. Although we recommend following
the PSR1 standard of using camel case for method names, this does allow a developer to use snake
case field names with snake case method names.
Closes #315