Laravel 5.2 has pretty nice Helpers, I would like to use them to do following:
I have Eloquent Model Collection:
$lesson->users(); // returns Eloquent collection of 3 users
pluck() function would be useful, but it can get just single parameter. However I want to get output with two parameters, id and name, like this:
[
1=>['id'=>10,'name'=>'Michael Dook'],
2=>['id'=>16,'name'=>'Henry Babcock'],
3=>['id'=>19,'name'=>'Joe Nedd']
]
Is there any elegant solution for this?
I know this isn't the most recent question, but in case someone stumbles onto it from google later, see the Only Collection Method
$lesson->users()->only("id", "name")->toArray(); should be what you're after.
Laravel: 5.7
if method is returning relation
use get()
e.g
$lesson = Lesson::find(1);
$lesson->users()->get(['id', 'name']);
on collections
use only()
$user = collect(['id' => 1, 'name' => 'Foo', 'role' => 'A']);
$user->only(['id', 'name']);
multiple arrays
$users = collect([
['id' => 1, 'name' => 'Foo', 'role' => 'A'],
['id' => 2, 'name' => 'Bar', 'role' => 'B'];
]);
$result = $users->map(function($user){
return Arr::only($user, ['id', 'name']);
});
var_dump($result);
In case if anyone wants to "pluck" multiple attributes and key them (the example result is keyed by "name" field, 'value' is item itself - change it to get array of attributes you're interested in):
$settings = \App\Setting::all()->map(function ($setting) {
return ['key' => $setting->name, 'value' => $setting];
})->pluck('value', 'key')->toArray();
Try this:
$lesson->users()->select('id', 'name')->get()->toArray();
As stated in the question, $lesson->users() returns an "Eloquent collection of 3 users". This is not the same thing as if users() was a relationship on a Lesson model, which many answers have incorrectly assumed, in which case it would return a query builder.
Assuming the users in the collection are Eloquent models, since Laravel 5.5 you can simply do this:
$lesson->users()->map->only('id', 'name');
If the users are plain arrays, you can instead use:
$lesson->users()->map(fn ($user) => Arr::only($user, ['id', 'name']));
$result = $lesson->users()->map(function($item){
return array('id' => $item->id, 'name' => $item->name)
});
Should do the trick.
The pluck() helper function does take a second parameter. It will return an associative array then, where the second parameter defines the key. So you'll get a result of key => value pairs.
As you know that your entries will consist of id and name, maybe this could help:
$lesson->users->pluck('name', 'id')->toArray();
This will return:
[
10 => 'Michael Dook',
16 => 'Henry Babcock',
19 => 'Joe Nedd'
]
I'm not sure about Laravel 5.2, but this works in Laravel 5.5
If you have a collection of Models you can use:
$users->map->only('name', 'hobby');
// returns e.g.
// collect([
// new User(['name' => 'matt', 'hobby' => 'coding']),
// new User(['name' => 'tomo', 'hobby' => 'cooking']),
// ]);
This only works on Models because the only method is only available on Models, not on other items you might have in a Collection.
For a generic, more robust solution that works with Collections of mixed object types, arrays, etc., you can use the pluckMany macro I contributed to Spatie's laravel-collection-macros package:
$collection->pluckMany(['name', 'hobby']);
// returns e.g.
// collect([
// (object) ['name' => 'marco', 'hobby' => 'drinking'],
// (object) ['name' => 'belle', 'hobby' => 'cross-stitch'],
// ]);
For more details about pluckMany, see my blog post on How to pluck multiple items from a Laravel Collection
In Laravel 6.^
The collection method ->only() only returns the given ID's in the collection.
In the ->get() method you can specify which columns to return.
On a collection you can use the method ->keyBy('id') to set the key of the array.
To return the records with id as key and the array containing id and name use the following code:
$lesson->users()->get(['id', 'name'])->keyBy('id')->toArray()
