Method to forget nested keys in collections #40749

aschmelyun · 2022-02-02T07:05:39Z

aschmelyun
Feb 2, 2022

Hi all! Just wanted to see if this would be a desired addition. For collections, there's the forget() method that removes a specific key from a collection:

$collection = collect(['name' => 'taylor', 'framework' => 'laravel']);

$collection->forget('name');

// ['framework' => 'laravel']

However, if there's a collection with nested elements, forget needs some kind of traversal alongside of it. Instead, I was proposing adding a new collection method to more easily handle this:

$collection = collect([
    [
        'name' => 'taylor',
        'framework' => 'laravel'
    ],
    [
        'name' => 'andrew',
        'framework' => 'vue'
    ]
]);

$collection->forgetNested('name');

// [['framework' => 'laravel'],['framework' => 'vue']]

ousid · 2022-02-03T00:34:07Z

ousid
Feb 3, 2022

Hey, @aschmelyun

You can achieve the same result with the following:

$collection = collect([
    [
        'name' => 'taylor',
        'framework' => 'laravel'
    ],
    [
        'name' => 'andrew',
        'framework' => 'vue'
    ]
]);

$newCollection = [];

$collection->each(function ($element) use (&$newCollection) {
    unset($element['name']);
    $newCollection[] = $element;
});

// [['framework' => 'laravel'],['framework' => 'vue']]

But, I think it's a lot complicated than $collection->forgetNested('name')

Maybe @taylorotwell has another opinion?

1 reply

henzeb Jul 5, 2022

you could use $collection->map() instead. https://laravel.com/docs/9.x/collections#method-map

Stevemoretz · 2022-04-23T08:30:09Z

Stevemoretz
Apr 23, 2022

This is a great idea!
I was trying asterisks all over the place not knowing this wasn't even supported.
Obviously we can do it ourselves but it's just a great method to have.

1 reply

shaedrich Sep 21, 2023

Most methods that accept key names respect dot-notation. The list of those that don’t is short: forget, get, has, only, prepend, put. Some other methods only accept callbacks, such as map.

Any method that accepts the same parameters as where($key, $operator, $value) will also respect dot-notation.

Only pluck and groupBy use the array-wildcard * correctly. The others will give wrong results.
— https://www.dankuck.com/2019/09/06/laravel-collection-dot-notation.html

Yeah, it's quite disappointing that Laravel's data, array and collection helpers are this inconsistent in that respect (especially that data_get() supports asterisks while Arr::get() does not).

delhiarpitpatel · 2022-04-29T16:33:16Z

delhiarpitpatel
Apr 29, 2022

This is a great idea!

0 replies

simonbuehler · 2022-07-05T14:49:50Z

simonbuehler
Jul 5, 2022

one thing that i'm missing in laravel is the power of using something like a Hashpath Syntax from cakephp in collections, this is a real power feature not available in laravel and would allow to extract data from nested API responses like twitter into a handy collection.

0 replies

DudeMason · 2023-02-23T17:54:36Z

DudeMason
Feb 23, 2023

This would be awesome. Also allowing it to remove all items with that key, as far as the nest goes! Not just the first or second level.

1 reply

DudeMason Feb 23, 2023

I found this thread because I had an instance today where it would have been nice to have this!

Aug	SEP	Oct
	25
2022	2023	2024

Method to forget nested keys in collections #40749

Replies: 5 comments · 3 replies

Insert Link

Replies: 5 comments 3 replies