Laravel change pagination data

Question

My Laravel pagination output is like laravel pagination used to be, but I need to change the data array for each object. My output is:

As you can see, the data object has 2 items, which I need to change.

My code is:

$items = $this->items()
        ->where('position', '=', null)
        ->paginate(15);

Which returns the user items with pivot table, but I don't like the way the pivot table is shown in the JSON, so I decided to change the items and organize each item with the pivot before the item.

For this purpose, I tried to use foreach

foreach ($items->data as $item)
        {

        }

which giving my an error, for a reason I don't know:

Undefined property: Illuminate\Pagination\LengthAwarePaginator::$data"
status_code: 500

Any help?

A modern approach to this would be to use resources: https://laravel.com/docs/master/eloquent-resources — Adrian Lynch, Nov 12 '20 at 13:42

score 141 · Answer 1 · edited Jul 02 '20 at 08:16

141

The paginator's items is a collection. You can grab it and transform the data like so:

$paginator = $this->items()->where('position', '=', null)->paginate(15);
$paginator->getCollection()->transform(function ($value) {
    // Your code here
    return $value;
});

If you are familiar with tap helper here is the snippet that does exact same.

$paginator = tap($this->items()->where('position', '=', null)->paginate(15),function($paginatedInstance){
    return $paginatedInstance->getCollection()->transform(function ($value) {
        return $value;
    });
});

We can't chain method getCollection to paginator instance because AbstractPaginator will return paginator's underlying collection. so the paginator instance will be transformed to Collection. So fix that we can use tap helper.

edited Jul 02 '20 at 08:16

ManojKiran A

5,896
4
30
43

answered Sep 06 '16 at 07:24

Murwa

2,238
1
20
21

3

thanks, bro! and don't forget to return the modified data at the bottom. – Maduka Jayalath Mar 24 '18 at 07:14
7

You loose pagination data in this way – realtebo Oct 24 '19 at 08:34
1

@realtebo. Works fine in Lara 8 – ymakux Dec 25 '20 at 22:39
@realtebo Just return $paginator which contains the pagination data. – user3563059 Sep 02 '22 at 09:32

score 52 · Answer 2 · edited Jan 16 '20 at 13:47

52

If you'd like to keep items paginated:

        $itemsPaginated = $this->items()
             ->paginate(15);

        $itemsTransformed = $itemsPaginated
            ->getCollection()
            ->map(function($item) {
                return [
                    'id' => $item->id,
                ];
        })->toArray();

        $itemsTransformedAndPaginated = new \Illuminate\Pagination\LengthAwarePaginator(
            $itemsTransformed,
            $itemsPaginated->total(),
            $itemsPaginated->perPage(),
            $itemsPaginated->currentPage(), [
                'path' => \Request::url(),
                'query' => [
                    'page' => $itemsPaginated->currentPage()
                ]
            ]
        );

edited Jan 16 '20 at 13:47

Akash Kumar Verma

3,185
2
16
32

answered Mar 06 '18 at 14:44

hellovoid

611
6
6

2

