Laravel Eloquent: Return Array key as the fields ID

Question

When I execute a query via Laravel's Eloquent ORM, I want to get the row ID as the Array result key, this will make things easier when I want to check something based on an ID (using array_key_exists) or do some look ups (if I need a specific entry from the result array)

Is there any way I can tell Eloquent to set the key to the fields ID? see image http://oi60.tinypic.com/kc02a8.jpg

Thought about it, but I figured there should be a way to do it through eloquent... :-/ — Broshi, Nov 11 '14 at 14:37
I have to agree you would have to do it yourself. Alternatively you could use ->find($id) on the collection to find a model by id... — lukasgeiter, Nov 11 '14 at 15:35
You have plenty of methods: laravel.com/api/4.2/Illuminate/Support/Collection.html & laravel.com/api/4.2/Illuminate/Database/Eloquent/… so you shouldn't need to do it. Eloquent doesn't provide such thing. — Jarek Tkaczyk, Nov 12 '14 at 12:15

score 53 · Accepted Answer

You can use the keyBy method:

$roles = Role::all()->keyBy('name');

If you're not using Eloquent, you can create a collection on your own:

$roles = collect(DB::table('roles')->get())->keyBy('name');

If you're using Laravel 5.3+, the query builder now actually returns a collection, so there's no need to manually wrap it in a collection again:

$roles = DB::table('roles')->get()->keyBy('name');

I haven't had a chance to test out 4.2 yet but it will be in my next project. This looks like a very simple solution and I'm glad to see this was implemented. — eComEvo, Jun 30 '14 at 11:56
Note: This still uses foreach loop inside, so for performance it won't make a big difference, it'll only be more Laravel way. — Arda, Dec 4 '14 at 12:11
In Laravel 5.1 in second case it doesn't work, laravel says all() method is not defined. I used get() instead — Victor, Dec 1 '15 at 12:12
In 5.4, if you're using keyBy with toArray(), you need to call get(), keyBy() and then toArray(). Worked like a charm! — cbloss793, Apr 12 at 22:39

score 5 · Answer 2

You may try something like this:

$roles = array();
array_map(function($item) use (&$roles) {
    $roles[$item->id] = (Array)$item; // object to array
}, DB::table('roles')->get());

If you want to get an Object instead of an Array as value then just remove the (Array).

Alternative: Using Eloquent model (Instead of DB::table):

$roles = array();
array_map(function($item) use (&$roles) {
    $roles[$item['id']] = $item;
}, Role::all()->toArray());

Another Alternative: Using Collection::map() method:

$roles = array();
Role::all()->map(function($item) use(&$roles) {
    $roles[$item->id] = $item->toArray();
});

Was hoping there was a built-in method I was just missing in the docs but this will do. Cleaner than the foreach loop I was originally using. :) — eComEvo, Jun 10 '14 at 1:19

score 1 · Answer 3

If you need a key/value array, since Laravel 5.1 you can use pluck. This way you can indicate which attributes you want to use as a key and as a value.

$plucked = MyModel::all()->pluck('MyNameAttribute', 'MyIDAttribute');

return $plucked->all();

You will get an array as follow:

array:3 [▼
   1 => "My MyNameAttribute value"
   2 => "Lalalala"
   3 => "Oh!"
]

score 30 · Answer 4

You can simply do

    Model::all()->keyBy('category_id');

Cheers :)

score 25 · Answer 5

Since you have an Eloquent Collection (a child class of the generic Collection class) you can use the getDictionary method. $collection->getDictionary() will give you an array of your Category objects keyed by their primary keys.

If you wanted another Collection rather than a native PHP array, you could instead use $collection->keyBy($property). It looks like your primary key is category_id, so $collection->keyBy('category_id'). You can use that method to key by any arbitrary property, including any get mutators you may have written.

While getDictionary is unique to the Eloquent Collection extension, keyBy is available to all Laravel Collection objects. See the Laravel 4.2 API docs or Laravel 5.0 API docs.

score 5 · Answer 6

You have a Support\Collection/Database\Eloquent\Collection you can use the method lists('id') to return an array of the id of each of the models within the collection.

Then use array_combine to map the keys to the models. The result of which will be an array with the id mapped to their corresponding model.

score 0 · Answer 7

If you need id as the key, then rely on the Collection:

$collection = Model::all();

$collection->getDictionary();

// returns:
array(
  1 => object(Model) ( ... ),
  2 => object(Model) ( ... ),
  ...
  idN => object(Model) ( ... )
);

Otherwise, nice or not, you can do this:

$keys = $collection->lists('columnName');

$arrayOfModels = array_combine($keys, $collection->getDictionary);

You are here

laravel to array id as key toarray 以模型的 id 为键有大用

Eloquent column list by key with array as values?

3 Answers 正确答案

来自 https://stackoverflow.com/questions/24130507/eloquent-column-list-by-key-with-array-as-values

Laravel Eloquent: Return Array key as the fields ID

4 Answers 正确答案

来自 https://stackoverflow.com/questions/26865877/laravel-eloquent-return-array-key-as-the-fields-id

友情链接

up vote30down vote	You can simply do `Model::all()->keyBy('category_id');` Cheers :)
	add a comment

搜索表单

用户登录

You are here

laravel to array id as key toarray 以 模型的 id 为键 有大用

Eloquent column list by key with array as values?

3 Answers 正确答案

来自 https://stackoverflow.com/questions/24130507/eloquent-column-list-by-key-with-array-as-values

Laravel Eloquent: Return Array key as the fields ID

4 Answers 正确答案

来自 https://stackoverflow.com/questions/26865877/laravel-eloquent-return-array-key-as-the-fields-id

友情链接

laravel to array id as key toarray 以模型的 id 为键有大用