How to format (transform) laravel database paginated results?

Question

For example i have following code:

public function index()
{
    return
        Model::select(['id', 'some_field', ...// more some fields])
            ->with('data') // load relation
            ->paginate(20);
}

How do i format (transform/manipulate on) obtained data from database?

CakePHP ORM have useful method for this -https://book.cakephp.org/3.0/en/orm/query-builder.html#adding-calculated-fields && https://book.cakephp.org/3.0/en/orm/retrieving-data-and-resultsets.html#map-reduce

But i can't find any thing, that can help me to do a same things in Laravel. I can override "toArray" method in a model, but this will affect all application parts (not only an index action in my controller).

You can use `map` on the returned collection. – The Alpha Jul 07 '17 at 16:21 — The Alpha, Jul 07 '17 at 16:21

The Alpha · Accepted Answer · 2017-07-07T16:36:09.163

5

You can do same thing in Laravel, for example:

return Model::select(['id', 'some_field', ...// more some fields])
->with('data')
->paginate(20)
->map(function($item, $key) {
    // Some pseudo code
    $item->uid = uniqid();

    // Must return the $item
    return $item;
});

There are other ways doing similar things. You can do many more in Laravel. There is a transform method as well, among many.

edited Jul 07 '17 at 16:36

answered Jul 07 '17 at 16:30

The Alpha

143,660
29
287
307

4

Didn't work for me. When I used map it returned as a collection instead of a paginated resource – Salustiano Muniz Apr 24 '21 at 01:31
@SalustianoMuniz both `map` and `transform` will not work. You should use `through` which is supported in `AbstractPaginator`. – free2idol1 Jun 07 '23 at 11:05

score 3 · Answer 2 · answered Mar 24 '22 at 22:18

Here is my solution to only modify items without loosing the pagination data

public function index()
{
    $data_with_pagination = Model::select(['id', 'some_field', ...// more some fields])
        ->with('data') // load relation
        ->paginate(20);

    foreach ($data_with_pagination->items() as $item) {
        // modify your item here
        $item['uid'] = uniqid();
    }

    return $data_with_pagination;
}

score 2 · Answer 3 · answered Jul 07 '17 at 16:30

paginate() and get() will return a Collection giving you access to all the Collection methods.

You would be able to do:

public function index()
{
    return
        Model::select(['id', 'some_field', ...// more some fields])
            ->with('data') // load relation
            ->paginate(20)
            ->map(function($model) {
                $model->total_things = $model->one_thing + $model->other_thing;
                return $model;
            });
}

Using this will lose all the total counts and pagination URLs that it provides. — tmarois, Mar 08 '22 at 21:40

score 1 · Answer 4 · answered Mar 31 '22 at 05:06

Most of the answers already provided will work, but will return a collection instead of a paginated resource. The trick is to use the tap helper method before map'ping, to return the same object you modified.


   public function index()
    {
        return tap(Model::select(['id', 'some_field', ...// more some fields])
            ->with('data') // load relation
            ->paginate(20))
            ->map(function ($model) {
                $model->something_to_format = someFormattingHelper($model->something_to_format);
                return $model;
            });
    }

score 0 · Answer 5 · answered Sep 25 '22 at 11:12

I'm not sure if anyone still needs this. But I found another solution. It's not the best solution, but it gets the job done.

Both the transform() and map() functions are supported. Here's the link: https://jnbrnplbr.medium.com/transform-map-laravel-paginated-collection-b1ab912d7996

score 0 · Answer 6 · answered Jun 07 '23 at 11:03

map or transform will not work. You should use through which is supported in AbstractPaginator as specified in laravel official api.

Ex:

User::filter($request->all()
   ->with('applications')
   ->paginate(config('app.defaults.pageSize'))
   // through() will call transform() on the $items in the pagination object
   ->through(function ($user, $key) {
      $user['picture'] = $user->avatar;

      return $user;
   });

Ref: https://stackoverflow.com/a/65560742/11297747

How to format (transform) laravel database paginated results?

6 Answers6