Thanks so much for this, I think this should be the accepted answer. Mainly because pagination functionality will continue to work in your views and you can still call functions such as "appends" and "links" in your blade files. These functions won't be available if you are getting a Collection passed to your blade views. – Carlton Nov 27 '18 at 11:36
@hellovoid , Great Answer , You have saved my day :) – Saurabh Mistry Mar 05 '19 at 20:19
Best answer ever! – realtebo Jul 31 '19 at 13:59
I suggest to remove `->toArray()` after transormation, to keep unaltered the object kind of the items. I explain: the paginator has a Collection as 'items'; if your use `toArray()`, the new Paginator works, but in the view you will not be able to access items attributes using object notation – realtebo Oct 24 '19 at 08:45
This is the best answer. – graphicmist May 06 '21 at 07:50
You should use `'query' => \Request::query()` – Luke Vincent Aug 02 '21 at 15:41
I'm using `with('countries')`, with the result `'country' => [ 'country_id => 10, 'countryname' => 'Australia']`, how to get that `countryname` in map? – Fahmi Oct 04 '21 at 06:35
This helped me because it taught me how to create a LengthAwarePaginator from scratch, useful for when creating highly customized cases such as when wanting the items to be groupedBy something - I want to keep the meta info in-tact, but only the items are grouped – jcsoriano Apr 02 '22 at 03:22
1

Laravel 8.9.0 has added the `through` method, which will keep the items paginated. `$itemsPaginated->through(function ($item) { return ['id' => $item->id ]; });` See my answer. – dragonfire Jun 03 '22 at 13:56

score 43 · Answer 3 · answered Jan 17 '20 at 15:10

43

There is a setCollection method for such purpose.

$items = Model::paginate(10);

$updatedItems = $items->getCollection();

// data manipulation
// ...

$items->setCollection($updateItems);

From the source code of /Illuminate/Pagination/AbstractPaginator.php

/**
* Set the paginator's underlying collection.
*
* @param  \Illuminate\Support\Collection  $collection
* @return $this
*/
public function setCollection(Collection $collection)
{
    $this->items = $collection;

    return $this;
}

Source

answered Jan 17 '20 at 15:10

Scofield

4,195
2
27
31

1

this does not update other vital properties like `total` and `lastPage`, so it breaks pagination. – user3803848 Aug 27 '20 at 11:22
4

@user3803848 yeah you only want to update the collection for those data based on the current pagination data. Why do you want to change the total and lastPage? – Syazany Oct 05 '21 at 07:16

score 4 · Answer 4 · answered Jun 02 '22 at 19:39

Laravel 8.9.0 has added the through method to AbstractPaginator.
It transforms each item in the slice of items using a callback, and keeps the items paginated.

$paginator = $this->items()->where('position', '=', null)->paginate(15);
$paginator->through(function ($value) {
    // Your code here
    return $value;
});

The source code:

/**
 * Transform each item in the slice of items using a callback.
 *
 * @param  callable  $callback
 * @return $this
 */
public function through(callable $callback)
{
    $this->items->transform($callback);

    return $this;
}

score 3 · Answer 5 · answered Jan 02 '20 at 07:41

I could make shorter way. This returns edited $array instead of simple $paginated. This example modify file names. This doc was useful for me.

    $paginated=$query->paginate(12);
    $array=$paginated->toArray();
    foreach ($array['data'] as $r=>$record) {
        $array['data'][$r]->gif=$array['data'][$r]->gif.".gif";
    }
    return $array;

score 3 · Answer 6 · answered Mar 11 '21 at 08:18

Sample Example :

    $franchiseData=[ 'id'=>1 ,'name'=>'PAnkaj'];
    $models = $bookingsQuery->paginate(10);
    $models->setCollection(collect($franchiseData));
    return  $models;

Note that $models->setCollection(collect($franchiseData)); you have to use collect() else you will get error.

score 2 · Answer 7 · answered Nov 29 '20 at 16:13

getCollection

is one way to get the items. Another way is to use this For ex- Assuming, user doesn't have name param and only have first_name and last_name

$userPaginatedData = User::paginate(15);
$users = $userPaginatedData->items();

foreach($users as $user) {
   $user->name = $user->first_name . ' ' . $user->last_name;
}


return $userPaginatedData;

Now in the data key, you would see that each user has name param with it.

score 1 · Answer 8 · answered Jul 10 '17 at 11:09

-Laravel 5.4

// example update column "photo" 
// from "/path/to/photo.png" 
// to "abc.com/path/to/photo.png"
foreach ($items as $item)
{
    $path = $item->photo;

  // Remove 
  $item->offsetUnset("photo");

  // Set
  $item->offsetSet("photo", url($path));
}

score 0 · Answer 9 · answered Sep 30 '21 at 10:36

0

Laravel AbstractPaginator has methods setCollection() and getCollection()

<?php

$itemsPaginated = $this->items()->paginate(15);
$itemsPaginated->setCollection(
    $itemsPaginated->getCollection()->transform(function ($item) {
       // Your code here
       return $item;
    })
)

answered Sep 30 '21 at 10:36

Kirill Nizhnikov

1

I use filter() instead of transform, and it works: getCollection()->filter(function ($item) { // Your code here return $item; }) – Noname Aug 04 '22 at 07:14

score 0 · Answer 10 · answered Mar 25 '22 at 14:48

This is your paginated items...

$items = $this->items()
        ->where('position', '=', null)
        ->paginate(15);

I am using Laravel 8, can simply use each

$items->each(function ($item) {
 // your code here
 $item->custom_data = calcSomeData(); // sample
});

It does the same as this...

$items->getCollection()->transform(function ($item) {
 // your code here
 $item->custom_data = calcSomeData(); // sample
});

score -1 · Answer 11 · edited Feb 10 '20 at 10:24

-1

<?php 

$itemsPaginated = $this->items()->paginate(15);

$itemsPaginated = json_encode($itemsPaginated);

foreach ($itemsPaginated->data as $key => $item) {
    $results->data[$key]; //Modify
}

$itemsPaginated = json_encode($results);

edited Feb 10 '20 at 10:24

dipenparmar12

3,042
1
29
39

answered Jan 30 '20 at 21:39

Christian Ndukwe

9

3

Please don't post only code as an answer, but include an explanation what your code does and how it solves the problem of the question. Answers with an explanation are generally of higher quality, and are more likely to attract upvotes. – Mark Rotteveel Feb 10 '20 at 11:01
This will make loose all the information about pagination, eg: current_page, total pages... – Angus Simons Mar 20 '20 at 16:39

score -11 · Answer 12 · answered May 10 '16 at 11:27

-11

you have to use below code in your blade

{!! $items->render() !!}

answered May 10 '16 at 11:27

Veerendra Borra

1,286
14
24

score -11 · Answer 13 · edited Nov 26 '18 at 13:31

-11

Ignore the pagination in laravel and hit the normal data

foreach ($items as $item)
{

}

edited Nov 26 '18 at 13:31

Taha Paksu

15,371
2
44
78

answered Jul 27 '18 at 20:36

hamedkke

47
1
3

Laravel change pagination data

13 Answers13

Linked