Add example of how to use custom collections #2015
Merged
Conversation
This file contains 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
|
Let me know if you need anything, I feel pretty versed at this point regarding collections and the inner workings of bookshelf. |
|
Thanks. Can you take a look at the changes here and see if the new documentation is good enough? |
fl0w
approved these changes
Sep 11, 2019
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.
Introduction
Document how to use a custom collection for the results of every call to
.fetchAll(). This includes calls to.fetchPage()and.related()as well, in case the relation is a one to many. Basically any time a new collection of the Model is created.Motivation
Collections are a bit hard to understand. This should help users that want to attach custom behavior to the collections associated with a certain model.
Currently a new anonymous collection is created when trying to compose the results of a
.fetchAll(), but it's sometimes useful to add extra behavior to this collection in a predictable way.Fixes #1466.