Laravel change every model in collection

Question

I have a collection of Items. Now, before I am sending it though my api, I want to change a value of the model (but I don't want to update my model in the database).

Now I want to loop though my collection and return it as json, but I am getting invalid Payload.

Here is the code I perform:

$trainees = Trainee::select();
        if(!$request->user()->hasPermission('read-trainees')) {
            $trainees->where('status', 1)->where('visible', 1);
        } else {
            $trainees->with(array('user'=>function($query){
                $query->select('id','firstname', 'lastname');
            }));
            $trainees->select('user_id');
        }
        $trainees->select('interested_jobs', 'graduation');
        $trainees = $trainees->get();
        return $trainees
            ->map(function ($item) {
                $item->id = encrypt($item->id);
                return $item;
            })
            ->toJson();

And the problem is only in the json conversion? The value is changed and the `$trainees` is the array you want? — pr1nc3, Nov 14 '18 at 16:08
I dont know if the collection is getting updated. Without the code everything works fine, but with this code it doenst work — Patrick Schocke, Nov 14 '18 at 16:10
That with decrypt was stupid from me. But now I get `call do undefined function toJson()` — Patrick Schocke, Nov 14 '18 at 16:13
@KuebelElch15 when you do `Trainee::each(...)` doens't save the collection, just iterates over every item. Check [this](https://stackoverflow.com/a/18597163/7117697) — Kenny Horna, Nov 14 '18 at 16:31

Kenny Horna · Answer 1 · 2021-02-04T01:50:36.467

You can achieve this in several ways.

Every Eloquent collection extends the Collection class, that let you use helpful methods like map() or each():

// get your collection
$trainees = Trainee::all();

// customize them
$trainees->each(function ($trainee) {
  $trainee->id = encrypt($item->id);
});

return $trainees;

PS: By default, when returning an array/collection to an API Laravel will return it as JSON.

The second approach, more granular and recommended in my opinion, is to use API Resources. From the documentation:

When building an API, you may need a transformation layer that sits between your Eloquent models and the JSON responses that are actually returned to your application's users. Laravel's resource classes allow you to expressively and easily transform your models and model collections into JSON.

So, you'll need to:

1. Generate your API Resource

php artisan make:resource TraineeResource

2. Customize it

App\Http\Resources\TraineeResource.php

<?php

namespace App\Http\Resources;

use Illuminate\Http\Resources\Json\JsonResource;

class TraineeResource extends JsonResource
{
    /**
     * Transform the resource into an array.
     *
     * @param  \Illuminate\Http\Request  $request
     * @return array
     */
    public function toArray($request)
    {
        return [
            'id' => encrypt($this->id),
            // ...
        ];
    }
}

3. Apply it

In your controller:

App/Http/Controllers/MyCoolController.php

use App\Http\Resources\TraineeResource;

public function aCoolMethod(Request $request)
{
    // get your collection
    $trainees = Trainee::all();

    // return it
    return TraineeResource::collection($trainees);
}

score 1 · Answer 2 · answered Nov 14 '18 at 16:10

1

You can use the map function to change the data for each item in a collection.

return $trainees
    ->map(function ($item) {
        $item->id = decrypt($item->id);
        return $item;
    })
    ->toJson();

answered Nov 14 '18 at 16:10

Jerodev

32,252
11
87
108

This produces a `Call to undefined method Illuminate\Database\Eloquent\Builder::map()` – Patrick Schocke Nov 14 '18 at 16:13
It seems the query is not yet executed. Add `->get()` before the `->map` function. – Jerodev Nov 14 '18 at 16:15
You need to assign the output of your `get()` function. `$trainees = $trainees->get();` – Jerodev Nov 14 '18 at 16:19
But the Id is not getting encrpyted. It is stilly an integer – Patrick Schocke Nov 14 '18 at 16:23
@KuebelElch15 because you are decrypting instead of encrypting. Try do this instead: `encrypt($item->id);` – Kenny Horna Nov 14 '18 at 16:26
Yes I've found that out too. But that doesn't affect it. Look at my updated question. Thats my full logic – Patrick Schocke Nov 14 '18 at 16:28

Laravel change every model in collection

2 Answers2

1. Generate your API Resource

2. Customize it

3. Apply it

Linked