Laravel : Customize Pagination on API Resource Collection

Laravel from 5.5 / 5.6 has been tested with this solution!

You want to wrap your model collection into a resource collection but as you might using the Vue-Pagination which need to be outwrapping the meta and links key.

So, you want something as expected output above related to pagination keys.

In short, here is the way to do so as searching on the net, it doesn’t have clear explanation of what/why we do this:

We need to prepare the output pagination key as unwrapping output by each of expected key in API Resource’s array return statement as

'current_page' => $this->currentPage(),
'total' => $this->total(),
'from' => $fromRecord,
'to' => $this->count(), // record counts of current page
'per_page' => $this->perPage(),
'last_page' => $this->lastPage(),
'path' => $pathUrl,
'first_page_url' => $this->url(1),
'last_page_url' => $this->url($this->lastPage()),
'next_page_url' => $this->nextPageUrl(),
'prev_page_url' => $this->previousPageUrl(),

Where can we find/know those pagination methods? In Laravel, it’s using the method of Paginator Instance Methods, that most of methods can be used and for my case, I handle ‘$fromRecord‘ and ‘$pathUrl‘ myself (as I don’t know where to find them :)).

$fromRecord = ($this->currentPage() * $this->perPage() - $this->perPage()) + 1;

$pathUrl = str_replace_last('?page=1','', $this->url(1));

And to get rid of the “meta” & “links” key from the output, you need to put this to the collection resource:

public function withResponse($request, $response)
    $jsonResponse = json_decode($response->getContent(), true);

And finally, here is the final class

And it works as expected before, of course, thank for the init question over stackoverflow that give me an idea but it lacks of the full explanation, it took me sometimes to find out this, hope others got help by my post.

Leave a Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.