[8.x] Add the ability to transform paginator items #34657
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.
This PR adds the ability to transform paginator items via a new
through()
method, which returns an instance of thePaginator
, and not the underlyingCollection
.Here's an example use case:
This is needed since it's very common to want to map the data prior to the paginator being JSON encoded. However, right now there is no way to do that, since calling
map()
ortransform()
on the paginator object forwards calls to the underlying collection, which returns an instance of theCollection
, not thePaginator
.Meaning, if you call
$paginator->transform()
, you'll only get the data back, and not the paginatortoArray()
structure (data
,links
,current_page
,total
, etc).We could also call this
transformItems()
, but I thinkthrough()
is more expressive.